Skip to content

LocationService module#

Index > LocationService

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

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and LocationService.

From PyPI with pip#

Install boto3-stubs for LocationService service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[location]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[location]'


# standalone installation
python -m pip install mypy-boto3-location

How to uninstall#

python -m pip uninstall -y mypy-boto3-location

Usage#

Code samples can be found in Examples.

LocationServiceClient#

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

# LocationServiceClient usage example

from boto3.session import Session

from mypy_boto3_location.client import LocationServiceClient

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

Paginators#

Type annotations and code completion for paginators from boto3.client("location").get_paginator("...").

# GetDevicePositionHistoryPaginator usage example

from boto3.session import Session

from mypy_boto3_location.paginator import GetDevicePositionHistoryPaginator

def get_get_device_position_history_paginator() -> GetDevicePositionHistoryPaginator:
    return Session().client("location").get_paginator("get_device_position_history"))

Literals#

Type annotations for literals used in methods and schemas.

# BatchItemErrorCodeType usage example

from mypy_boto3_location.literals import BatchItemErrorCodeType

def get_value() -> BatchItemErrorCodeType:
    return "AccessDeniedError"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# ApiKeyFilterTypeDef usage example

from mypy_boto3_location.type_defs import ApiKeyFilterTypeDef

def get_value() -> ApiKeyFilterTypeDef:
    return {
        "KeyStatus": ...,
    }