Skip to content

Paginators#

Index > LocationService > Paginators

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

ForecastGeofenceEventsPaginator#

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

# ForecastGeofenceEventsPaginator usage example

from boto3.session import Session

from mypy_boto3_location.paginator import ForecastGeofenceEventsPaginator

def get_forecast_geofence_events_paginator() -> ForecastGeofenceEventsPaginator:
    return Session().client("location").get_paginator("forecast_geofence_events")
# ForecastGeofenceEventsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_location.paginator import ForecastGeofenceEventsPaginator

session = Session()

client = Session().client("location")  # (1)
paginator: ForecastGeofenceEventsPaginator = client.get_paginator("forecast_geofence_events")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: LocationServiceClient
  2. paginator: ForecastGeofenceEventsPaginator
  3. item: ForecastGeofenceEventsResponseTypeDef

paginate#

Type annotations and code completion for ForecastGeofenceEventsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    CollectionName: str,
    DeviceState: ForecastGeofenceEventsDeviceStateTypeDef,  # (1)
    TimeHorizonMinutes: float = ...,
    DistanceUnit: DistanceUnitType = ...,  # (2)
    SpeedUnit: SpeedUnitType = ...,  # (3)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> _PageIterator[ForecastGeofenceEventsResponseTypeDef]:  # (5)
    ...
  1. See ForecastGeofenceEventsDeviceStateTypeDef
  2. See DistanceUnitType
  3. See SpeedUnitType
  4. See PaginatorConfigTypeDef
  5. See ForecastGeofenceEventsResponseTypeDef
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See ForecastGeofenceEventsRequestForecastGeofenceEventsPaginateTypeDef

GetDevicePositionHistoryPaginator#

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

# 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")
# GetDevicePositionHistoryPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_location.paginator import GetDevicePositionHistoryPaginator

session = Session()

client = Session().client("location")  # (1)
paginator: GetDevicePositionHistoryPaginator = client.get_paginator("get_device_position_history")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: LocationServiceClient
  2. paginator: GetDevicePositionHistoryPaginator
  3. item: GetDevicePositionHistoryResponseTypeDef

paginate#

