LocationService / Paginator / ListGeofenceCollections

ListGeofenceCollections

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',
            'Description': 'string',
            'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
            'PricingPlanDataSource': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • Entries (list) –

    Lists the geofence collections that exist in your Amazon Web Services account.

    • (dict) –

      Contains the geofence collection details.

      Note

      The returned geometry will always match the geometry format used when the geofence was created.

      • CollectionName (string) –

        The name of the geofence collection.

      • Description (string) –

        The description for the geofence collection

      • PricingPlan (string) –

        No longer used. Always returns RequestBasedUsage.

      • PricingPlanDataSource (string) –

        No longer used. Always returns an empty string.

      • CreateTime (datetime) –

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

      • UpdateTime (datetime) –

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