Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdatePlaceIndex

Important

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

UpdatePlaceIndex is part of a previous Amazon Location Service Places API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).
The Places API version 2 has a simplified interface that can be used without creating or managing place index resources.
If you are using an AWS SDK or the AWS CLI, note that the Places API version 2 is found under geo-places or geo_places, not under location.
Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Places V2 API Reference or the Developer Guide.

Updates the specified properties of a given place index resource.

Request Syntax


PATCH /places/v0/indexes/IndexName HTTP/1.1
Content-type: application/json

{
   "DataSourceConfiguration": { 
      "IntendedUse": "string"
   },
   "Description": "string",
   "PricingPlan": "string"
}

URI Request Parameters

The request uses the following URI parameters.

IndexName

The name of the place index resource to update.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-._\w]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

DataSourceConfiguration

Updates the data storage option for the place index resource.

Type: DataSourceConfiguration object

Required: No

Description

Updates the description for the place index resource.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Required: No

PricingPlan

This parameter has been deprecated.

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

Type: String

Valid Values: RequestBasedUsage | MobileAssetTracking | MobileAssetManagement

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "IndexArn": "string",
   "IndexName": "string",
   "UpdateTime": "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.

IndexArn

The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a resource across AWS.

Format example: arn:aws:geo:region:account-id:place- index/ExamplePlaceIndex

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1600.

Pattern: arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))

IndexName

The name of the updated place index resource.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-._\w]+

UpdateTime

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

Type: Timestamp

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

ResourceNotFoundException

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

HTTP Status Code: 404

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