Amazon Web Services Places API

The Places API from Amazon Web Services — 7 operation(s) for places.

OpenAPI Specification

amazon-web-services-places-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 Places API
  description: <p>Identity and Access Management Access Analyzer helps you to set, verify, and refine your IAM policies by providing a suite of capabilities. Its features include findings for external and unused access, basic and custom policy checks for validating policies, and policy generation to generate fine-grained policies. To start using IAM Access Analyzer to identify external or unused access, you first need to create an analyzer.</p> <p> <b>External access analyzers</b> help identify potential risks of accessing resources by enabling you to identify any resource policies that grant access to an external principal. It does this by using logic-based reasoning to analyze resource-based policies in your Amazon Web Services environment. An external principal can be another Amazon Web Services account, a root user, an IAM user or role, a federated user, an Amazon Web Services service, or an anonymous user. You can also use IAM Access Analyzer to preview public and cross-account access to your resources before deploying permissions changes.</p> <p> <b>Unused access analyzers</b> help identify potential identity access risks by enabling you to identify unused IAM roles, unused access keys, unused console passwords, and IAM principals with unused service and action-level permissions.</p> <p>Beyond findings, IAM Access Analyzer provides basic and custom policy checks to validate IAM policies before deploying permissions changes. You can use policy generation to refine permissions by attaching a policy generated using access activity logged in CloudTrail logs. </p> <p>This guide describes the IAM Access Analyzer operations that you can call programmatically. For general information about IAM Access Analyzer, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html">Identity and Access Management Access Analyzer</a> in the <b>IAM User Guide</b>.</p>
tags:
- name: Places
paths:
  /places/v0/indexes:
    POST:
      summary: Amazon Web Services Createplaceindex
      description: 'Creates a place index resource in your Amazon Web Services account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.  If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details. '
      operationId: amazonWebServicesCreatePlaceIndex
      tags:
      - Places
  /places/v0/indexes/{IndexName}:
    PATCH:
      summary: Amazon Web Services Updateplaceindex
      description: Updates the specified properties of a given place index resource.
      operationId: amazonWebServicesUpdatePlaceIndex
      tags:
      - Places
  /places/v0/indexes/{IndexName}/places/{PlaceId}:
    GET:
      summary: Amazon Web Services Getplace
      description: 'Finds a place by its unique ID. A PlaceId is returned by other search operations.  A PlaceId is valid only if all of the following are the same in the original search request and the call to GetPlace.   Customer Amazon Web Services account   Amazon Web Services Region   Data provider specified in the place index resource   '
      operationId: amazonWebServicesGetPlace
      tags:
      - Places
  /places/v0/list-indexes:
    POST:
      summary: Amazon Web Services Listplaceindexes
      description: Lists place index resources in your Amazon Web Services account.
      operationId: amazonWebServicesListPlaceIndexes
      tags:
      - Places
  /places/v0/indexes/{IndexName}/search/position:
    POST:
      summary: Amazon Web Services Searchplaceindexforposition
      description: Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
      operationId: amazonWebServicesSearchPlaceIndexForPosition
      tags:
      - Places
  /places/v0/indexes/{IndexName}/search/suggestions:
    POST:
      summary: Amazon Web Services Searchplaceindexforsuggestions
      description: 'Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching. Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.  You can search for suggested place names near a specified position by using BiasPosition, or filter results within a bounding box by using FilterBBox. These parameters are mutually exclusive; using both BiasPosition and FilterBBox in the same command returns an error. '
      operationId: amazonWebServicesSearchPlaceIndexForSuggestions
      tags:
      - Places
  /places/v0/indexes/{IndexName}/search/text:
    POST:
      summary: Amazon Web Services Searchplaceindexfortext
      description: Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.  Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.  You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error.  Search results are returned in order of highest to lowest relevance.
      operationId: amazonWebServicesSearchPlaceIndexForText
      tags:
      - Places