UpdateMapCommand

Suggest an Edit

Updates the specified properties of a given map resource.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { LocationClient, UpdateMapCommand } from "@aws-sdk/client-location"; // ES Modules import
// const { LocationClient, UpdateMapCommand } = require("@aws-sdk/client-location"); // CommonJS import
const client = new LocationClient(config);
const input = { // UpdateMapRequest
  MapName: "STRING_VALUE", // required
  PricingPlan: "STRING_VALUE",
  Description: "STRING_VALUE",
  ConfigurationUpdate: { // MapConfigurationUpdate
    PoliticalView: "STRING_VALUE",
    CustomLayers: [ // CustomLayerList
      "STRING_VALUE",
    ],
  },
};
const command = new UpdateMapCommand(input);
const response = await client.send(command);
// { // UpdateMapResponse
//   MapName: "STRING_VALUE", // required
//   MapArn: "STRING_VALUE", // required
//   UpdateTime: new Date("TIMESTAMP"), // required
// };

UpdateMapCommand Input

See UpdateMapCommandInput for more details

Parameter
Type
Description
MapName
Required
string | undefined

The name of the map resource to update.

ConfigurationUpdate
MapConfigurationUpdate | undefined

Updates the parts of the map configuration that can be updated, including the political view.

Description
string | undefined

Updates the description for the map resource.

PricingPlan
PricingPlan | undefined

No longer used. If included, the only allowed value is RequestBasedUsage.

UpdateMapCommand Output

See UpdateMapCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
MapArn
Required
string | undefined

The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource across AWS.

  • Format example: arn:aws:geo:region:account-id:map/ExampleMap

MapName
Required
string | undefined

The name of the updated map resource.

UpdateTime
Required
Date | undefined

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

Throws

Name
Fault
Details
AccessDeniedException
client

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

InternalServerException
server

The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException
client

The resource that you've entered was not found in your AWS account.

ThrottlingException
client

The request was denied because of request throttling.

ValidationException
client

The input failed to meet the constraints specified by the AWS service.

LocationServiceException
Base exception class for all service exceptions from Location service.