Module Values.DescribePlaceIndexResponseSource

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. DescribePlaceIndex 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.

Sourcetype nonrec t = {
  1. indexName : ResourceName.t option;
    (*

    The name of the place index resource being described.

    *)
  2. indexArn : GeoArn.t option;
    (*

    The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services. Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

    *)
  3. pricingPlan : PricingPlan.t option;
    (*

    No longer used. Always returns RequestBasedUsage.

    *)
  4. description : ResourceDescription.t option;
    (*

    The optional description for the place index resource.

    *)
  5. createTime : Timestamp.t option;
    (*

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

    *)
  6. updateTime : Timestamp.t option;
    (*

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

    *)
  7. dataSource : String_.t option;
    (*

    The data provider of geospatial data. Values can be one of the following: Esri Grab Here For more information about data providers, see Amazon Location Service data providers.

    *)
  8. dataSourceConfiguration : DataSourceConfiguration.t option;
    (*

    The specified data storage option for requesting Places.

    *)
  9. tags : TagMap.t option;
    (*

    Tags associated with place index resource.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerException of InternalServerException.t
  3. | `ResourceNotFoundException of ResourceNotFoundException.t
  4. | `ThrottlingException of ThrottlingException.t
  5. | `ValidationException of ValidationException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?indexName:??? -> ?indexArn:??? -> ?pricingPlan:??? -> ?description:??? -> ?createTime:??? -> ?updateTime:??? -> ?dataSource:??? -> ?dataSourceConfiguration:??? -> ?tags:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Map of ([> `String of TagKey.t ] * [> `String of TagValue.t ]) list | `String of ResourceName.t | `Structure of (string * [> `Enum of string ]) list | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t