Type annotations and code completion for GetDevicePositionHistoryPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    TrackerName: str,
    DeviceId: str,
    StartTimeInclusive: Union[datetime, str] = ...,
    EndTimeExclusive: Union[datetime, str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[GetDevicePositionHistoryResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See GetDevicePositionHistoryResponseTypeDef
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See GetDevicePositionHistoryRequestGetDevicePositionHistoryPaginateTypeDef

ListDevicePositionsPaginator#

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

# ListDevicePositionsPaginator usage example

from boto3.session import Session

from mypy_boto3_location.paginator import ListDevicePositionsPaginator

def get_list_device_positions_paginator() -> ListDevicePositionsPaginator:
    return Session().client("location").get_paginator("list_device_positions")
# ListDevicePositionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_location.paginator import ListDevicePositionsPaginator

session = Session()

client = Session().client("location")  # (1)
paginator: ListDevicePositionsPaginator = client.get_paginator("list_device_positions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: LocationServiceClient
  2. paginator: ListDevicePositionsPaginator
  3. item: ListDevicePositionsResponseTypeDef

paginate#

Type annotations and code completion for ListDevicePositionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    TrackerName: str,
    FilterGeometry: TrackingFilterGeometryTypeDef = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[ListDevicePositionsResponseTypeDef]:  # (3)
    ...
  1. See TrackingFilterGeometryTypeDef
  2. See PaginatorConfigTypeDef
  3. See ListDevicePositionsResponseTypeDef
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See ListDevicePositionsRequestListDevicePositionsPaginateTypeDef

ListGeofenceCollectionsPaginator#

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

# ListGeofenceCollectionsPaginator usage example

from boto3.session import Session

from mypy_boto3_location.paginator import ListGeofenceCollectionsPaginator

def get_list_geofence_collections_paginator() -> ListGeofenceCollectionsPaginator:
    return Session().client("location").get_paginator("list_geofence_collections")
# ListGeofenceCollectionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_location.paginator import ListGeofenceCollectionsPaginator

session = Session()

client = Session().client("location")  # (1)
paginator: ListGeofenceCollectionsPaginator = client.get_paginator("list_geofence_collections")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: LocationServiceClient
  2. paginator: ListGeofenceCollectionsPaginator
  3. item: ListGeofenceCollectionsResponseTypeDef

paginate#

Type annotations and code completion for ListGeofenceCollectionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListGeofenceCollectionsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListGeofenceCollectionsResponseTypeDef
# paginate method usage example with argument unpacking

kwargs: ListGeofenceCollectionsRequestListGeofenceCollectionsPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)
  1. See ListGeofenceCollectionsRequestListGeofenceCollectionsPaginateTypeDef

ListGeofencesPaginator#

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

# ListGeofencesPaginator usage example

from boto3.session import Session

from mypy_boto3_location.paginator import ListGeofencesPaginator

def get_list_geofences_paginator() -> ListGeofencesPaginator:
    return Session().client("location").get_paginator("list_geofences")
# ListGeofencesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_location.paginator import ListGeofencesPaginator

session = Session()

client = Session().client("location")  # (1)
paginator: ListGeofencesPaginator = client.get_paginator("list_geofences")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: LocationServiceClient
  2. paginator: ListGeofencesPaginator
  3. item: ListGeofencesResponseTypeDef

paginate#

Type annotations and code completion for ListGeofencesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    CollectionName: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListGeofencesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListGeofencesResponseTypeDef
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See ListGeofencesRequestListGeofencesPaginateTypeDef

ListKeysPaginator#

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

# ListKeysPaginator usage example

from boto3.session import Session

from mypy_boto3_location.paginator import ListKeysPaginator

def get_list_keys_paginator() -> ListKeysPaginator:
    return Session().client("location").get_paginator("list_keys")
# ListKeysPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_location.paginator import ListKeysPaginator

session = Session()

client = Session().client("location")  # (1)
paginator: ListKeysPaginator = client.get_paginator("list_keys")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: LocationServiceClient
  2. paginator: ListKeysPaginator
  3. item: ListKeysResponseTypeDef

paginate#

Type annotations and code completion for ListKeysPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Filter: ApiKeyFilterTypeDef = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[ListKeysResponseTypeDef]:  # (3)
    ...
  1. See ApiKeyFilterTypeDef
  2. See PaginatorConfigTypeDef
  3. See ListKeysResponseTypeDef
# paginate method usage example with argument unpacking

kwargs: ListKeysRequestListKeysPaginateTypeDef = {  # (1)
    "Filter": ...,
}

parent.paginate(**kwargs)
  1. See ListKeysRequestListKeysPaginateTypeDef

ListMapsPaginator#

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

# ListMapsPaginator usage example

from boto3.session import Session

from mypy_boto3_location.paginator import ListMapsPaginator

def get_list_maps_paginator() -> ListMapsPaginator:
    return Session().client("location").get_paginator("list_maps")
# ListMapsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_location.paginator import ListMapsPaginator

session = Session()

client = Session().client("location")  # (1)
paginator: ListMapsPaginator = client.get_paginator("list_maps")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: LocationServiceClient
  2. paginator: ListMapsPaginator
  3. item: ListMapsResponseTypeDef

paginate#

Type annotations and code completion for ListMapsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListMapsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListMapsResponseTypeDef
# paginate method usage example with argument unpacking

kwargs: ListMapsRequestListMapsPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)
  1. See ListMapsRequestListMapsPaginateTypeDef

ListPlaceIndexesPaginator#

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

# ListPlaceIndexesPaginator usage example

from boto3.session import Session

from mypy_boto3_location.paginator import ListPlaceIndexesPaginator

def get_list_place_indexes_paginator() -> ListPlaceIndexesPaginator:
    return Session().client("location").get_paginator("list_place_indexes")
# ListPlaceIndexesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_location.paginator import ListPlaceIndexesPaginator

session = Session()

client = Session().client("location")  # (1)
paginator: ListPlaceIndexesPaginator = client.get_paginator("list_place_indexes")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: LocationServiceClient
  2. paginator: ListPlaceIndexesPaginator
  3. item: ListPlaceIndexesResponseTypeDef

paginate#

Type annotations and code completion for ListPlaceIndexesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListPlaceIndexesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListPlaceIndexesResponseTypeDef
# paginate method usage example with argument unpacking

kwargs: ListPlaceIndexesRequestListPlaceIndexesPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)
  1. See ListPlaceIndexesRequestListPlaceIndexesPaginateTypeDef

ListRouteCalculatorsPaginator#

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