ListMaps
Important
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.
-
ListMapsis 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-mapsorgeo_maps, not underlocation. -
Since
Grabis not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when usingGrab. -
Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide.
Lists map resources in your AWS account.
Request Syntax
POST /maps/v0/list-maps HTTP/1.1
Content-type: application/json
{
"MaxResults": number,
"NextToken": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- MaxResults
-
An optional limit for the number of resources returned in a single call.
Default value:
100Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
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:
nullType: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Entries": [
{
"CreateTime": "string",
"DataSource": "string",
"Description": "string",
"MapName": "string",
"PricingPlan": "string",
"UpdateTime": "string"
}
],
"NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Entries
-
Contains a list of maps in your AWS account
Type: Array of ListMapsResponseEntry objects
- NextToken
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
HTTP Status Code: 403
- InternalServerException
-
The request has failed to process because of an unknown server error, exception, or failure.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied because of request throttling.
HTTP Status Code: 429
- ValidationException
-
The input failed to meet the constraints specified by the AWS service.
- FieldList
-
The field where the invalid entry was detected.
- Reason
-
A message with the reason for the validation exception error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: