LocationServiceClient

Index > LocationService > LocationServiceClient

Auto-generated documentation for LocationService type annotations stubs module types-boto3-location.

LocationServiceClient

Type annotations and code completion for boto3.client("location"). boto3 documentation

# LocationServiceClient usage example

from boto3.session import Session
from types_boto3_location.client import LocationServiceClient

def get_location_client() -> LocationServiceClient:
    return Session().client("location")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("location").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("location")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_location.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("location").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("location").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

associate_tracker_consumer

Creates an association between a geofence collection and a tracker resource.

Type annotations and code completion for boto3.client("location").associate_tracker_consumer method. boto3 documentation

# associate_tracker_consumer method definition

def associate_tracker_consumer(
    self,
    *,
    TrackerName: str,
    ConsumerArn: str,
) -> Dict[str, Any]:
    ...

# associate_tracker_consumer method usage example with argument unpacking

kwargs: AssociateTrackerConsumerRequestTypeDef = {  # (1)
    "TrackerName": ...,
    "ConsumerArn": ...,
}

parent.associate_tracker_consumer(**kwargs)

1. See AssociateTrackerConsumerRequestTypeDef

batch_delete_device_position_history

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

Type annotations and code completion for boto3.client("location").batch_delete_device_position_history method. boto3 documentation

# batch_delete_device_position_history method definition

def batch_delete_device_position_history(
    self,
    *,
    TrackerName: str,
    DeviceIds: Sequence[str],
) -> BatchDeleteDevicePositionHistoryResponseTypeDef:  # (1)
    ...

1. See BatchDeleteDevicePositionHistoryResponseTypeDef

# batch_delete_device_position_history method usage example with argument unpacking

kwargs: BatchDeleteDevicePositionHistoryRequestTypeDef = {  # (1)
    "TrackerName": ...,
    "DeviceIds": ...,
}

parent.batch_delete_device_position_history(**kwargs)

1. See BatchDeleteDevicePositionHistoryRequestTypeDef

batch_delete_geofence

Deletes a batch of geofences from a geofence collection.

Type annotations and code completion for boto3.client("location").batch_delete_geofence method. boto3 documentation

# batch_delete_geofence method definition

def batch_delete_geofence(
    self,
    *,
    CollectionName: str,
    GeofenceIds: Sequence[str],
) -> BatchDeleteGeofenceResponseTypeDef:  # (1)
    ...

1. See BatchDeleteGeofenceResponseTypeDef

# batch_delete_geofence method usage example with argument unpacking

kwargs: BatchDeleteGeofenceRequestTypeDef = {  # (1)
    "CollectionName": ...,
    "GeofenceIds": ...,
}

parent.batch_delete_geofence(**kwargs)

1. See BatchDeleteGeofenceRequestTypeDef

batch_evaluate_geofences

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

Type annotations and code completion for boto3.client("location").batch_evaluate_geofences method. boto3 documentation

# batch_evaluate_geofences method definition

def batch_evaluate_geofences(
    self,
    *,
    CollectionName: str,
    DevicePositionUpdates: Sequence[DevicePositionUpdateTypeDef],  # (1)
) -> BatchEvaluateGeofencesResponseTypeDef:  # (2)
    ...

1. See Sequence[DevicePositionUpdateTypeDef]
2. See BatchEvaluateGeofencesResponseTypeDef

# batch_evaluate_geofences method usage example with argument unpacking

kwargs: BatchEvaluateGeofencesRequestTypeDef = {  # (1)
    "CollectionName": ...,
    "DevicePositionUpdates": ...,
}

parent.batch_evaluate_geofences(**kwargs)

1. See BatchEvaluateGeofencesRequestTypeDef

batch_get_device_position

Lists the latest device positions for requested devices.

Type annotations and code completion for boto3.client("location").batch_get_device_position method. boto3 documentation

# batch_get_device_position method definition

def batch_get_device_position(
    self,
    *,
    TrackerName: str,
    DeviceIds: Sequence[str],
) -> BatchGetDevicePositionResponseTypeDef:  # (1)
    ...

1. See BatchGetDevicePositionResponseTypeDef

# batch_get_device_position method usage example with argument unpacking

kwargs: BatchGetDevicePositionRequestTypeDef = {  # (1)
    "TrackerName": ...,
    "DeviceIds": ...,
}

parent.batch_get_device_position(**kwargs)

1. See BatchGetDevicePositionRequestTypeDef

batch_put_geofence

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.

Type annotations and code completion for boto3.client("location").batch_put_geofence method. boto3 documentation

# batch_put_geofence method definition

def batch_put_geofence(
    self,
    *,
    CollectionName: str,
    Entries: Sequence[BatchPutGeofenceRequestEntryTypeDef],  # (1)
) -> BatchPutGeofenceResponseTypeDef:  # (2)
    ...

1. See Sequence[BatchPutGeofenceRequestEntryTypeDef]
2. See BatchPutGeofenceResponseTypeDef

# batch_put_geofence method usage example with argument unpacking

kwargs: BatchPutGeofenceRequestTypeDef = {  # (1)
    "CollectionName": ...,
    "Entries": ...,
}

parent.batch_put_geofence(**kwargs)

1. See BatchPutGeofenceRequestTypeDef

batch_update_device_position

Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch).

