LocationService

Client

class LocationService.Client

A low-level client representing Amazon Location Service

Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing

client = session.create_client('location')

These are the available methods:

associate_tracker_consumer(**kwargs)

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.

You can associate up to five geofence collections to each tracker resource.

Note

Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.

See also: AWS API Documentation

Request Syntax

response = client.associate_tracker_consumer(
    ConsumerArn='string',
    TrackerName='string'
)
Parameters
  • ConsumerArn (string) --

    [REQUIRED]

    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.

    • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
  • TrackerName (string) --

    [REQUIRED]

    The name of the tracker resource to be associated with a geofence collection.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

batch_delete_device_position_history(**kwargs)

Deletes the position history of one or more devices from a tracker resource.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_device_position_history(
    DeviceIds=[
        'string',
    ],
    TrackerName='string'
)
Parameters
  • DeviceIds (list) --

    [REQUIRED]

    Devices whose position history you want to delete.

    • For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]
    • (string) --
  • TrackerName (string) --

    [REQUIRED]

    The name of the tracker resource to delete the device position history from.

Return type

dict

Returns

Response Syntax

{
    'Errors': [
        {
            'DeviceId': 'string',
            'Error': {
                'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
                'Message': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • Errors (list) --

      Contains error details for each device history that failed to delete.

      • (dict) --

        Contains the tracker resource details.

        • DeviceId (string) --

          The ID of the device for this position.

        • Error (dict) --

          Contains the batch request error details associated with the request.

          • Code (string) --

            The error code associated with the batch request error.

          • Message (string) --

            A message with the reason for the batch request error.

Exceptions

batch_delete_geofence(**kwargs)

Deletes a batch of geofences from a geofence collection.

Note

This operation deletes the resource permanently.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_geofence(
    CollectionName='string',
    GeofenceIds=[
        'string',
    ]
)
Parameters
  • CollectionName (string) --

    [REQUIRED]

    The geofence collection storing the geofences to be deleted.

  • GeofenceIds (list) --

    [REQUIRED]

    The batch of geofences to be deleted.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'Errors': [
        {
            'Error': {
                'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
                'Message': 'string'
            },
            'GeofenceId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Errors (list) --

      Contains error details for each geofence that failed to delete.

      • (dict) --

        Contains error details for each geofence that failed to delete from the geofence collection.

        • Error (dict) --

          Contains details associated to the batch error.

          • Code (string) --

            The error code associated with the batch request error.

          • Message (string) --

            A message with the reason for the batch request error.

        • GeofenceId (string) --

          The geofence associated with the error message.

Exceptions

batch_evaluate_geofences(**kwargs)

Evaluates device positions against the geofence geometries from a given geofence collection.

This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge:

  • ENTER if Amazon Location determines that the tracked device has entered a geofenced area.
  • EXIT if Amazon Location determines that the tracked device has exited a geofenced area.

Note

The last geofence that a device was observed within is tracked for 30 days after the most recent device position update.

See also: AWS API Documentation

Request Syntax

response = client.batch_evaluate_geofences(
    CollectionName='string',
    DevicePositionUpdates=[
        {
            'DeviceId': 'string',
            'Position': [
                123.0,
            ],
            'SampleTime': datetime(2015, 1, 1)
        },
    ]
)
Parameters
  • CollectionName (string) --

    [REQUIRED]

    The geofence collection used in evaluating the position of devices against its geofences.

  • DevicePositionUpdates (list) --

    [REQUIRED]

    Contains device details for each device to be evaluated against the given geofence collection.

    • (dict) --

      Contains the position update details for a device.

      • DeviceId (string) -- [REQUIRED]

        The device associated to the position update.

      • Position (list) -- [REQUIRED]

        The latest device position defined in WGS 84 format: [X or longitude, Y or latitude] .

        • (float) --
      • SampleTime (datetime) -- [REQUIRED]

        The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Return type

dict

Returns

Response Syntax

{
    'Errors': [
        {
            'DeviceId': 'string',
            'Error': {
                'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
                'Message': 'string'
            },
            'SampleTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • Errors (list) --

      Contains error details for each device that failed to evaluate its position against the given geofence collection.

      • (dict) --

        Contains error details for each device that failed to evaluate its position against the geofences in a given geofence collection.

        • DeviceId (string) --

          The device associated with the position evaluation error.

        • Error (dict) --

          Contains details associated to the batch error.

          • Code (string) --

            The error code associated with the batch request error.

          • Message (string) --

            A message with the reason for the batch request error.

        • SampleTime (datetime) --

          Specifies a timestamp for when the error occurred in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Exceptions

batch_get_device_position(**kwargs)

Lists the latest device positions for requested devices.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_device_position(
    DeviceIds=[
        'string',
    ],
    TrackerName='string'
)
Parameters
  • DeviceIds (list) --

    [REQUIRED]

    Devices whose position you want to retrieve.

    • For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2
    • (string) --
  • TrackerName (string) --

    [REQUIRED]

    The tracker resource retrieving the device position.

Return type

dict

Returns

Response Syntax

{
    'DevicePositions': [
        {
            'DeviceId': 'string',
            'Position': [
                123.0,
            ],
            'ReceivedTime': datetime(2015, 1, 1),
            'SampleTime': datetime(2015, 1, 1)
        },
    ],
    'Errors': [
        {
            'DeviceId': 'string',
            'Error': {
                'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
                'Message': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • DevicePositions (list) --

      Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled.

      • (dict) --

        Contains the device position details.

        • DeviceId (string) --

          The device whose position you retrieved.

        • Position (list) --

          The last known device position.

          • (float) --
        • ReceivedTime (datetime) --

          The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

        • SampleTime (datetime) --

          The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • Errors (list) --

      Contains error details for each device that failed to send its position to the tracker resource.

      • (dict) --

        Contains error details for each device that didn't return a position.

        • DeviceId (string) --

          The ID of the device that didn't return a position.

        • Error (dict) --

          Contains details related to the error code.

          • Code (string) --

            The error code associated with the batch request error.

          • Message (string) --

            A message with the reason for the batch request error.

Exceptions

batch_put_geofence(**kwargs)

A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.

See also: AWS API Documentation

Request Syntax

response = client.batch_put_geofence(
    CollectionName='string',
    Entries=[
        {
            'GeofenceId': 'string',
            'Geometry': {
                'Polygon': [
                    [
                        [
                            123.0,
                        ],
                    ],
                ]
            }
        },
    ]
)
Parameters
  • CollectionName (string) --

    [REQUIRED]

    The geofence collection storing the geofences.

  • Entries (list) --

    [REQUIRED]

    The batch of geofences to be stored in a geofence collection.

    • (dict) --

      Contains geofence geometry details.

      • GeofenceId (string) -- [REQUIRED]

        The identifier for the geofence to be stored in a given geofence collection.

      • Geometry (dict) -- [REQUIRED]

        Contains the polygon details to specify the position of the geofence.

        Note

        Each geofence polygon can have a maximum of 1,000 vertices.

        • Polygon (list) --

          An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude] .

          The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.

          • (list) --
            • (list) --
              • (float) --
Return type

dict

Returns

Response Syntax

{
    'Errors': [
        {
            'Error': {
                'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
                'Message': 'string'
            },
            'GeofenceId': 'string'
        },
    ],
    'Successes': [
        {
            'CreateTime': datetime(2015, 1, 1),
            'GeofenceId': 'string',
            'UpdateTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • Errors (list) --

      Contains additional error details for each geofence that failed to be stored in a geofence collection.

      • (dict) --

        Contains error details for each geofence that failed to be stored in a given geofence collection.

        • Error (dict) --

          Contains details associated to the batch error.

          • Code (string) --

            The error code associated with the batch request error.

          • Message (string) --

            A message with the reason for the batch request error.

        • GeofenceId (string) --

          The geofence associated with the error message.

    • Successes (list) --

      Contains each geofence that was successfully stored in a geofence collection.

      • (dict) --

        Contains a summary of each geofence that was successfully stored in a given geofence collection.

        • CreateTime (datetime) --

          The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

        • GeofenceId (string) --

          The geofence successfully stored in a geofence collection.

        • UpdateTime (datetime) --

          The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Exceptions

batch_update_device_position(**kwargs)

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

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 30 days before it's deleted.

See also: AWS API Documentation

Request Syntax

response = client.batch_update_device_position(
    TrackerName='string',
    Updates=[
        {
            'DeviceId': 'string',
            'Position': [
                123.0,
            ],
            'SampleTime': datetime(2015, 1, 1)
        },
    ]
)
Parameters
  • TrackerName (string) --

    [REQUIRED]

    The name of the tracker resource to update.

  • Updates (list) --

    [REQUIRED]

    Contains the position update details for each device.

    • (dict) --

      Contains the position update details for a device.

      • DeviceId (string) -- [REQUIRED]

        The device associated to the position update.

      • Position (list) -- [REQUIRED]

        The latest device position defined in WGS 84 format: [X or longitude, Y or latitude] .

        • (float) --
      • SampleTime (datetime) -- [REQUIRED]

        The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Return type

dict

Returns

Response Syntax

{
    'Errors': [
        {
            'DeviceId': 'string',
            'Error': {
                'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
                'Message': 'string'
            },
            'SampleTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • Errors (list) --

      Contains error details for each device that failed to update its position.

      • (dict) --

        Contains error details for each device that failed to update its position.

        • DeviceId (string) --

          The device associated with the failed location update.

        • Error (dict) --

          Contains details related to the error code such as the error code and error message.

          • Code (string) --

            The error code associated with the batch request error.

          • Message (string) --

            A message with the reason for the batch request error.

        • SampleTime (datetime) --

          The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

Exceptions

calculate_route(**kwargs)
Calculates a route given the following required parameters: DeparturePostiton and DestinationPosition . Requires that you first create a route calculator resource

By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route.

Additional options include:

  • Specifying a departure time using either DepartureTime or DepartureNow . This calculates a route based on predictive traffic data at the given time.

Note

You can't specify both DepartureTime and DepartureNow in a single request. Specifying both parameters returns an error message.

  • Specifying a travel mode using TravelMode. This lets you specify an additional route preference such as CarModeOptions if traveling by Car , or TruckModeOptions if traveling by Truck .

See also: AWS API Documentation

Request Syntax

response = client.calculate_route(
    CalculatorName='string',
    CarModeOptions={
        'AvoidFerries': True|False,
        'AvoidTolls': True|False
    },
    DepartNow=True|False,
    DeparturePosition=[
        123.0,
    ],
    DepartureTime=datetime(2015, 1, 1),
    DestinationPosition=[
        123.0,
    ],
    DistanceUnit='Kilometers'|'Miles',
    IncludeLegGeometry=True|False,
    TravelMode='Car'|'Truck'|'Walking',
    TruckModeOptions={
        'AvoidFerries': True|False,
        'AvoidTolls': True|False,
        'Dimensions': {
            'Height': 123.0,
            'Length': 123.0,
            'Unit': 'Meters'|'Feet',
            'Width': 123.0
        },
        'Weight': {
            'Total': 123.0,
            'Unit': 'Kilograms'|'Pounds'
        }
    },
    WaypointPositions=[
        [
            123.0,
        ],
    ]
)
Parameters
  • CalculatorName (string) --

    [REQUIRED]

    The name of the route calculator resource that you want to use to calculate a route.

  • CarModeOptions (dict) --

    Specifies route preferences when traveling by Car , such as avoiding routes that use ferries or tolls.

    Requirements: TravelMode must be specified as Car .

    • AvoidFerries (boolean) --

      Avoids ferries when calculating routes.

      Default Value: false

      Valid Values: false | true

    • AvoidTolls (boolean) --

      Avoids tolls when calculating routes.

      Default Value: false

      Valid Values: false | true

  • DepartNow (boolean) --

    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

  • DeparturePosition (list) --

    [REQUIRED]

    The start position for the route. Defined in WGS 84 format: [longitude, latitude] .

    • For example, [-123.115, 49.285]

    Note

    If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road .

    Valid Values: [-180 to 180,-90 to 90]

    • (float) --
  • DepartureTime (datetime) --

    Specifies the desired time of departure. Uses the given time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

    Note

    Setting a departure time in the past returns a 400 ValidationException error.

    • In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ . For example, 2020–07-2T12:15:20.000Z+01:00
  • DestinationPosition (list) --

    [REQUIRED]

    The finish position for the route. Defined in WGS 84 format: [longitude, latitude] .

    • For example, [-122.339, 47.615]

    Note

    If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road .

    Valid Values: [-180 to 180,-90 to 90]

    • (float) --
  • DistanceUnit (string) --

    Set the unit system to specify the distance.

    Default Value: Kilometers

  • IncludeLegGeometry (boolean) --

    Set to include the geometry details in the result for each path between a pair of positions.

    Default Value: false

    Valid Values: false | true

  • TravelMode (string) --

    Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

    The TravelMode you specify determines how you specify route preferences:

    • If traveling by Car use the CarModeOptions parameter.
    • If traveling by Truck use the TruckModeOptions parameter.

    Default Value: Car

  • TruckModeOptions (dict) --

    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 .

    • AvoidFerries (boolean) --

      Avoids ferries when calculating routes.

      Default Value: false

      Valid Values: false | true

    • AvoidTolls (boolean) --

      Avoids ferries when calculating routes.

      Default Value: false

      Valid Values: false | true

    • Dimensions (dict) --

      Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.

      • Height (float) --

        The height of the truck.

        • For example, 4.5 .
      • Length (float) --

        The length of the truck.

        • For example, 15.5 .
      • Unit (string) --

        Specifies the unit of measurement for the truck dimensions.

        Default Value: Meters

      • Width (float) --

        The width of the truck.

        • For example, 4.5 .
    • Weight (dict) --

      Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.

      • Total (float) --

        The total weight of the truck.

        • For example, 3500 .
      • Unit (string) --

        The unit of measurement to use for the truck weight.

        Default Value: Kilograms

  • WaypointPositions (list) --

    Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

    • 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

    If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road .

    Specifying more than 23 waypoints returns a 400 ValidationException error.

    Valid Values: [-180 to 180,-90 to 90]

    • (list) --
      • (float) --
Return type

dict

Returns

Response Syntax

{
    'Legs': [
        {
            'Distance': 123.0,
            'DurationSeconds': 123.0,
            'EndPosition': [
                123.0,
            ],
            'Geometry': {
                'LineString': [
                    [
                        123.0,
                    ],
                ]
            },
            'StartPosition': [
                123.0,
            ],
            'Steps': [
                {
                    'Distance': 123.0,
                    'DurationSeconds': 123.0,
                    'EndPosition': [
                        123.0,
                    ],
                    'GeometryOffset': 123,
                    'StartPosition': [
                        123.0,
                    ]
                },
            ]
        },
    ],
    'Summary': {
        'DataSource': 'string',
        'Distance': 123.0,
        'DistanceUnit': 'Kilometers'|'Miles',
        'DurationSeconds': 123.0,
        'RouteBBox': [
            123.0,
        ]
    }
}

Response Structure

  • (dict) --

    Returns the result of the route calculation. Metadata includes legs and route summary.

    • Legs (list) --

      Contains details about each path between a pair of positions included along a route such as: StartPosition , EndPosition , Distance , DurationSeconds , Geometry , and Steps . The number of legs returned corresponds to one fewer than the total number of positions in the request.

      For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road :

      • The StartPosition is the departure position.
      • The EndPosition is the destination position.

      A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

      • Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
      • Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.
      • (dict) --

        Contains the calculated route's details for each path between a pair of positions. The number of legs returned corresponds to one fewer than the total number of positions in the request.

        For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road :

        • The StartPosition is the departure position.
        • The EndPosition is the destination position.

        A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

        • Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
        • Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.
        • Distance (float) --

          The distance between the leg's StartPosition and EndPosition along a calculated route.

          • The default measurement is Kilometers unless the request specifies a DistanceUnit of Miles .
        • DurationSeconds (float) --

          The estimated travel time between the leg's StartPosition and EndPosition . The travel mode and departure time that you specify in the request determines the calculated time.

        • EndPosition (list) --

          The terminating position of the leg. Follows the format [longitude,latitude] .

          Note

          If the EndPosition isn't located on a road, it's snapped to a nearby road .

          • (float) --
        • Geometry (dict) --

          Contains the calculated route's path as a linestring geometry.

          • LineString (list) --

            An ordered list of positions used to plot a route on a map.

            The first position is closest to the start position for the leg, and the last position is the closest to the end position for the leg.

            • For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]
            • (list) --
              • (float) --
        • StartPosition (list) --

          The starting position of the leg. Follows the format [longitude,latitude] .

          Note

          If the StartPosition isn't located on a road, it's snapped to a nearby road .

          • (float) --
        • Steps (list) --

          Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.

          • (dict) --

            Represents an element of a leg within a route. A step contains instructions for how to move to the next step in the leg.

            • Distance (float) --

              The travel distance between the step's StartPosition and EndPosition .

            • DurationSeconds (float) --

              The estimated travel time, in seconds, from the step's StartPosition to the EndPosition . . The travel mode and departure time that you specify in the request determines the calculated time.

            • EndPosition (list) --

              The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.

              • (float) --
            • GeometryOffset (integer) --

              Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For example, the index of the first step in a leg geometry is 0 .

              Included in the response for queries that set IncludeLegGeometry to True .

            • StartPosition (list) --

              The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg.

              • (float) --
    • Summary (dict) --

      Contains information about the whole route, such as: RouteBBox , DataSource , Distance , DistanceUnit , and DurationSeconds .

      • DataSource (string) --

        The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:

        • Esri
        • Here

        For more information about data providers, see Amazon Location Service data providers .

      • Distance (float) --

        The total distance covered by the route. The sum of the distance travelled between every stop on the route.

        Note

        The route distance can't be greater than 250 km. If the route exceeds 250 km, the response returns a 400 RoutesValidationException error.

      • DistanceUnit (string) --

        The unit of measurement for the distance.

      • DurationSeconds (float) --

        The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

      • RouteBBox (list) --

        Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y] .

        The first 2 bbox parameters describe the lower southwest corner:

        • The first bbox position is the X coordinate or longitude of the lower southwest corner.
        • The second bbox position is the Y coordinate or latitude of the lower southwest corner.

        The next 2 bbox parameters describe the upper northeast corner:

        • The third bbox position is the X coordinate, or longitude of the upper northeast corner.
        • The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.
        • (float) --

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_geofence_collection(**kwargs)

Creates a geofence collection, which manages and stores geofences.

See also: AWS API Documentation

Request Syntax

response = client.create_geofence_collection(
    CollectionName='string',
    Description='string',
    KmsKeyId='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    PricingPlanDataSource='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • CollectionName (string) --

    [REQUIRED]

    A custom name for the geofence collection.

    Requirements:

    • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique geofence collection name.
    • No spaces allowed. For example, ExampleGeofenceCollection .
  • Description (string) -- An optional description for the geofence collection.
  • KmsKeyId (string) -- A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.
  • PricingPlan (string) --

    [REQUIRED]

    Specifies the pricing plan for the geofence collection.

    For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

  • PricingPlanDataSource (string) --

    Specifies the data provider for the geofence collection.

    • Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

    For more information about Data Providers , and Pricing plans , see the Amazon Location Service product page.

    Note

    Amazon Location Service only uses PricingPlanDataSource to calculate billing for your geofence collection. Your data won't be shared with the data provider, and will remain in your AWS account or Region unless you move it.

    Valid Values: Esri | Here

  • Tags (dict) --

    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.

    Format: "key" : "value"

    Restrictions:

    • 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: + - = . _ : / @.
    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'CollectionArn': 'string',
    'CollectionName': 'string',
    'CreateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • CollectionArn (string) --

      The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.

      • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
    • CollectionName (string) --

      The name for the geofence collection.

    • CreateTime (datetime) --

      The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Exceptions

create_map(**kwargs)

Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.

See also: AWS API Documentation

Request Syntax

response = client.create_map(
    Configuration={
        'Style': 'string'
    },
    Description='string',
    MapName='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    Tags={
        'string': 'string'
    }
)
Parameters
  • Configuration (dict) --

    [REQUIRED]

    Specifies the map style selected from an available data provider.

    • Style (string) -- [REQUIRED]

      Specifies the map style selected from an available data provider. For additional information on each map style and to preview each map style, see Esri map styles and HERE map styles .

      Valid Esri styles:

      • VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content.
      • RasterEsriImagery – The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide.
      • VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content.
      • VectorEsriTopographic – The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.
      • VectorEsriStreets – The Esri World Streets map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.
      • VectorEsriNavigation – The Esri World Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.

      Valid HERE Technologies styles:

      • VectorHereBerlin – The HERE Berlin map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.

      Note

      When using HERE as your data provider, and selecting the Style VectorHereBerlin , you may not use HERE Technologies maps for Asset Management. See the AWS Service Terms for Amazon Location Service.

  • Description (string) -- An optional description for the map resource.
  • MapName (string) --

    [REQUIRED]

    The name for the map resource.

    Requirements:

    • Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique map resource name.
    • No spaces allowed. For example, ExampleMap .
  • PricingPlan (string) --

    [REQUIRED]

    Specifies the pricing plan for your map resource.

    For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

  • Tags (dict) --

    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.

    Format: "key" : "value"

    Restrictions:

    • 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: + - = . _ : / @.
    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'CreateTime': datetime(2015, 1, 1),
    'MapArn': 'string',
    'MapName': 'string'
}

Response Structure

  • (dict) --

    • CreateTime (datetime) --

      The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • MapArn (string) --

      The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.

      • Format example: arn:aws:geo:region:account-id:maps/ExampleMap
    • MapName (string) --

      The name of the map resource.

Exceptions

create_place_index(**kwargs)

Creates a place index resource in your AWS account, which supports functions with geospatial data sourced from your chosen data provider.

See also: AWS API Documentation

Request Syntax

response = client.create_place_index(
    DataSource='string',
    DataSourceConfiguration={
        'IntendedUse': 'SingleUse'|'Storage'
    },
    Description='string',
    IndexName='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    Tags={
        'string': 'string'
    }
)
Parameters
  • DataSource (string) --

    [REQUIRED]

    Specifies the data provider of geospatial data.

    Note

    This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

    Valid values include:

    Warning

    Place index resources using HERE Technologies as a data provider can't store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

    For additional information , see Data providers on the Amazon Location Service Developer Guide .

  • DataSourceConfiguration (dict) --

    Specifies the data storage option requesting Places.

    • IntendedUse (string) --

      Specifies how the results of an operation will be stored by the caller.

      Valid values include:

      • SingleUse specifies that the results won't be stored.
      • Storage specifies that the result can be cached or stored in a database.

      Default value: SingleUse

  • Description (string) -- The optional description for the place index resource.
  • IndexName (string) --

    [REQUIRED]

    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 .
  • PricingPlan (string) --

    [REQUIRED]

    Specifies the pricing plan for your place index resource.

    For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

  • Tags (dict) --

    Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

    Format: "key" : "value"

    Restrictions:

    • 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: + - = . _ : / @.
    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'CreateTime': datetime(2015, 1, 1),
    'IndexArn': 'string',
    'IndexName': 'string'
}

Response Structure

  • (dict) --

    • CreateTime (datetime) --

      The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • IndexArn (string) --

      The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.

      • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
    • IndexName (string) --

      The name for the place index resource.

Exceptions

create_route_calculator(**kwargs)

Creates a route calculator resource in your AWS account.

You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.

See also: AWS API Documentation

Request Syntax

response = client.create_route_calculator(
    CalculatorName='string',
    DataSource='string',
    Description='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    Tags={
        'string': 'string'
    }
)
Parameters
  • CalculatorName (string) --

    [REQUIRED]

    The name of the route calculator resource.

    Requirements:

    • Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
    • Must be a unique Route calculator resource name.
    • No spaces allowed. For example, ExampleRouteCalculator .
  • DataSource (string) --

    [REQUIRED]

    Specifies the data provider of traffic and road network data.

    Note

    This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

    Valid values include:

    For additional information , see Data providers on the Amazon Location Service Developer Guide .

  • Description (string) -- The optional description for the route calculator resource.
  • PricingPlan (string) --

    [REQUIRED]

    Specifies the pricing plan for your route calculator resource.

    For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .

  • Tags (dict) --

    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.

    • For example: { "tag1" : "value1" , "tag2" : "value2" }

    Format: "key" : "value"

    Restrictions:

    • 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: + - = . _ : / @.
    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'CalculatorArn': 'string',
    'CalculatorName': 'string',
    'CreateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • CalculatorArn (string) --

      The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS.

      • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
    • CalculatorName (string) --

      The name of the route calculator resource.

      • For example, ExampleRouteCalculator .
    • CreateTime (datetime) --

      The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

      • For example, 2020–07-2T12:15:20.000Z+01:00

Exceptions

create_tracker(**kwargs)

Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.

See also: AWS API Documentation

Request Syntax

response = client.create_tracker(
    Description='string',
    KmsKeyId='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    PricingPlanDataSource='string',
    Tags={
        'string': 'string'
    },
    TrackerName='string'
)
Parameters
  • Description (string) -- An optional description for the tracker resource.
  • KmsKeyId (string) -- A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.
  • PricingPlan (string) --

    [REQUIRED]

    Specifies the pricing plan for the tracker resource.

    For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

  • PricingPlanDataSource (string) --

    Specifies the data provider for the tracker resource.

    • Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

    For more information about Data Providers , and Pricing plans , see the Amazon Location Service product page.

    Note

    Amazon Location Service only uses PricingPlanDataSource to calculate billing for your tracker resource. Your data will not be shared with the data provider, and will remain in your AWS account or Region unless you move it.

    Valid Values: Esri | Here

  • Tags (dict) --

    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:

    • 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: + - = . _ : / @.
    • (string) --
      • (string) --
  • TrackerName (string) --

    [REQUIRED]

    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 type

dict

Returns

Response Syntax

{
    'CreateTime': datetime(2015, 1, 1),
    'TrackerArn': 'string',
    'TrackerName': 'string'
}

Response Structure

  • (dict) --

    • CreateTime (datetime) --

      The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • TrackerArn (string) --

      The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.

      • Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker
    • TrackerName (string) --

      The name of the tracker resource.

Exceptions

delete_geofence_collection(**kwargs)

Deletes a geofence collection from your AWS account.

Note

This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.

See also: AWS API Documentation

Request Syntax

response = client.delete_geofence_collection(
    CollectionName='string'
)
Parameters
CollectionName (string) --

[REQUIRED]

The name of the geofence collection to be deleted.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_map(**kwargs)

Deletes a map resource from your AWS account.

Note

This operation deletes the resource permanently. If the map is being used in an application, the map may not render.

See also: AWS API Documentation

Request Syntax

response = client.delete_map(
    MapName='string'
)
Parameters
MapName (string) --

[REQUIRED]

The name of the map resource to be deleted.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_place_index(**kwargs)

Deletes a place index resource from your AWS account.

Note

This operation deletes the resource permanently.

See also: AWS API Documentation

Request Syntax

response = client.delete_place_index(
    IndexName='string'
)
Parameters
IndexName (string) --

[REQUIRED]

The name of the place index resource to be deleted.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_route_calculator(**kwargs)

Deletes a route calculator resource from your AWS account.

Note

This operation deletes the resource permanently.

See also: AWS API Documentation

Request Syntax

response = client.delete_route_calculator(
    CalculatorName='string'
)
Parameters
CalculatorName (string) --

[REQUIRED]

The name of the route calculator resource to be deleted.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_tracker(**kwargs)

Deletes a tracker resource from your AWS account.

Note

This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications.

See also: AWS API Documentation

Request Syntax

response = client.delete_tracker(
    TrackerName='string'
)
Parameters
TrackerName (string) --

[REQUIRED]

The name of the tracker resource to be deleted.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

describe_geofence_collection(**kwargs)

Retrieves the geofence collection details.

See also: AWS API Documentation

Request Syntax

response = client.describe_geofence_collection(
    CollectionName='string'
)
Parameters
CollectionName (string) --

[REQUIRED]

The name of the geofence collection.

Return type
dict
Returns
Response Syntax
{
    'CollectionArn': 'string',
    'CollectionName': 'string',
    'CreateTime': datetime(2015, 1, 1),
    'Description': 'string',
    'KmsKeyId': 'string',
    'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    'PricingPlanDataSource': 'string',
    'Tags': {
        'string': 'string'
    },
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • CollectionArn (string) --

      The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.

      • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
    • CollectionName (string) --

      The name of the geofence collection.

    • CreateTime (datetime) --

      The timestamp for when the geofence resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

    • Description (string) --

      The optional description for the geofence collection.

    • KmsKeyId (string) --

      A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource

    • PricingPlan (string) --

      The pricing plan selected for the specified geofence collection.

      For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

    • PricingPlanDataSource (string) --

      The specified data provider for the geofence collection.

    • Tags (dict) --

      Displays the key, value pairs of tags associated with this resource.

      • (string) --
        • (string) --
    • UpdateTime (datetime) --

      The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Exceptions

describe_map(**kwargs)

Retrieves the map resource details.

See also: AWS API Documentation

Request Syntax

response = client.describe_map(
    MapName='string'
)
Parameters
MapName (string) --

[REQUIRED]

The name of the map resource.

Return type
dict
Returns
Response Syntax
{
    'Configuration': {
        'Style': 'string'
    },
    'CreateTime': datetime(2015, 1, 1),
    'DataSource': 'string',
    'Description': 'string',
    'MapArn': 'string',
    'MapName': 'string',
    'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    'Tags': {
        'string': 'string'
    },
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • Configuration (dict) --

      Specifies the map tile style selected from a partner data provider.

      • Style (string) --

        Specifies the map style selected from an available data provider. For additional information on each map style and to preview each map style, see Esri map styles and HERE map styles .

        Valid Esri styles:

        • VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content.
        • RasterEsriImagery – The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide.
        • VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content.
        • VectorEsriTopographic – The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.
        • VectorEsriStreets – The Esri World Streets map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.
        • VectorEsriNavigation – The Esri World Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.

        Valid HERE Technologies styles:

        • VectorHereBerlin – The HERE Berlin map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.

        Note

        When using HERE as your data provider, and selecting the Style VectorHereBerlin , you may not use HERE Technologies maps for Asset Management. See the AWS Service Terms for Amazon Location Service.

    • CreateTime (datetime) --

      The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • DataSource (string) --

      Specifies the data provider for the associated map tiles.

    • Description (string) --

      The optional description for the map resource.

    • MapArn (string) --

      The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.

      • Format example: arn:aws:geo:region:account-id:maps/ExampleMap
    • MapName (string) --

      The map style selected from an available provider.

    • PricingPlan (string) --

      The pricing plan selected for the specified map resource.

      <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing page</a>.</p>
    • Tags (dict) --

      Tags associated with the map resource.

      • (string) --
        • (string) --
    • UpdateTime (datetime) --

      The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

Exceptions

describe_place_index(**kwargs)

Retrieves the place index resource details.

See also: AWS API Documentation

Request Syntax

response = client.describe_place_index(
    IndexName='string'
)
Parameters
IndexName (string) --

[REQUIRED]

The name of the place index resource.

Return type
dict
Returns
Response Syntax
{
    'CreateTime': datetime(2015, 1, 1),
    'DataSource': 'string',
    'DataSourceConfiguration': {
        'IntendedUse': 'SingleUse'|'Storage'
    },
    'Description': 'string',
    'IndexArn': 'string',
    'IndexName': 'string',
    'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    'Tags': {
        'string': 'string'
    },
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • CreateTime (datetime) --

      The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • DataSource (string) --

      The data provider of geospatial data. Indicates one of the available providers:

      • Esri
      • Here

      For additional details on data providers, see the Amazon Location Service data providers page .

    • DataSourceConfiguration (dict) --

      The specified data storage option for requesting Places.

      • IntendedUse (string) --

        Specifies how the results of an operation will be stored by the caller.

        Valid values include:

        • SingleUse specifies that the results won't be stored.
        • Storage specifies that the result can be cached or stored in a database.

        Default value: SingleUse

    • Description (string) --

      The optional description for the place index resource.

    • IndexArn (string) --

      The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.

      • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
    • IndexName (string) --

      The name of the place index resource being described.

    • PricingPlan (string) --

      The pricing plan selected for the specified place index resource.

      For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

    • Tags (dict) --

      Tags associated with place index resource.

      • (string) --
        • (string) --
    • UpdateTime (datetime) --

      The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

Exceptions

describe_route_calculator(**kwargs)

Retrieves the route calculator resource details.

See also: AWS API Documentation

Request Syntax

response = client.describe_route_calculator(
    CalculatorName='string'
)
Parameters
CalculatorName (string) --

[REQUIRED]

The name of the route calculator resource.

Return type
dict
Returns
Response Syntax
{
    'CalculatorArn': 'string',
    'CalculatorName': 'string',
    'CreateTime': datetime(2015, 1, 1),
    'DataSource': 'string',
    'Description': 'string',
    'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    'Tags': {
        'string': 'string'
    },
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • CalculatorArn (string) --

      The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.

      • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
    • CalculatorName (string) --

      The name of the route calculator resource being described.

    • CreateTime (datetime) --

      The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

      • For example, 2020–07-2T12:15:20.000Z+01:00
    • DataSource (string) --

      The data provider of traffic and road network data. Indicates one of the available providers:

      • Esri
      • Here

      For more information about data providers, see Amazon Location Service data providers .

    • Description (string) --

      The optional description of the route calculator resource.

    • PricingPlan (string) --

      The pricing plan selected for the specified route calculator resource.

      For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .

    • Tags (dict) --

      Tags associated with route calculator resource.

      • (string) --
        • (string) --
    • UpdateTime (datetime) --

      The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

      • For example, 2020–07-2T12:15:20.000Z+01:00

Exceptions

describe_tracker(**kwargs)

Retrieves the tracker resource details.

See also: AWS API Documentation

Request Syntax

response = client.describe_tracker(
    TrackerName='string'
)
Parameters
TrackerName (string) --

[REQUIRED]

The name of the tracker resource.

Return type
dict
Returns
Response Syntax
{
    'CreateTime': datetime(2015, 1, 1),
    'Description': 'string',
    'KmsKeyId': 'string',
    'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    'PricingPlanDataSource': 'string',
    'Tags': {
        'string': 'string'
    },
    'TrackerArn': 'string',
    'TrackerName': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • CreateTime (datetime) --

      The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • Description (string) --

      The optional description for the tracker resource.

    • KmsKeyId (string) --

      A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.

    • PricingPlan (string) --

      The pricing plan selected for the specified tracker resource.

      For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

    • PricingPlanDataSource (string) --

      The specified data provider for the tracker resource.

    • Tags (dict) --

      The tags associated with the tracker resource.

      • (string) --
        • (string) --
    • TrackerArn (string) --

      The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.

      • Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker
    • TrackerName (string) --

      The name of the tracker resource.

    • UpdateTime (datetime) --

      The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

Exceptions

disassociate_tracker_consumer(**kwargs)

Removes the association between a tracker resource and a geofence collection.

Note

Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_tracker_consumer(
    ConsumerArn='string',
    TrackerName='string'
)
Parameters
  • ConsumerArn (string) --

    [REQUIRED]

    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 AWS.

    • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
  • TrackerName (string) --

    [REQUIRED]

    The name of the tracker resource to be dissociated from the consumer.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_device_position(**kwargs)

Retrieves a device's most recent position according to its sample time.

Note

Device positions are deleted after 30 days.

See also: AWS API Documentation

Request Syntax

response = client.get_device_position(
    DeviceId='string',
    TrackerName='string'
)
Parameters
  • DeviceId (string) --

    [REQUIRED]

    The device whose position you want to retrieve.

  • TrackerName (string) --

    [REQUIRED]

    The tracker resource receiving the position update.

Return type

dict

Returns

Response Syntax

{
    'DeviceId': 'string',
    'Position': [
        123.0,
    ],
    'ReceivedTime': datetime(2015, 1, 1),
    'SampleTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • DeviceId (string) --

      The device whose position you retrieved.

    • Position (list) --

      The last known device position.

      • (float) --
    • ReceivedTime (datetime) --

      The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • SampleTime (datetime) --

      The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

Exceptions

get_device_position_history(**kwargs)

Retrieves the device position history from a tracker resource within a specified range of time.

Note

Device positions are deleted after 30 days.

See also: AWS API Documentation

Request Syntax

response = client.get_device_position_history(
    DeviceId='string',
    EndTimeExclusive=datetime(2015, 1, 1),
    NextToken='string',
    StartTimeInclusive=datetime(2015, 1, 1),
    TrackerName='string'
)
Parameters
  • DeviceId (string) --

    [REQUIRED]

    The device whose position history you want to retrieve.

  • EndTimeExclusive (datetime) --

    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 .
  • NextToken (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

  • StartTimeInclusive (datetime) --

    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 .
  • TrackerName (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'DevicePositions': [
        {
            'DeviceId': 'string',
            'Position': [
                123.0,
            ],
            'ReceivedTime': datetime(2015, 1, 1),
            'SampleTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • DevicePositions (list) --

      Contains the position history details for the requested device.

      • (dict) --

        Contains the device position details.

        • DeviceId (string) --

          The device whose position you retrieved.

        • Position (list) --

          The last known device position.

          • (float) --
        • ReceivedTime (datetime) --

          The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

        • SampleTime (datetime) --

          The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • NextToken (string) --

      A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Exceptions

get_geofence(**kwargs)

Retrieves the geofence details from a geofence collection.

See also: AWS API Documentation

Request Syntax

response = client.get_geofence(
    CollectionName='string',
    GeofenceId='string'
)
Parameters
  • CollectionName (string) --

    [REQUIRED]

    The geofence collection storing the target geofence.

  • GeofenceId (string) --

    [REQUIRED]

    The geofence you're retrieving details for.

Return type

dict

Returns

Response Syntax

{
    'CreateTime': datetime(2015, 1, 1),
    'GeofenceId': 'string',
    'Geometry': {
        'Polygon': [
            [
                [
                    123.0,
                ],
            ],
        ]
    },
    'Status': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • CreateTime (datetime) --

      The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

    • GeofenceId (string) --

      The geofence identifier.

    • Geometry (dict) --

      Contains the geofence geometry details describing a polygon.

      • Polygon (list) --

        An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude] .

        The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.

        • (list) --
          • (list) --
            • (float) --
    • Status (string) --

      Identifies the state of the geofence. A geofence will hold one of the following states:

      • ACTIVE — The geofence has been indexed by the system.
      • PENDING — The geofence is being processed by the system.
      • FAILED — The geofence failed to be indexed by the system.
      • DELETED — The geofence has been deleted from the system index.
      • DELETING — The geofence is being deleted from the system index.
    • UpdateTime (datetime) --

      The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Exceptions

get_map_glyphs(**kwargs)

Retrieves glyphs used to display labels on a map.

See also: AWS API Documentation

Request Syntax

response = client.get_map_glyphs(
    FontStack='string',
    FontUnicodeRange='string',
    MapName='string'
)
Parameters
  • FontStack (string) --

    [REQUIRED]

    A comma-separated list of fonts to load glyphs from in order of preference. For example, Noto Sans Regular, Arial Unicode .

    Valid fonts for Esri styles:

    • VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu Regular | Ubuntu Bold
    • VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu Bold
    • VectorEsriTopographic – Noto Sans Italic | Noto Sans Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light Italic
    • VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold
    • VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold

    Valid fonts for HERE Technologies styles:

    • VectorHereBerlinFira GO Regular | Fira GO Bold
  • FontUnicodeRange (string) --

    [REQUIRED]

    A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example, 0–255 includes all characters from range U+0000 to 00FF . Must be aligned to multiples of 256.

  • MapName (string) --

    [REQUIRED]

    The map resource associated with the glyph file.

Return type

dict

Returns

Response Syntax

{
    'Blob': StreamingBody(),
    'ContentType': 'string'
}

Response Structure

  • (dict) --

    • Blob (StreamingBody) --

      The blob's content type.

    • ContentType (string) --

      The map glyph content type. For example, application/octet-stream .

Exceptions

get_map_sprites(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_map_sprites(
    FileName='string',
    MapName='string'
)
Parameters
  • FileName (string) --

    [REQUIRED]

    The name of the sprite file. Use the following file names for the sprite sheet:

    • sprites.png
    • sprites@2x.png for high pixel density displays

    For the JSON document contain image offsets. Use the following file names:

    • sprites.json
    • sprites@2x.json for high pixel density displays
  • MapName (string) --

    [REQUIRED]

    The map resource associated with the sprite file.

Return type

dict

Returns

Response Syntax

{
    'Blob': StreamingBody(),
    'ContentType': 'string'
}

Response Structure

  • (dict) --

    • Blob (StreamingBody) --

      Contains the body of the sprite sheet or JSON offset file.

    • ContentType (string) --

      The content type of the sprite sheet and offsets. For example, the sprite sheet content type is image/png , and the sprite offset JSON document is application/json .

Exceptions

get_map_style_descriptor(**kwargs)

Retrieves the map style descriptor from a map resource.

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.

See also: AWS API Documentation

Request Syntax

response = client.get_map_style_descriptor(
    MapName='string'
)
Parameters
MapName (string) --

[REQUIRED]

The map resource to retrieve the style descriptor from.

Return type
dict
Returns
Response Syntax
{
    'Blob': StreamingBody(),
    'ContentType': 'string'
}

Response Structure

  • (dict) --
    • Blob (StreamingBody) --

      Contains the body of the style descriptor.

    • ContentType (string) --

      The style descriptor's content type. For example, application/json .

Exceptions

get_map_tile(**kwargs)

Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.

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).

See also: AWS API Documentation

Request Syntax

response = client.get_map_tile(
    MapName='string',
    X='string',
    Y='string',
    Z='string'
)
Parameters
  • MapName (string) --

    [REQUIRED]

    The map resource to retrieve the map tiles from.

  • X (string) --

    [REQUIRED]

    The X axis value for the map tile.

  • Y (string) --

    [REQUIRED]

    The Y axis value for the map tile.

  • Z (string) --

    [REQUIRED]

    The zoom value for the map tile.

Return type

dict

Returns

Response Syntax

{
    'Blob': StreamingBody(),
    'ContentType': 'string'
}

Response Structure

  • (dict) --

    • Blob (StreamingBody) --

      Contains Mapbox Vector Tile (MVT) data.

    • ContentType (string) --

      The map tile's content type. For example, application/vnd.mapbox-vector-tile .

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_device_positions(**kwargs)

A batch request to retrieve all device positions.

See also: AWS API Documentation

Request Syntax

response = client.list_device_positions(
    MaxResults=123,
    NextToken='string',
    TrackerName='string'
)
Parameters
  • MaxResults (integer) --

    An optional limit for the number of entries returned in a single call.

    Default value: 100

  • NextToken (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

  • TrackerName (string) --

    [REQUIRED]

    The tracker resource containing the requested devices.

Return type

dict

Returns

Response Syntax

{
    'Entries': [
        {
            'DeviceId': 'string',
            'Position': [
                123.0,
            ],
            'SampleTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Entries (list) --

      Contains details about each device's last known position. These details includes the device ID, the time when the position was sampled on the device, the time that the service received the update, and the most recent coordinates.

      • (dict) --

        Contains the tracker resource details.

        • DeviceId (string) --

          The ID of the device for this position.

        • Position (list) --

          The last known device position. Empty if no positions currently stored.

          • (float) --
        • SampleTime (datetime) --

          The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • NextToken (string) --

      A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Exceptions

list_geofence_collections(**kwargs)

Lists geofence collections in your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_geofence_collections(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) --

    An optional limit for the number of resources returned in a single call.

    Default value: 100

  • NextToken (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

Return type

dict

Returns

Response Syntax

{
    'Entries': [
        {
            'CollectionName': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'Description': 'string',
            'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
            'PricingPlanDataSource': 'string',
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Entries (list) --

      Lists the geofence collections that exist in your AWS account.

      • (dict) --

        Contains the geofence collection details.

        • CollectionName (string) --

          The name of the geofence collection.

        • CreateTime (datetime) --

          The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

        • Description (string) --

          The description for the geofence collection

        • PricingPlan (string) --

          The pricing plan for the specified geofence collection.

          For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

        • PricingPlanDataSource (string) --

          The specified data provider for the geofence collection.

        • UpdateTime (datetime) --

          Specifies a timestamp for when the resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

    • NextToken (string) --

      A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Exceptions

list_geofences(**kwargs)

Lists geofences stored in a given geofence collection.

See also: AWS API Documentation

Request Syntax

response = client.list_geofences(
    CollectionName='string',
    NextToken='string'
)
Parameters
  • CollectionName (string) --

    [REQUIRED]

    The name of the geofence collection storing the list of geofences.

  • NextToken (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

Return type

dict

Returns

Response Syntax

{
    'Entries': [
        {
            'CreateTime': datetime(2015, 1, 1),
            'GeofenceId': 'string',
            'Geometry': {
                'Polygon': [
                    [
                        [
                            123.0,
                        ],
                    ],
                ]
            },
            'Status': 'string',
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Entries (list) --

      Contains a list of geofences stored in the geofence collection.

      • (dict) --

        Contains a list of geofences stored in a given geofence collection.

        • CreateTime (datetime) --

          The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

        • GeofenceId (string) --

          The geofence identifier.

        • Geometry (dict) --

          Contains the geofence geometry details describing a polygon.

          • Polygon (list) --

            An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude] .

            The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.

            • (list) --
              • (list) --
                • (float) --
        • Status (string) --

          Identifies the state of the geofence. A geofence will hold one of the following states:

          • ACTIVE — The geofence has been indexed by the system.
          • PENDING — The geofence is being processed by the system.
          • FAILED — The geofence failed to be indexed by the system.
          • DELETED — The geofence has been deleted from the system index.
          • DELETING — The geofence is being deleted from the system index.
        • UpdateTime (datetime) --

          The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

    • NextToken (string) --

      A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Exceptions

list_maps(**kwargs)

Lists map resources in your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_maps(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) --

    An optional limit for the number of resources returned in a single call.

    Default value: 100

  • NextToken (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

Return type

dict

Returns

Response Syntax

{
    'Entries': [
        {
            'CreateTime': datetime(2015, 1, 1),
            'DataSource': 'string',
            'Description': 'string',
            'MapName': 'string',
            'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Entries (list) --

      Contains a list of maps in your AWS account

      • (dict) --

        Contains details of an existing map resource in your AWS account.

        • CreateTime (datetime) --

          The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

        • DataSource (string) --

          Specifies the data provider for the associated map tiles.

        • Description (string) --

          The description for the map resource.

        • MapName (string) --

          The name of the associated map resource.

        • PricingPlan (string) --

          The pricing plan for the specified map resource.

          For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

        • UpdateTime (datetime) --

          The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • NextToken (string) --

      A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Exceptions

list_place_indexes(**kwargs)

Lists place index resources in your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_place_indexes(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) --

    An optional limit for the maximum number of results returned in a single call.

    Default value: 100

  • NextToken (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

Return type

dict

Returns

Response Syntax

{
    'Entries': [
        {
            'CreateTime': datetime(2015, 1, 1),
            'DataSource': 'string',
            'Description': 'string',
            'IndexName': 'string',
            'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Entries (list) --

      Lists the place index resources that exist in your AWS account

      • (dict) --

        A place index resource listed in your AWS account.

        • CreateTime (datetime) --

          The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

        • DataSource (string) --

          The data provider of geospatial data. Indicates one of the available providers:

          • Esri
          • Here

          For additional details on data providers, see the Amazon Location Service data providers page .

        • Description (string) --

          The optional description for the place index resource.

        • IndexName (string) --

          The name of the place index resource.

        • PricingPlan (string) --

          The pricing plan for the specified place index resource.

          For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

        • UpdateTime (datetime) --

          The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • NextToken (string) --

      A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Exceptions

list_route_calculators(**kwargs)

Lists route calculator resources in your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_route_calculators(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) --

    An optional maximum number of results returned in a single call.

    Default Value: 100

  • NextToken (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

Return type

dict

Returns

Response Syntax

{
    'Entries': [
        {
            'CalculatorName': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'DataSource': 'string',
            'Description': 'string',
            'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Entries (list) --

      Lists the route calculator resources that exist in your AWS account

      • (dict) --

        A route calculator resource listed in your AWS account.

        • CalculatorName (string) --

          The name of the route calculator resource.

        • CreateTime (datetime) --

          The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

          • For example, 2020–07-2T12:15:20.000Z+01:00
        • DataSource (string) --

          The data provider of traffic and road network data. Indicates one of the available providers:

          • Esri
          • Here

          For more information about data providers, see Amazon Location Service data providers .

        • Description (string) --

          The optional description of the route calculator resource.

        • PricingPlan (string) --

          The pricing plan for the specified route calculator resource.

          For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .

        • UpdateTime (datetime) --

          The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

          • For example, 2020–07-2T12:15:20.000Z+01:00
    • NextToken (string) --

      A pagination token indicating there are additional pages available. You can use the token in a subsequent request to fetch the next set of results.

Exceptions

list_tags_for_resource(**kwargs)

Returns a list of tags that are applied to the specified Amazon Location resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

  • Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource
Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • Tags (dict) --

      Tags that have been applied to the specified resource. Tags are mapped from the tag key to the tag value: "TagKey" : "TagValue" .

      • Format example: {"tag1" : "value1", "tag2" : "value2"}
      • (string) --
        • (string) --

Exceptions

list_tracker_consumers(**kwargs)

Lists geofence collections currently associated to the given tracker resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tracker_consumers(
    MaxResults=123,
    NextToken='string',
    TrackerName='string'
)
Parameters
  • MaxResults (integer) --

    An optional limit for the number of resources returned in a single call.

    Default value: 100

  • NextToken (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

  • TrackerName (string) --

    [REQUIRED]

    The tracker resource whose associated geofence collections you want to list.

Return type

dict

Returns

Response Syntax

{
    'ConsumerArns': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ConsumerArns (list) --

      Contains the list of geofence collection ARNs associated to the tracker resource.

      • (string) --
    • NextToken (string) --

      A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Exceptions

list_trackers(**kwargs)

Lists tracker resources in your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_trackers(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) --

    An optional limit for the number of resources returned in a single call.

    Default value: 100

  • NextToken (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

Return type

dict

Returns

Response Syntax

{
    'Entries': [
        {
            'CreateTime': datetime(2015, 1, 1),
            'Description': 'string',
            'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
            'PricingPlanDataSource': 'string',
            'TrackerName': 'string',
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Entries (list) --

      Contains tracker resources in your AWS account. Details include tracker name, description and timestamps for when the tracker was created and last updated.

      • (dict) --

        Contains the tracker resource details.

        • CreateTime (datetime) --

          The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

        • Description (string) --

          The description for the tracker resource.

        • PricingPlan (string) --

          The pricing plan for the specified tracker resource.

          For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

        • PricingPlanDataSource (string) --

          The specified data provider for the tracker resource.

        • TrackerName (string) --

          The name of the tracker resource.

        • UpdateTime (datetime) --

          The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • NextToken (string) --

      A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Exceptions

put_geofence(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.put_geofence(
    CollectionName='string',
    GeofenceId='string',
    Geometry={
        'Polygon': [
            [
                [
                    123.0,
                ],
            ],
        ]
    }
)
Parameters
  • CollectionName (string) --

    [REQUIRED]

    The geofence collection to store the geofence in.

  • GeofenceId (string) --

    [REQUIRED]

    An identifier for the geofence. For example, ExampleGeofence-1 .

  • Geometry (dict) --

    [REQUIRED]

    Contains the polygon details to specify the position of the geofence.

    Note

    Each geofence polygon can have a maximum of 1,000 vertices.

    • Polygon (list) --

      An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude] .

      The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.

      • (list) --
        • (list) --
          • (float) --
Return type

dict

Returns

Response Syntax

{
    'CreateTime': datetime(2015, 1, 1),
    'GeofenceId': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • CreateTime (datetime) --

      The timestamp for when the geofence was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

    • GeofenceId (string) --

      The geofence identifier entered in the request.

    • UpdateTime (datetime) --

      The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Exceptions

search_place_index_for_position(**kwargs)

Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.

See also: AWS API Documentation

Request Syntax

response = client.search_place_index_for_position(
    IndexName='string',
    MaxResults=123,
    Position=[
        123.0,
    ]
)
Parameters
  • IndexName (string) --

    [REQUIRED]

    The name of the place index resource you want to use for the search.

  • MaxResults (integer) --

    An optional paramer. The maximum number of results returned per request.

    Default value: 50

  • Position (list) --

    [REQUIRED]

    Specifies a coordinate for the query defined by a longitude, and latitude.

    • The first position is the X coordinate, or longitude.
    • The second position is the Y coordinate, or latitude.

    For example, position=xLongitude&position=yLatitude .

    • (float) --
Return type

dict

Returns

Response Syntax

{
    'Results': [
        {
            'Place': {
                'AddressNumber': 'string',
                'Country': 'string',
                'Geometry': {
                    'Point': [
                        123.0,
                    ]
                },
                'Label': 'string',
                'Municipality': 'string',
                'Neighborhood': 'string',
                'PostalCode': 'string',
                'Region': 'string',
                'Street': 'string',
                'SubRegion': 'string'
            }
        },
    ],
    'Summary': {
        'DataSource': 'string',
        'MaxResults': 123,
        'Position': [
            123.0,
        ]
    }
}

Response Structure

  • (dict) --

    • Results (list) --

      Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned.

      • (dict) --

        Specifies a single point of interest, or Place as a result of a search query obtained from a dataset configured in the place index resource.

        • Place (dict) --

          Contains details about the relevant point of interest.

          • AddressNumber (string) --

            The numerical portion of an address, such as a building number.

          • Country (string) --

            A country/region specified using ISO 3166 3-digit country/region code. For example, CAN .

          • Geometry (dict) --

            Places uses a point geometry to specify a location or a Place.

            • Point (list) --

              A single point geometry specifies a location for a Place using WGS 84 coordinates:

              • x — Specifies the x coordinate or longitude.
              • y — Specifies the y coordinate or latitude.
              • (float) --
          • Label (string) --

            The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA .

          • Municipality (string) --

            A name for a local area, such as a city or town name. For example, Toronto .

          • Neighborhood (string) --

            The name of a community district. For example, Downtown .

          • PostalCode (string) --

            A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.

          • Region (string) --

            A name for an area or geographical division, such as a province or state name. For example, British Columbia .

          • Street (string) --

            The name for a street or a road to identify a location. For example, Main Street .

          • SubRegion (string) --

            A country, or an area that's part of a larger region . For example, Metro Vancouver .

    • Summary (dict) --

      Contains a summary of the request.

      • DataSource (string) --

        The data provider of geospatial data. Indicates one of the available providers:

        • Esri
        • HERE

        For additional details on data providers, see the Amazon Location Service data providers page .

      • MaxResults (integer) --

        An optional parameter. The maximum number of results returned per request.

        Default value: 50

      • Position (list) --

        The position given in the reverse geocoding request.

        • (float) --

Exceptions

search_place_index_for_text(**kwargs)

Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.

Includes the option to apply additional parameters to narrow your list of results.

Note

You can search for places near a given position using BiasPosition , or filter results within a bounding box using FilterBBox . Providing both parameters simultaneously returns an error.

See also: AWS API Documentation

Request Syntax

response = client.search_place_index_for_text(
    BiasPosition=[
        123.0,
    ],
    FilterBBox=[
        123.0,
    ],
    FilterCountries=[
        'string',
    ],
    IndexName='string',
    MaxResults=123,
    Text='string'
)
Parameters
  • BiasPosition (list) --

    Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

    • The first bias position is the X coordinate, or longitude.
    • The second bias position is the Y coordinate, or latitude.

    For example, bias=xLongitude&bias=yLatitude .

    • (float) --
  • FilterBBox (list) --

    Filters the results by returning only Places within the provided bounding box. An optional parameter.

    The first 2 bbox parameters describe the lower southwest corner:

    • The first bbox position is the X coordinate or longitude of the lower southwest corner.
    • The second bbox position is the Y coordinate or latitude of the lower southwest corner.

    For example, bbox=xLongitudeSW&bbox=yLatitudeSW .

    The next bbox parameters describe the upper northeast corner:

    • The third bbox position is the X coordinate, or longitude of the upper northeast corner.
    • The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

    For example, bbox=xLongitudeNE&bbox=yLatitudeNE

    • (float) --
  • FilterCountries (list) --

    Limits the search to the given a list of countries/regions. An optional parameter.

    • Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS .
    • (string) --
  • IndexName (string) --

    [REQUIRED]

    The name of the place index resource you want to use for the search.

  • MaxResults (integer) --

    An optional parameter. The maximum number of results returned per request.

    The default: 50

  • Text (string) --

    [REQUIRED]

    The address, name, city, or region to be used in the search. In free-form text format. For example, 123 Any Street .

Return type

dict

Returns

Response Syntax

{
    'Results': [
        {
            'Place': {
                'AddressNumber': 'string',
                'Country': 'string',
                'Geometry': {
                    'Point': [
                        123.0,
                    ]
                },
                'Label': 'string',
                'Municipality': 'string',
                'Neighborhood': 'string',
                'PostalCode': 'string',
                'Region': 'string',
                'Street': 'string',
                'SubRegion': 'string'
            }
        },
    ],
    'Summary': {
        'BiasPosition': [
            123.0,
        ],
        'DataSource': 'string',
        'FilterBBox': [
            123.0,
        ],
        'FilterCountries': [
            'string',
        ],
        'MaxResults': 123,
        'ResultBBox': [
            123.0,
        ],
        'Text': 'string'
    }
}

Response Structure

  • (dict) --

    • Results (list) --

      A list of Places closest to the specified position. Each result contains additional information about the specific point of interest.

      • (dict) --

        Contains relevant Places returned by calling SearchPlaceIndexForText .

        • Place (dict) --

          Contains details about the relevant point of interest.

          • AddressNumber (string) --

            The numerical portion of an address, such as a building number.

          • Country (string) --

            A country/region specified using ISO 3166 3-digit country/region code. For example, CAN .

          • Geometry (dict) --

            Places uses a point geometry to specify a location or a Place.

            • Point (list) --

              A single point geometry specifies a location for a Place using WGS 84 coordinates:

              • x — Specifies the x coordinate or longitude.
              • y — Specifies the y coordinate or latitude.
              • (float) --
          • Label (string) --

            The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA .

          • Municipality (string) --

            A name for a local area, such as a city or town name. For example, Toronto .

          • Neighborhood (string) --

            The name of a community district. For example, Downtown .

          • PostalCode (string) --

            A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.

          • Region (string) --

            A name for an area or geographical division, such as a province or state name. For example, British Columbia .

          • Street (string) --

            The name for a street or a road to identify a location. For example, Main Street .

          • SubRegion (string) --

            A country, or an area that's part of a larger region . For example, Metro Vancouver .

    • Summary (dict) --

      Contains a summary of the request. Contains the BiasPosition , DataSource , FilterBBox , FilterCountries , MaxResults , ResultBBox , and Text .

      • BiasPosition (list) --

        Contains the coordinates for the bias position entered in the geocoding request.

        • (float) --
      • DataSource (string) --

        The data provider of geospatial data. Indicates one of the available providers:

        • Esri
        • HERE

        For additional details on data providers, see the Amazon Location Service data providers page .

      • FilterBBox (list) --

        Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.

        • (float) --
      • FilterCountries (list) --

        Contains the country filter entered in the geocoding request.

        • (string) --
      • MaxResults (integer) --

        Contains the maximum number of results indicated for the request.

      • ResultBBox (list) --

        A bounding box that contains the search results within the specified area indicated by FilterBBox . A subset of bounding box specified using FilterBBox .

        • (float) --
      • Text (string) --

        The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver .

Exceptions

tag_resource(**kwargs)

Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.

<p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p> <p>You can use the <code>TagResource</code> operation with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that's already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate up to 50 tags with a resource.</p>

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource whose tags you want to update.

    • Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource
  • Tags (dict) --

    [REQUIRED]

    Tags that have been applied to the specified resource. Tags are mapped from the tag key to the tag value: "TagKey" : "TagValue" .

    • Format example: {"tag1" : "value1", "tag2" : "value2"}
    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes one or more tags from the specified Amazon Location resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource from which you want to remove tags.

    • Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource
  • TagKeys (list) --

    [REQUIRED]

    The list of tag keys to remove from the specified resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_geofence_collection(**kwargs)

Updates the specified properties of a given geofence collection.

See also: AWS API Documentation

Request Syntax

response = client.update_geofence_collection(
    CollectionName='string',
    Description='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    PricingPlanDataSource='string'
)
Parameters
  • CollectionName (string) --

    [REQUIRED]

    The name of the geofence collection to update.

  • Description (string) -- Updates the description for the geofence collection.
  • PricingPlan (string) --

    Updates the pricing plan for the geofence collection.

    For more information about each pricing plan option restrictions, see Amazon Location Service pricing .

  • PricingPlanDataSource (string) --

    Updates the data provider for the geofence collection.

    A required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

    For more information about data providers and pricing plans , see the Amazon Location Service product page.

    Note

    This can only be updated when updating the PricingPlan in the same request.

    Amazon Location Service uses PricingPlanDataSource to calculate billing for your geofence collection. Your data won't be shared with the data provider, and will remain in your AWS account and Region unless you move it.

Return type

dict

Returns

Response Syntax

{
    'CollectionArn': 'string',
    'CollectionName': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • CollectionArn (string) --

      The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a resource across AWS.

      • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
    • CollectionName (string) --

      The name of the updated geofence collection.

    • UpdateTime (datetime) --

      The time when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Exceptions

update_map(**kwargs)

Updates the specified properties of a given map resource.

See also: AWS API Documentation

Request Syntax

response = client.update_map(
    Description='string',
    MapName='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement'
)
Parameters
  • Description (string) -- Updates the description for the map resource.
  • MapName (string) --

    [REQUIRED]

    The name of the map resource to update.

  • PricingPlan (string) --

    Updates the pricing plan for the map resource.

    For more information about each pricing plan option restrictions, see Amazon Location Service pricing .

Return type

dict

Returns

Response Syntax

{
    'MapArn': 'string',
    'MapName': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • MapArn (string) --

      The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource across AWS.

      • Format example: arn:aws:geo:region:account-id:maps/ExampleMap
    • MapName (string) --

      The name of the updated map resource.

    • UpdateTime (datetime) --

      The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

Exceptions

update_place_index(**kwargs)

Updates the specified properties of a given place index resource.

See also: AWS API Documentation

Request Syntax

response = client.update_place_index(
    DataSourceConfiguration={
        'IntendedUse': 'SingleUse'|'Storage'
    },
    Description='string',
    IndexName='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement'
)
Parameters
  • DataSourceConfiguration (dict) --

    Updates the data storage option for the place index resource.

    • IntendedUse (string) --

      Specifies how the results of an operation will be stored by the caller.

      Valid values include:

      • SingleUse specifies that the results won't be stored.
      • Storage specifies that the result can be cached or stored in a database.

      Default value: SingleUse

  • Description (string) -- Updates the description for the place index resource.
  • IndexName (string) --

    [REQUIRED]

    The name of the place index resource to update.

  • PricingPlan (string) --

    Updates the pricing plan for the place index resource.

    For more information about each pricing plan option restrictions, see Amazon Location Service pricing .

Return type

dict

Returns

Response Syntax

{
    'IndexArn': 'string',
    'IndexName': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • IndexArn (string) --

      The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a resource across AWS.

      • Format example: arn:aws:geo:region:account-id:place- index/ExamplePlaceIndex
    • IndexName (string) --

      The name of the updated place index resource.

    • UpdateTime (datetime) --

      The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

Exceptions

update_route_calculator(**kwargs)

Updates the specified properties for a given route calculator resource.

See also: AWS API Documentation

Request Syntax

response = client.update_route_calculator(
    CalculatorName='string',
    Description='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement'
)
Parameters
  • CalculatorName (string) --

    [REQUIRED]

    The name of the route calculator resource to update.

  • Description (string) -- Updates the description for the route calculator resource.
  • PricingPlan (string) --

    Updates the pricing plan for the route calculator resource.

    For more information about each pricing plan option restrictions, see Amazon Location Service pricing .

Return type

dict

Returns

Response Syntax

{
    'CalculatorArn': 'string',
    'CalculatorName': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • CalculatorArn (string) --

      The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource across AWS.

      • Format example: arn:aws:geo:region:account-id:route- calculator/ExampleCalculator
    • CalculatorName (string) --

      The name of the updated route calculator resource.

    • UpdateTime (datetime) --

      The timestamp for when the route calculator was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

Exceptions

update_tracker(**kwargs)

Updates the specified properties of a given tracker resource.

See also: AWS API Documentation

Request Syntax

response = client.update_tracker(
    Description='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    PricingPlanDataSource='string',
    TrackerName='string'
)
Parameters
  • Description (string) -- Updates the description for the tracker resource.
  • PricingPlan (string) --

    Updates the pricing plan for the tracker resource.

    For more information about each pricing plan option restrictions, see Amazon Location Service pricing .

  • PricingPlanDataSource (string) --

    Updates the data provider for the tracker resource.

    A required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

    For more information about data providers and pricing plans , see the Amazon Location Service product page

    Note

    This can only be updated when updating the PricingPlan in the same request.

    Amazon Location Service uses PricingPlanDataSource to calculate billing for your tracker resource. Your data won't be shared with the data provider, and will remain in your AWS account and Region unless you move it.

  • TrackerName (string) --

    [REQUIRED]

    The name of the tracker resource to update.

Return type

dict

Returns

Response Syntax

{
    'TrackerArn': 'string',
    'TrackerName': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • TrackerArn (string) --

      The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS.

      • Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker
    • TrackerName (string) --

      The name of the updated tracker resource.

    • UpdateTime (datetime) --

      The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class LocationService.Client.exceptions.AccessDeniedException

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LocationService.Client.exceptions.ConflictException

The request was unsuccessful because of a conflict.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was unsuccessful because of a conflict.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LocationService.Client.exceptions.InternalServerException

The request has failed to process because of an unknown server error, exception, or failure.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request has failed to process because of an unknown server error, exception, or failure.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LocationService.Client.exceptions.ResourceNotFoundException

The resource that you've entered was not found in your AWS account.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource that you've entered was not found in your AWS account.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LocationService.Client.exceptions.ServiceQuotaExceededException

The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.

    • Message (string) --

      A message with the reason for the service quota exceeded exception error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LocationService.Client.exceptions.ThrottlingException

The request was denied because of request throttling.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied because of request throttling.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LocationService.Client.exceptions.ValidationException

The input failed to meet the constraints specified by the AWS service.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'FieldList': [
        {
            'Message': 'string',
            'Name': 'string'
        },
    ],
    'Message': 'string',
    'Reason': 'UnknownOperation'|'Missing'|'CannotParse'|'FieldValidationFailed'|'Other',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The input failed to meet the constraints specified by the AWS service.

    • FieldList (list) --

      The field where the invalid entry was detected.

      • (dict) --

        The input failed to meet the constraints specified by the AWS service in a specified field.

        • Message (string) --

          A message with the reason for the validation exception error.

        • Name (string) --

          The field name where the invalid entry was detected.

    • Message (string) --

    • Reason (string) --

      A message with the reason for the validation exception error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class LocationService.Paginator.GetDevicePositionHistory
paginator = client.get_paginator('get_device_position_history')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LocationService.Client.get_device_position_history().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DeviceId='string',
    EndTimeExclusive=datetime(2015, 1, 1),
    StartTimeInclusive=datetime(2015, 1, 1),
    TrackerName='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • DeviceId (string) --

    [REQUIRED]

    The device whose position history you want to retrieve.

  • EndTimeExclusive (datetime) --

    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 .
  • StartTimeInclusive (datetime) --

    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 .
  • TrackerName (string) --

    [REQUIRED]

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

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'DevicePositions': [
        {
            'DeviceId': 'string',
            'Position': [
                123.0,
            ],
            'ReceivedTime': datetime(2015, 1, 1),
            'SampleTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --

    • DevicePositions (list) --

      Contains the position history details for the requested device.

      • (dict) --

        Contains the device position details.

        • DeviceId (string) --

          The device whose position you retrieved.

        • Position (list) --

          The last known device position.

          • (float) --
        • ReceivedTime (datetime) --

          The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

        • SampleTime (datetime) --

          The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

class LocationService.Paginator.ListDevicePositions
paginator = client.get_paginator('list_device_positions')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LocationService.Client.list_device_positions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TrackerName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • TrackerName (string) --

    [REQUIRED]

    The tracker resource containing the requested devices.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Entries': [
        {
            'DeviceId': 'string',
            'Position': [
                123.0,
            ],
            'SampleTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --

    • Entries (list) --

      Contains details about each device's last known position. These details includes the device ID, the time when the position was sampled on the device, the time that the service received the update, and the most recent coordinates.

      • (dict) --

        Contains the tracker resource details.

        • DeviceId (string) --

          The ID of the device for this position.

        • Position (list) --

          The last known device position. Empty if no positions currently stored.

          • (float) --
        • SampleTime (datetime) --

          The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

class LocationService.Paginator.ListGeofenceCollections
paginator = client.get_paginator('list_geofence_collections')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LocationService.Client.list_geofence_collections().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Entries': [
        {
            'CollectionName': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'Description': 'string',
            'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
            'PricingPlanDataSource': 'string',
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --
    • Entries (list) --

      Lists the geofence collections that exist in your AWS account.

      • (dict) --

        Contains the geofence collection details.

        • CollectionName (string) --

          The name of the geofence collection.

        • CreateTime (datetime) --

          The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

        • Description (string) --

          The description for the geofence collection

        • PricingPlan (string) --

          The pricing plan for the specified geofence collection.

          For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

        • PricingPlanDataSource (string) --

          The specified data provider for the geofence collection.

        • UpdateTime (datetime) --

          Specifies a timestamp for when the resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

class LocationService.Paginator.ListGeofences
paginator = client.get_paginator('list_geofences')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LocationService.Client.list_geofences().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CollectionName='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • CollectionName (string) --

    [REQUIRED]

    The name of the geofence collection storing the list of geofences.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Entries': [
        {
            'CreateTime': datetime(2015, 1, 1),
            'GeofenceId': 'string',
            'Geometry': {
                'Polygon': [
                    [
                        [
                            123.0,
                        ],
                    ],
                ]
            },
            'Status': 'string',
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --

    • Entries (list) --

      Contains a list of geofences stored in the geofence collection.

      • (dict) --

        Contains a list of geofences stored in a given geofence collection.

        • CreateTime (datetime) --

          The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

        • GeofenceId (string) --

          The geofence identifier.

        • Geometry (dict) --

          Contains the geofence geometry details describing a polygon.

          • Polygon (list) --

            An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude] .

            The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.

            • (list) --
              • (list) --
                • (float) --
        • Status (string) --

          Identifies the state of the geofence. A geofence will hold one of the following states:

          • ACTIVE — The geofence has been indexed by the system.
          • PENDING — The geofence is being processed by the system.
          • FAILED — The geofence failed to be indexed by the system.
          • DELETED — The geofence has been deleted from the system index.
          • DELETING — The geofence is being deleted from the system index.
        • UpdateTime (datetime) --

          The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

class LocationService.Paginator.ListMaps
paginator = client.get_paginator('list_maps')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LocationService.Client.list_maps().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Entries': [
        {
            'CreateTime': datetime(2015, 1, 1),
            'DataSource': 'string',
            'Description': 'string',
            'MapName': 'string',
            'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --
    • Entries (list) --

      Contains a list of maps in your AWS account

      • (dict) --

        Contains details of an existing map resource in your AWS account.

        • CreateTime (datetime) --

          The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

        • DataSource (string) --

          Specifies the data provider for the associated map tiles.

        • Description (string) --

          The description for the map resource.

        • MapName (string) --

          The name of the associated map resource.

        • PricingPlan (string) --

          The pricing plan for the specified map resource.

          For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

        • UpdateTime (datetime) --

          The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

class LocationService.Paginator.ListPlaceIndexes
paginator = client.get_paginator('list_place_indexes')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LocationService.Client.list_place_indexes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Entries': [
        {
            'CreateTime': datetime(2015, 1, 1),
            'DataSource': 'string',
            'Description': 'string',
            'IndexName': 'string',
            'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --
    • Entries (list) --

      Lists the place index resources that exist in your AWS account

      • (dict) --

        A place index resource listed in your AWS account.

        • CreateTime (datetime) --

          The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

        • DataSource (string) --

          The data provider of geospatial data. Indicates one of the available providers:

          • Esri
          • Here

          For additional details on data providers, see the Amazon Location Service data providers page .

        • Description (string) --

          The optional description for the place index resource.

        • IndexName (string) --

          The name of the place index resource.

        • PricingPlan (string) --

          The pricing plan for the specified place index resource.

          For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

        • UpdateTime (datetime) --

          The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

class LocationService.Paginator.ListRouteCalculators
paginator = client.get_paginator('list_route_calculators')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LocationService.Client.list_route_calculators().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Entries': [
        {
            'CalculatorName': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'DataSource': 'string',
            'Description': 'string',
            'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --
    • Entries (list) --

      Lists the route calculator resources that exist in your AWS account

      • (dict) --

        A route calculator resource listed in your AWS account.

        • CalculatorName (string) --

          The name of the route calculator resource.

        • CreateTime (datetime) --

          The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

          • For example, 2020–07-2T12:15:20.000Z+01:00
        • DataSource (string) --

          The data provider of traffic and road network data. Indicates one of the available providers:

          • Esri
          • Here

          For more information about data providers, see Amazon Location Service data providers .

        • Description (string) --

          The optional description of the route calculator resource.

        • PricingPlan (string) --

          The pricing plan for the specified route calculator resource.

          For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .

        • UpdateTime (datetime) --

          The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

          • For example, 2020–07-2T12:15:20.000Z+01:00
class LocationService.Paginator.ListTrackerConsumers
paginator = client.get_paginator('list_tracker_consumers')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LocationService.Client.list_tracker_consumers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TrackerName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • TrackerName (string) --

    [REQUIRED]

    The tracker resource whose associated geofence collections you want to list.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ConsumerArns': [
        'string',
    ],

}

Response Structure

  • (dict) --

    • ConsumerArns (list) --

      Contains the list of geofence collection ARNs associated to the tracker resource.

      • (string) --

class LocationService.Paginator.ListTrackers
paginator = client.get_paginator('list_trackers')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LocationService.Client.list_trackers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Entries': [
        {
            'CreateTime': datetime(2015, 1, 1),
            'Description': 'string',
            'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
            'PricingPlanDataSource': 'string',
            'TrackerName': 'string',
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --
    • Entries (list) --

      Contains tracker resources in your AWS account. Details include tracker name, description and timestamps for when the tracker was created and last updated.

      • (dict) --

        Contains the tracker resource details.

        • CreateTime (datetime) --

          The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

        • Description (string) --

          The description for the tracker resource.

        • PricingPlan (string) --

          The pricing plan for the specified tracker resource.

          For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

        • PricingPlanDataSource (string) --

          The specified data provider for the tracker resource.

        • TrackerName (string) --

          The name of the tracker resource.

        • UpdateTime (datetime) --

          The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .