LocationService / Client / list_maps

list_maps

LocationService.Client.list_maps(**kwargs)

Warning

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

  • ListMaps is part of a previous Amazon Location Service Maps API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).

  • The Maps API version 2 has a simplified interface that can be used without creating or managing map resources.

  • If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under geo-maps or geo_maps, not under location.

  • Since Grab is not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when using Grab.

  • Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide.

Lists map resources in your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_maps(
    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': [
        {
            'MapName': 'string',
            'Description': 'string',
            'DataSource': 'string',
            'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
            'CreateTime': datetime(2015, 1, 1),
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Entries (list) –

      Contains a list of maps in your Amazon Web Services account

      • (dict) –

        Contains details of an existing map resource in your Amazon Web Services account.

        • MapName (string) –

          The name of the associated map resource.

        • Description (string) –

          The description for the map resource.

        • DataSource (string) –

          Specifies the data provider for the associated map tiles.

        • PricingPlan (string) –

          No longer used. Always returns RequestBasedUsage.

        • CreateTime (datetime) –

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

        • UpdateTime (datetime) –

          The timestamp for when the map 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