Type annotations and code completion for boto3.client("location").batch_update_device_position method. boto3 documentation

# batch_update_device_position method definition

def batch_update_device_position(
    self,
    *,
    TrackerName: str,
    Updates: Sequence[DevicePositionUpdateTypeDef],  # (1)
) -> BatchUpdateDevicePositionResponseTypeDef:  # (2)
    ...

1. See Sequence[DevicePositionUpdateTypeDef]
2. See BatchUpdateDevicePositionResponseTypeDef

# batch_update_device_position method usage example with argument unpacking

kwargs: BatchUpdateDevicePositionRequestTypeDef = {  # (1)
    "TrackerName": ...,
    "Updates": ...,
}

parent.batch_update_device_position(**kwargs)

1. See BatchUpdateDevicePositionRequestTypeDef

calculate_route

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").calculate_route method. boto3 documentation

# calculate_route method definition

def calculate_route(
    self,
    *,
    CalculatorName: str,
    DeparturePosition: Sequence[float],
    DestinationPosition: Sequence[float],
    WaypointPositions: Sequence[Sequence[float]] = ...,
    TravelMode: TravelModeType = ...,  # (1)
    DepartureTime: TimestampTypeDef = ...,
    DepartNow: bool = ...,
    DistanceUnit: DistanceUnitType = ...,  # (2)
    IncludeLegGeometry: bool = ...,
    CarModeOptions: CalculateRouteCarModeOptionsTypeDef = ...,  # (3)
    TruckModeOptions: CalculateRouteTruckModeOptionsTypeDef = ...,  # (4)
    ArrivalTime: TimestampTypeDef = ...,
    OptimizeFor: OptimizationModeType = ...,  # (5)
    Key: str = ...,
) -> CalculateRouteResponseTypeDef:  # (6)
    ...

1. See TravelModeType
2. See DistanceUnitType
3. See CalculateRouteCarModeOptionsTypeDef
4. See CalculateRouteTruckModeOptionsTypeDef
5. See OptimizationModeType
6. See CalculateRouteResponseTypeDef

# calculate_route method usage example with argument unpacking

kwargs: CalculateRouteRequestTypeDef = {  # (1)
    "CalculatorName": ...,
    "DeparturePosition": ...,
    "DestinationPosition": ...,
}

parent.calculate_route(**kwargs)

1. See CalculateRouteRequestTypeDef

calculate_route_matrix

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").calculate_route_matrix method. boto3 documentation

# calculate_route_matrix method definition

def calculate_route_matrix(
    self,
    *,
    CalculatorName: str,
    DeparturePositions: Sequence[Sequence[float]],
    DestinationPositions: Sequence[Sequence[float]],
    TravelMode: TravelModeType = ...,  # (1)
    DepartureTime: TimestampTypeDef = ...,
    DepartNow: bool = ...,
    DistanceUnit: DistanceUnitType = ...,  # (2)
    CarModeOptions: CalculateRouteCarModeOptionsTypeDef = ...,  # (3)
    TruckModeOptions: CalculateRouteTruckModeOptionsTypeDef = ...,  # (4)
    Key: str = ...,
) -> CalculateRouteMatrixResponseTypeDef:  # (5)
    ...

1. See TravelModeType
2. See DistanceUnitType
3. See CalculateRouteCarModeOptionsTypeDef
4. See CalculateRouteTruckModeOptionsTypeDef
5. See CalculateRouteMatrixResponseTypeDef

# calculate_route_matrix method usage example with argument unpacking

kwargs: CalculateRouteMatrixRequestTypeDef = {  # (1)
    "CalculatorName": ...,
    "DeparturePositions": ...,
    "DestinationPositions": ...,
}

parent.calculate_route_matrix(**kwargs)

1. See CalculateRouteMatrixRequestTypeDef

create_geofence_collection

Creates a geofence collection, which manages and stores geofences.

Type annotations and code completion for boto3.client("location").create_geofence_collection method. boto3 documentation

# create_geofence_collection method definition

def create_geofence_collection(
    self,
    *,
    CollectionName: str,
    PricingPlan: PricingPlanType = ...,  # (1)
    PricingPlanDataSource: str = ...,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
    KmsKeyId: str = ...,
) -> CreateGeofenceCollectionResponseTypeDef:  # (2)
    ...

1. See PricingPlanType
2. See CreateGeofenceCollectionResponseTypeDef

# create_geofence_collection method usage example with argument unpacking

kwargs: CreateGeofenceCollectionRequestTypeDef = {  # (1)
    "CollectionName": ...,
}

parent.create_geofence_collection(**kwargs)

1. See CreateGeofenceCollectionRequestTypeDef

create_key

Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer.

Type annotations and code completion for boto3.client("location").create_key method. boto3 documentation

# create_key method definition

