Describe Place Index

locationservice_describe_place_index

R Documentation

This operation is no longer current and may be deprecated in the future¶

Description¶

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.

describe_place_index 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 Amazon Web Services SDK or the Amazon Web Services 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.

Retrieves the place index resource details.

Usage¶

locationservice_describe_place_index(IndexName)

Arguments¶

IndexName

[required] The name of the place index resource.

Value¶

A list with the following syntax:

list(
  IndexName = "string",
  IndexArn = "string",
  PricingPlan = "RequestBasedUsage"|"MobileAssetTracking"|"MobileAssetManagement",
  Description = "string",
  CreateTime = as.POSIXct(
    "2015-01-01"
  ),
  UpdateTime = as.POSIXct(
    "2015-01-01"
  ),
  DataSource = "string",
  DataSourceConfiguration = list(
    IntendedUse = "SingleUse"|"Storage"
  ),
  Tags = list(
    "string"
  )
)

Request syntax¶

svc$describe_place_index(
  IndexName = "string"
)