v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1458290352.8 KB

Retrieves the place index resource details.

get/places/v0/indexes/{IndexName}

Path parameters

IndexNamestring required

The name of the place index resource.

Response

Success

CreateTimestring date-time required

The timestamp for when the place index resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.

DataSourcestring required
<p>The data provider of geospatial data. Values can be one of the following:</p> <ul> <li> <p> <code>Esri</code> </p> </li> <li> <p> <code>Grab</code> </p> </li> <li> <p> <code>Here</code> </p> </li> </ul> <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
Descriptionstring required

The optional description for the place index resource.

IndexArnstring required
<p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services. </p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex</code> </p> </li> </ul>
IndexNamestring required

The name of the place index resource being described.

PricingPlan'RequestBasedUsage' | 'MobileAssetTracking' | 'MobileAssetManagement'

No longer used. Always returns <code>RequestBasedUsage</code>.Deprecated. Always returns RequestBasedUsage.

Tagsobject

Tags associated with place index resource.

UpdateTimestring date-time required

The timestamp for when the place index resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.