def create_key(
    self,
    *,
    KeyName: str,
    Restrictions: ApiKeyRestrictionsUnionTypeDef,  # (1)
    Description: str = ...,
    ExpireTime: TimestampTypeDef = ...,
    NoExpiry: bool = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateKeyResponseTypeDef:  # (2)
    ...

1. See ApiKeyRestrictionsUnionTypeDef
2. See CreateKeyResponseTypeDef

# create_key method usage example with argument unpacking

kwargs: CreateKeyRequestTypeDef = {  # (1)
    "KeyName": ...,
    "Restrictions": ...,
}

parent.create_key(**kwargs)

1. See CreateKeyRequestTypeDef

create_map

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").create_map method. boto3 documentation

# create_map method definition

def create_map(
    self,
    *,
    MapName: str,
    Configuration: MapConfigurationUnionTypeDef,  # (1)
    PricingPlan: PricingPlanType = ...,  # (2)
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateMapResponseTypeDef:  # (3)
    ...

1. See MapConfigurationUnionTypeDef
2. See PricingPlanType
3. See CreateMapResponseTypeDef

# create_map method usage example with argument unpacking

kwargs: CreateMapRequestTypeDef = {  # (1)
    "MapName": ...,
    "Configuration": ...,
}

parent.create_map(**kwargs)

1. See CreateMapRequestTypeDef

create_place_index

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").create_place_index method. boto3 documentation

# create_place_index method definition

def create_place_index(
    self,
    *,
    IndexName: str,
    DataSource: str,
    PricingPlan: PricingPlanType = ...,  # (1)
    Description: str = ...,
    DataSourceConfiguration: DataSourceConfigurationTypeDef = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> CreatePlaceIndexResponseTypeDef:  # (3)
    ...

1. See PricingPlanType
2. See DataSourceConfigurationTypeDef
3. See CreatePlaceIndexResponseTypeDef

# create_place_index method usage example with argument unpacking

kwargs: CreatePlaceIndexRequestTypeDef = {  # (1)
    "IndexName": ...,
    "DataSource": ...,
}

parent.create_place_index(**kwargs)

1. See CreatePlaceIndexRequestTypeDef

create_route_calculator

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").create_route_calculator method. boto3 documentation

# create_route_calculator method definition

def create_route_calculator(
    self,
    *,
    CalculatorName: str,
    DataSource: str,
    PricingPlan: PricingPlanType = ...,  # (1)
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateRouteCalculatorResponseTypeDef:  # (2)
    ...

1. See PricingPlanType
2. See CreateRouteCalculatorResponseTypeDef

# create_route_calculator method usage example with argument unpacking

kwargs: CreateRouteCalculatorRequestTypeDef = {  # (1)
    "CalculatorName": ...,
    "DataSource": ...,
}

parent.create_route_calculator(**kwargs)

1. See CreateRouteCalculatorRequestTypeDef

create_tracker

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

Type annotations and code completion for boto3.client("location").create_tracker method. boto3 documentation

# create_tracker method definition

def create_tracker(
    self,
    *,
    TrackerName: str,
    PricingPlan: PricingPlanType = ...,  # (1)
    KmsKeyId: str = ...,
    PricingPlanDataSource: str = ...,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
    PositionFiltering: PositionFilteringType = ...,  # (2)
    EventBridgeEnabled: bool = ...,
    KmsKeyEnableGeospatialQueries: bool = ...,
) -> CreateTrackerResponseTypeDef:  # (3)
    ...

1. See PricingPlanType
2. See PositionFilteringType
3. See CreateTrackerResponseTypeDef

# create_tracker method usage example with argument unpacking

kwargs: CreateTrackerRequestTypeDef = {  # (1)
    "TrackerName": ...,
}

parent.create_tracker(**kwargs)

1. See CreateTrackerRequestTypeDef

delete_geofence_collection

Deletes a geofence collection from your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").delete_geofence_collection method. boto3 documentation

# delete_geofence_collection method definition

def delete_geofence_collection(
    self,
    *,
    CollectionName: str,
) -> Dict[str, Any]:
    ...

# delete_geofence_collection method usage example with argument unpacking

kwargs: DeleteGeofenceCollectionRequestTypeDef = {  # (1)
    "CollectionName": ...,
}

parent.delete_geofence_collection(**kwargs)

1. See DeleteGeofenceCollectionRequestTypeDef

delete_key

Deletes the specified API key.

Type annotations and code completion for boto3.client("location").delete_key method. boto3 documentation

# delete_key method definition

def delete_key(
    self,
    *,
    KeyName: str,
    ForceDelete: bool = ...,
) -> Dict[str, Any]:
    ...

# delete_key method usage example with argument unpacking

kwargs: DeleteKeyRequestTypeDef = {  # (1)
    "KeyName": ...,
}

parent.delete_key(**kwargs)

1. See DeleteKeyRequestTypeDef

delete_map

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").delete_map method. boto3 documentation

# delete_map method definition

def delete_map(
    self,
    *,
    MapName: str,
) -> Dict[str, Any]:
    ...

# delete_map method usage example with argument unpacking

kwargs: DeleteMapRequestTypeDef = {  # (1)
    "MapName": ...,
}

parent.delete_map(**kwargs)

1. See DeleteMapRequestTypeDef

delete_place_index

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").delete_place_index method. boto3 documentation

# delete_place_index method definition

def delete_place_index(
    self,
    *,
    IndexName: str,
) -> Dict[str, Any]:
    ...

# delete_place_index method usage example with argument unpacking

kwargs: DeletePlaceIndexRequestTypeDef = {  # (1)
    "IndexName": ...,
}

parent.delete_place_index(**kwargs)

1. See DeletePlaceIndexRequestTypeDef

delete_route_calculator

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").delete_route_calculator method. boto3 documentation

# delete_route_calculator method definition

def delete_route_calculator(
    self,
    *,
    CalculatorName: str,
) -> Dict[str, Any]:
    ...

# delete_route_calculator method usage example with argument unpacking

kwargs: DeleteRouteCalculatorRequestTypeDef = {  # (1)
    "CalculatorName": ...,
}

parent.delete_route_calculator(**kwargs)

1. See DeleteRouteCalculatorRequestTypeDef

delete_tracker

Deletes a tracker resource from your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").delete_tracker method. boto3 documentation

# delete_tracker method definition

def delete_tracker(
    self,
    *,
    TrackerName: str,
) -> Dict[str, Any]:
    ...

# delete_tracker method usage example with argument unpacking

kwargs: DeleteTrackerRequestTypeDef = {  # (1)
    "TrackerName": ...,
}

parent.delete_tracker(**kwargs)

1. See DeleteTrackerRequestTypeDef

describe_geofence_collection

Retrieves the geofence collection details.

Type annotations and code completion for boto3.client("location").describe_geofence_collection method. boto3 documentation

# describe_geofence_collection method definition

def describe_geofence_collection(
    self,
    *,
    CollectionName: str,
) -> DescribeGeofenceCollectionResponseTypeDef:  # (1)
    ...

1. See DescribeGeofenceCollectionResponseTypeDef

# describe_geofence_collection method usage example with argument unpacking

kwargs: DescribeGeofenceCollectionRequestTypeDef = {  # (1)
    "CollectionName": ...,
}

parent.describe_geofence_collection(**kwargs)

1. See DescribeGeofenceCollectionRequestTypeDef

describe_key

Retrieves the API key resource details.

Type annotations and code completion for boto3.client("location").describe_key method. boto3 documentation

# describe_key method definition

def describe_key(
    self,
    *,
    KeyName: str,
) -> DescribeKeyResponseTypeDef:  # (1)
    ...

1. See DescribeKeyResponseTypeDef

# describe_key method usage example with argument unpacking

kwargs: DescribeKeyRequestTypeDef = {  # (1)
    "KeyName": ...,
}

parent.describe_key(**kwargs)

1. See DescribeKeyRequestTypeDef

describe_map

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").describe_map method. boto3 documentation

# describe_map method definition

def describe_map(
    self,
    *,
    MapName: str,
) -> DescribeMapResponseTypeDef:  # (1)
    ...

1. See DescribeMapResponseTypeDef

# describe_map method usage example with argument unpacking

kwargs: DescribeMapRequestTypeDef = {  # (1)
    "MapName": ...,
}

parent.describe_map(**kwargs)

1. See DescribeMapRequestTypeDef

describe_place_index

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").describe_place_index method. boto3 documentation

# describe_place_index method definition

def describe_place_index(
    self,
    *,
    IndexName: str,
) -> DescribePlaceIndexResponseTypeDef:  # (1)
    ...

1. See DescribePlaceIndexResponseTypeDef

# describe_place_index method usage example with argument unpacking

kwargs: DescribePlaceIndexRequestTypeDef = {  # (1)
    "IndexName": ...,
}

parent.describe_place_index(**kwargs)

1. See DescribePlaceIndexRequestTypeDef

describe_route_calculator

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").describe_route_calculator method. boto3 documentation

# describe_route_calculator method definition

def describe_route_calculator(
    self,
    *,
    CalculatorName: str,
) -> DescribeRouteCalculatorResponseTypeDef:  # (1)
    ...

1. See DescribeRouteCalculatorResponseTypeDef

# describe_route_calculator method usage example with argument unpacking

kwargs: DescribeRouteCalculatorRequestTypeDef = {  # (1)
    "CalculatorName": ...,
}

parent.describe_route_calculator(**kwargs)

1. See DescribeRouteCalculatorRequestTypeDef

describe_tracker

Retrieves the tracker resource details.

Type annotations and code completion for boto3.client("location").describe_tracker method. boto3 documentation

# describe_tracker method definition

def describe_tracker(
    self,
    *,
    TrackerName: str,
) -> DescribeTrackerResponseTypeDef:  # (1)
    ...

1. See DescribeTrackerResponseTypeDef

# describe_tracker method usage example with argument unpacking

kwargs: DescribeTrackerRequestTypeDef = {  # (1)
    "TrackerName": ...,
}

parent.describe_tracker(**kwargs)

1. See DescribeTrackerRequestTypeDef

disassociate_tracker_consumer

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

Type annotations and code completion for boto3.client("location").disassociate_tracker_consumer method. boto3 documentation

# disassociate_tracker_consumer method definition

def disassociate_tracker_consumer(
    self,
    *,
    TrackerName: str,
    ConsumerArn: str,
) -> Dict[str, Any]:
    ...

# disassociate_tracker_consumer method usage example with argument unpacking

kwargs: DisassociateTrackerConsumerRequestTypeDef = {  # (1)
    "TrackerName": ...,
    "ConsumerArn": ...,
}

parent.disassociate_tracker_consumer(**kwargs)

1. See DisassociateTrackerConsumerRequestTypeDef

forecast_geofence_events

This action forecasts future geofence events that are likely to occur within a specified time horizon if a device continues moving at its current speed.

Type annotations and code completion for boto3.client("location").forecast_geofence_events method. boto3 documentation

# forecast_geofence_events method definition

def forecast_geofence_events(
    self,
    *,
    CollectionName: str,
    DeviceState: ForecastGeofenceEventsDeviceStateTypeDef,  # (1)
    TimeHorizonMinutes: float = ...,
    DistanceUnit: DistanceUnitType = ...,  # (2)
    SpeedUnit: SpeedUnitType = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ForecastGeofenceEventsResponseTypeDef:  # (4)
    ...

1. See ForecastGeofenceEventsDeviceStateTypeDef
2. See DistanceUnitType
3. See SpeedUnitType
4. See ForecastGeofenceEventsResponseTypeDef

# forecast_geofence_events method usage example with argument unpacking

kwargs: ForecastGeofenceEventsRequestTypeDef = {  # (1)
    "CollectionName": ...,
    "DeviceState": ...,
}

parent.forecast_geofence_events(**kwargs)

1. See ForecastGeofenceEventsRequestTypeDef

get_device_position

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

Type annotations and code completion for boto3.client("location").get_device_position method. boto3 documentation

# get_device_position method definition

def get_device_position(
    self,
    *,
    TrackerName: str,
    DeviceId: str,
) -> GetDevicePositionResponseTypeDef:  # (1)
    ...

1. See GetDevicePositionResponseTypeDef

# get_device_position method usage example with argument unpacking

kwargs: GetDevicePositionRequestTypeDef = {  # (1)
    "TrackerName": ...,
    "DeviceId": ...,
}

parent.get_device_position(**kwargs)

1. See GetDevicePositionRequestTypeDef

get_device_position_history

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

Type annotations and code completion for boto3.client("location").get_device_position_history method. boto3 documentation

# get_device_position_history method definition

def get_device_position_history(
    self,
    *,
    TrackerName: str,
    DeviceId: str,
    NextToken: str = ...,
    StartTimeInclusive: TimestampTypeDef = ...,
    EndTimeExclusive: TimestampTypeDef = ...,
    MaxResults: int = ...,
) -> GetDevicePositionHistoryResponseTypeDef:  # (1)
    ...

1. See GetDevicePositionHistoryResponseTypeDef

# get_device_position_history method usage example with argument unpacking

kwargs: GetDevicePositionHistoryRequestTypeDef = {  # (1)
    "TrackerName": ...,
    "DeviceId": ...,
}

parent.get_device_position_history(**kwargs)

1. See GetDevicePositionHistoryRequestTypeDef

get_geofence

Retrieves the geofence details from a geofence collection.

Type annotations and code completion for boto3.client("location").get_geofence method. boto3 documentation

# get_geofence method definition

def get_geofence(
    self,
    *,
    CollectionName: str,
    GeofenceId: str,
) -> GetGeofenceResponseTypeDef:  # (1)
    ...

1. See GetGeofenceResponseTypeDef

# get_geofence method usage example with argument unpacking

kwargs: GetGeofenceRequestTypeDef = {  # (1)
    "CollectionName": ...,
    "GeofenceId": ...,
}

parent.get_geofence(**kwargs)

1. See GetGeofenceRequestTypeDef

get_map_glyphs

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").get_map_glyphs method. boto3 documentation

# get_map_glyphs method definition

def get_map_glyphs(
    self,
    *,
    MapName: str,
    FontStack: str,
    FontUnicodeRange: str,
    Key: str = ...,
) -> GetMapGlyphsResponseTypeDef:  # (1)
    ...

1. See GetMapGlyphsResponseTypeDef

# get_map_glyphs method usage example with argument unpacking

kwargs: GetMapGlyphsRequestTypeDef = {  # (1)
    "MapName": ...,
    "FontStack": ...,
    "FontUnicodeRange": ...,
}

parent.get_map_glyphs(**kwargs)

1. See GetMapGlyphsRequestTypeDef

get_map_sprites

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").get_map_sprites method. boto3 documentation

# get_map_sprites method definition

def get_map_sprites(
    self,
    *,
    MapName: str,
    FileName: str,
    Key: str = ...,
) -> GetMapSpritesResponseTypeDef:  # (1)
    ...

1. See GetMapSpritesResponseTypeDef

# get_map_sprites method usage example with argument unpacking

kwargs: GetMapSpritesRequestTypeDef = {  # (1)
    "MapName": ...,
    "FileName": ...,
}

parent.get_map_sprites(**kwargs)

1. See GetMapSpritesRequestTypeDef

get_map_style_descriptor

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").get_map_style_descriptor method. boto3 documentation

# get_map_style_descriptor method definition

def get_map_style_descriptor(
    self,
    *,
    MapName: str,
    Key: str = ...,
) -> GetMapStyleDescriptorResponseTypeDef:  # (1)
    ...

1. See GetMapStyleDescriptorResponseTypeDef

# get_map_style_descriptor method usage example with argument unpacking

kwargs: GetMapStyleDescriptorRequestTypeDef = {  # (1)
    "MapName": ...,
}

parent.get_map_style_descriptor(**kwargs)

1. See GetMapStyleDescriptorRequestTypeDef

get_map_tile

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").get_map_tile method. boto3 documentation

# get_map_tile method definition

def get_map_tile(
    self,
    *,
    MapName: str,
    Z: str,
    X: str,
    Y: str,
    Key: str = ...,
) -> GetMapTileResponseTypeDef:  # (1)
    ...

1. See GetMapTileResponseTypeDef

# get_map_tile method usage example with argument unpacking

kwargs: GetMapTileRequestTypeDef = {  # (1)
    "MapName": ...,
    "Z": ...,
    "X": ...,
    "Y": ...,
}

parent.get_map_tile(**kwargs)

1. See GetMapTileRequestTypeDef

get_place

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").get_place method. boto3 documentation

# get_place method definition

def get_place(
    self,
    *,
    IndexName: str,
    PlaceId: str,
    Language: str = ...,
    Key: str = ...,
) -> GetPlaceResponseTypeDef:  # (1)
    ...

1. See GetPlaceResponseTypeDef

# get_place method usage example with argument unpacking

kwargs: GetPlaceRequestTypeDef = {  # (1)
    "IndexName": ...,
    "PlaceId": ...,
}

parent.get_place(**kwargs)

1. See GetPlaceRequestTypeDef

list_device_positions

A batch request to retrieve all device positions.

Type annotations and code completion for boto3.client("location").list_device_positions method. boto3 documentation

# list_device_positions method definition

def list_device_positions(
    self,
    *,
    TrackerName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    FilterGeometry: TrackingFilterGeometryTypeDef = ...,  # (1)
) -> ListDevicePositionsResponseTypeDef:  # (2)
    ...

1. See TrackingFilterGeometryTypeDef
2. See ListDevicePositionsResponseTypeDef

# list_device_positions method usage example with argument unpacking

kwargs: ListDevicePositionsRequestTypeDef = {  # (1)
    "TrackerName": ...,
}

parent.list_device_positions(**kwargs)

1. See ListDevicePositionsRequestTypeDef

list_geofence_collections

Lists geofence collections in your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").list_geofence_collections method. boto3 documentation

# list_geofence_collections method definition

def list_geofence_collections(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListGeofenceCollectionsResponseTypeDef:  # (1)
    ...

1. See ListGeofenceCollectionsResponseTypeDef

# list_geofence_collections method usage example with argument unpacking

kwargs: ListGeofenceCollectionsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_geofence_collections(**kwargs)

1. See ListGeofenceCollectionsRequestTypeDef

list_geofences

Lists geofences stored in a given geofence collection.

Type annotations and code completion for boto3.client("location").list_geofences method. boto3 documentation

# list_geofences method definition

def list_geofences(
    self,
    *,
    CollectionName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListGeofencesResponseTypeDef:  # (1)
    ...

1. See ListGeofencesResponseTypeDef

# list_geofences method usage example with argument unpacking

kwargs: ListGeofencesRequestTypeDef = {  # (1)
    "CollectionName": ...,
}

parent.list_geofences(**kwargs)

1. See ListGeofencesRequestTypeDef

list_keys

Lists API key resources in your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").list_keys method. boto3 documentation

# list_keys method definition

def list_keys(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filter: ApiKeyFilterTypeDef = ...,  # (1)
) -> ListKeysResponseTypeDef:  # (2)
    ...

1. See ApiKeyFilterTypeDef
2. See ListKeysResponseTypeDef

# list_keys method usage example with argument unpacking

kwargs: ListKeysRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_keys(**kwargs)

1. See ListKeysRequestTypeDef

list_maps

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").list_maps method. boto3 documentation

# list_maps method definition

def list_maps(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListMapsResponseTypeDef:  # (1)
    ...

1. See ListMapsResponseTypeDef

# list_maps method usage example with argument unpacking

kwargs: ListMapsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_maps(**kwargs)

1. See ListMapsRequestTypeDef

list_place_indexes

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").list_place_indexes method. boto3 documentation

# list_place_indexes method definition

def list_place_indexes(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPlaceIndexesResponseTypeDef:  # (1)
    ...

1. See ListPlaceIndexesResponseTypeDef

# list_place_indexes method usage example with argument unpacking

kwargs: ListPlaceIndexesRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_place_indexes(**kwargs)

1. See ListPlaceIndexesRequestTypeDef

list_route_calculators

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").list_route_calculators method. boto3 documentation

# list_route_calculators method definition

def list_route_calculators(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRouteCalculatorsResponseTypeDef:  # (1)
    ...

1. See ListRouteCalculatorsResponseTypeDef

# list_route_calculators method usage example with argument unpacking

kwargs: ListRouteCalculatorsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_route_calculators(**kwargs)

1. See ListRouteCalculatorsRequestTypeDef

list_tags_for_resource

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

Type annotations and code completion for boto3.client("location").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

list_tracker_consumers

Lists geofence collections currently associated to the given tracker resource.

Type annotations and code completion for boto3.client("location").list_tracker_consumers method. boto3 documentation

# list_tracker_consumers method definition

def list_tracker_consumers(
    self,
    *,
    TrackerName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTrackerConsumersResponseTypeDef:  # (1)
    ...

1. See ListTrackerConsumersResponseTypeDef

# list_tracker_consumers method usage example with argument unpacking

kwargs: ListTrackerConsumersRequestTypeDef = {  # (1)
    "TrackerName": ...,
}

parent.list_tracker_consumers(**kwargs)

1. See ListTrackerConsumersRequestTypeDef

list_trackers

Lists tracker resources in your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").list_trackers method. boto3 documentation

# list_trackers method definition

def list_trackers(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTrackersResponseTypeDef:  # (1)
    ...

1. See ListTrackersResponseTypeDef

# list_trackers method usage example with argument unpacking

kwargs: ListTrackersRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_trackers(**kwargs)

1. See ListTrackersRequestTypeDef

put_geofence

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.

Type annotations and code completion for boto3.client("location").put_geofence method. boto3 documentation

# put_geofence method definition

def put_geofence(
    self,
    *,
    CollectionName: str,
    GeofenceId: str,
    Geometry: GeofenceGeometryUnionTypeDef,  # (1)
    GeofenceProperties: Mapping[str, str] = ...,
) -> PutGeofenceResponseTypeDef:  # (2)
    ...

1. See GeofenceGeometryUnionTypeDef
2. See PutGeofenceResponseTypeDef

# put_geofence method usage example with argument unpacking

kwargs: PutGeofenceRequestTypeDef = {  # (1)
    "CollectionName": ...,
    "GeofenceId": ...,
    "Geometry": ...,
}

parent.put_geofence(**kwargs)

1. See PutGeofenceRequestTypeDef

search_place_index_for_position

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").search_place_index_for_position method. boto3 documentation

# search_place_index_for_position method definition

def search_place_index_for_position(
    self,
    *,
    IndexName: str,
    Position: Sequence[float],
    MaxResults: int = ...,
    Language: str = ...,
    Key: str = ...,
) -> SearchPlaceIndexForPositionResponseTypeDef:  # (1)
    ...

1. See SearchPlaceIndexForPositionResponseTypeDef

# search_place_index_for_position method usage example with argument unpacking

kwargs: SearchPlaceIndexForPositionRequestTypeDef = {  # (1)
    "IndexName": ...,
    "Position": ...,
}

parent.search_place_index_for_position(**kwargs)

1. See SearchPlaceIndexForPositionRequestTypeDef

search_place_index_for_suggestions

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").search_place_index_for_suggestions method. boto3 documentation

# search_place_index_for_suggestions method definition

def search_place_index_for_suggestions(
    self,
    *,
    IndexName: str,
    Text: str,
    BiasPosition: Sequence[float] = ...,
    FilterBBox: Sequence[float] = ...,
    FilterCountries: Sequence[str] = ...,
    MaxResults: int = ...,
    Language: str = ...,
    FilterCategories: Sequence[str] = ...,
    Key: str = ...,
) -> SearchPlaceIndexForSuggestionsResponseTypeDef:  # (1)
    ...

1. See SearchPlaceIndexForSuggestionsResponseTypeDef

# search_place_index_for_suggestions method usage example with argument unpacking

kwargs: SearchPlaceIndexForSuggestionsRequestTypeDef = {  # (1)
    "IndexName": ...,
    "Text": ...,
}

parent.search_place_index_for_suggestions(**kwargs)

1. See SearchPlaceIndexForSuggestionsRequestTypeDef

search_place_index_for_text

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").search_place_index_for_text method. boto3 documentation

# search_place_index_for_text method definition

def search_place_index_for_text(
    self,
    *,
    IndexName: str,
    Text: str,
    BiasPosition: Sequence[float] = ...,
    FilterBBox: Sequence[float] = ...,
    FilterCountries: Sequence[str] = ...,
    MaxResults: int = ...,
    Language: str = ...,
    FilterCategories: Sequence[str] = ...,
    Key: str = ...,
) -> SearchPlaceIndexForTextResponseTypeDef:  # (1)
    ...

1. See SearchPlaceIndexForTextResponseTypeDef

# search_place_index_for_text method usage example with argument unpacking

kwargs: SearchPlaceIndexForTextRequestTypeDef = {  # (1)
    "IndexName": ...,
    "Text": ...,
}

parent.search_place_index_for_text(**kwargs)

1. See SearchPlaceIndexForTextRequestTypeDef

tag_resource

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

Type annotations and code completion for boto3.client("location").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

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

Type annotations and code completion for boto3.client("location").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_geofence_collection

Updates the specified properties of a given geofence collection.

Type annotations and code completion for boto3.client("location").update_geofence_collection method. boto3 documentation

# update_geofence_collection method definition

def update_geofence_collection(
    self,
    *,
    CollectionName: str,
    PricingPlan: PricingPlanType = ...,  # (1)
    PricingPlanDataSource: str = ...,
    Description: str = ...,
) -> UpdateGeofenceCollectionResponseTypeDef:  # (2)
    ...

1. See PricingPlanType
2. See UpdateGeofenceCollectionResponseTypeDef

# update_geofence_collection method usage example with argument unpacking

kwargs: UpdateGeofenceCollectionRequestTypeDef = {  # (1)
    "CollectionName": ...,
}

parent.update_geofence_collection(**kwargs)

1. See UpdateGeofenceCollectionRequestTypeDef

update_key

Updates the specified properties of a given API key resource.

Type annotations and code completion for boto3.client("location").update_key method. boto3 documentation

# update_key method definition

def update_key(
    self,
    *,
    KeyName: str,
    Description: str = ...,
    ExpireTime: TimestampTypeDef = ...,
    NoExpiry: bool = ...,
    ForceUpdate: bool = ...,
    Restrictions: ApiKeyRestrictionsUnionTypeDef = ...,  # (1)
) -> UpdateKeyResponseTypeDef:  # (2)
    ...

1. See ApiKeyRestrictionsUnionTypeDef
2. See UpdateKeyResponseTypeDef

# update_key method usage example with argument unpacking

kwargs: UpdateKeyRequestTypeDef = {  # (1)
    "KeyName": ...,
}

parent.update_key(**kwargs)

1. See UpdateKeyRequestTypeDef

update_map

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").update_map method. boto3 documentation

# update_map method definition

def update_map(
    self,
    *,
    MapName: str,
    PricingPlan: PricingPlanType = ...,  # (1)
    Description: str = ...,
    ConfigurationUpdate: MapConfigurationUpdateTypeDef = ...,  # (2)
) -> UpdateMapResponseTypeDef:  # (3)
    ...

1. See PricingPlanType
2. See MapConfigurationUpdateTypeDef
3. See UpdateMapResponseTypeDef

# update_map method usage example with argument unpacking

kwargs: UpdateMapRequestTypeDef = {  # (1)
    "MapName": ...,
}

parent.update_map(**kwargs)

1. See UpdateMapRequestTypeDef

update_place_index

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").update_place_index method. boto3 documentation

# update_place_index method definition

def update_place_index(
    self,
    *,
    IndexName: str,
    PricingPlan: PricingPlanType = ...,  # (1)
    Description: str = ...,
    DataSourceConfiguration: DataSourceConfigurationTypeDef = ...,  # (2)
) -> UpdatePlaceIndexResponseTypeDef:  # (3)
    ...

1. See PricingPlanType
2. See DataSourceConfigurationTypeDef
3. See UpdatePlaceIndexResponseTypeDef

# update_place_index method usage example with argument unpacking

kwargs: UpdatePlaceIndexRequestTypeDef = {  # (1)
    "IndexName": ...,
}

parent.update_place_index(**kwargs)

1. See UpdatePlaceIndexRequestTypeDef

update_route_calculator

This operation is no longer current and may be deprecated in the future.

Type annotations and code completion for boto3.client("location").update_route_calculator method. boto3 documentation

# update_route_calculator method definition

def update_route_calculator(
    self,
    *,
    CalculatorName: str,
    PricingPlan: PricingPlanType = ...,  # (1)
    Description: str = ...,
) -> UpdateRouteCalculatorResponseTypeDef:  # (2)
    ...

1. See PricingPlanType
2. See UpdateRouteCalculatorResponseTypeDef

# update_route_calculator method usage example with argument unpacking

kwargs: UpdateRouteCalculatorRequestTypeDef = {  # (1)
    "CalculatorName": ...,
}

parent.update_route_calculator(**kwargs)

1. See UpdateRouteCalculatorRequestTypeDef

update_tracker

Updates the specified properties of a given tracker resource.

Type annotations and code completion for boto3.client("location").update_tracker method. boto3 documentation

# update_tracker method definition

def update_tracker(
    self,
    *,
    TrackerName: str,
    PricingPlan: PricingPlanType = ...,  # (1)
    PricingPlanDataSource: str = ...,
    Description: str = ...,
    PositionFiltering: PositionFilteringType = ...,  # (2)
    EventBridgeEnabled: bool = ...,
    KmsKeyEnableGeospatialQueries: bool = ...,
) -> UpdateTrackerResponseTypeDef:  # (3)
    ...

1. See PricingPlanType
2. See PositionFilteringType
3. See UpdateTrackerResponseTypeDef

# update_tracker method usage example with argument unpacking

kwargs: UpdateTrackerRequestTypeDef = {  # (1)
    "TrackerName": ...,
}

parent.update_tracker(**kwargs)

1. See UpdateTrackerRequestTypeDef

verify_device_position

Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state.

Type annotations and code completion for boto3.client("location").verify_device_position method. boto3 documentation

# verify_device_position method definition

def verify_device_position(
    self,
    *,
    TrackerName: str,
    DeviceState: DeviceStateTypeDef,  # (1)
    DistanceUnit: DistanceUnitType = ...,  # (2)
) -> VerifyDevicePositionResponseTypeDef:  # (3)
    ...

1. See DeviceStateTypeDef
2. See DistanceUnitType
3. See VerifyDevicePositionResponseTypeDef

# verify_device_position method usage example with argument unpacking

kwargs: VerifyDevicePositionRequestTypeDef = {  # (1)
    "TrackerName": ...,
    "DeviceState": ...,
}

parent.verify_device_position(**kwargs)

1. See VerifyDevicePositionRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("location").get_paginator method with overloads.

• client.get_paginator("forecast_geofence_events") -> ForecastGeofenceEventsPaginator
• client.get_paginator("get_device_position_history") -> GetDevicePositionHistoryPaginator
• client.get_paginator("list_device_positions") -> ListDevicePositionsPaginator
• client.get_paginator("list_geofence_collections") -> ListGeofenceCollectionsPaginator
• client.get_paginator("list_geofences") -> ListGeofencesPaginator
• client.get_paginator("list_keys") -> ListKeysPaginator
• client.get_paginator("list_maps") -> ListMapsPaginator
• client.get_paginator("list_place_indexes") -> ListPlaceIndexesPaginator
• client.get_paginator("list_route_calculators") -> ListRouteCalculatorsPaginator
• client.get_paginator("list_tracker_consumers") -> ListTrackerConsumersPaginator
• client.get_paginator("list_trackers") -> ListTrackersPaginator