Managing your map resources
You can manage your map resources using the Amazon Location console, the AWS CLI, or the
Amazon Location APIs.
List map resources
You can view a list of your map resources using the Amazon Location console, the AWS CLI, or
the Amazon Location APIs.
- Console
-
To view a list of existing map resources using
the Amazon Location console
- API
-
Use the ListMaps
operation from the Amazon Location Maps
APIs.
The following example is an API request to get a list of map resources
in the AWS account.
POST /maps/v0/list-maps
The following is an example response for ListMaps
:
{
"Entries": [
{
"CreateTime": 2020-10-30T01:38:36Z,
"DataSource": "Esri",
"Description": "string",
"MapName": "ExampleMap
",
"UpdateTime": 2020-10-30T01:38:36Z
}
],
"NextToken": "1234-5678-9012"
}
- CLI
-
Use the list-map
command.
The following example is an AWS CLI to get a list of map resources in
the AWS account.
aws location list-maps
Get map resource details
You can get details about any map resource in your AWS account using the Amazon Location
console, the AWS CLI, or the Amazon Location APIs.
- Console
-
To view the details of a map resource using the
Amazon Location console
- API
-
Use the DescribeMap
operation from the Amazon Location Maps
APIs.
The following example is an API request to get the map resource
details for ExampleMap
.
GET /maps/v0/maps/ExampleMap
The following is an example response for DescribeMap
:
{
"Configuration": {
"Style": "VectorEsriNavigation"
},
"CreateTime": 2020-10-30T01:38:36Z,
"DataSource": "Esri",
"Description": "string",
"MapArn": "arn:aws:geo:us-west-2:123456789012:maps/ExampleMap",
"MapName": "ExampleMap
",
"Tags": {
"Tag1" : "Value1"
},
"UpdateTime": 2020-10-30T01:40:36Z
}
- CLI
-
Use the describe-map
command.
The following example is an AWS CLI to get the map resource details for
ExampleMap
.
aws location describe-map \
--map-name "ExampleMap
"
Delete a map resource
You can delete a map resource from your AWS account using the Amazon Location console, the
AWS CLI, or the Amazon Location APIs.
This operation deletes the resource permanently.
- Console
-
To delete an existing map resource using the
Amazon Location console
- API
-
Use the DeleteMap
operation from the Amazon Location Maps
APIs.
The following example is an API request to delete the map resource
ExampleMap
.
DELETE /maps/v0/maps/ExampleMap
The following is an example success response for DeleteMap
:
HTTP/1.1 200
- CLI
-
Use the delete-map
command.
The following example is an AWS CLI command to delete the map resource
ExampleMap
.
aws location delete-map \
--map-name "ExampleMap
"