LocationService / Client / list_geofence_collections

list_geofence_collections#

LocationService.Client.list_geofence_collections(**kwargs)#

Lists geofence collections in your Amazon Web Services 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',
            'Description': 'string',
            'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
            'PricingPlanDataSource': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

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

    • 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