[ aws . location ]

get-place

Description

Finds a place by its unique ID. A PlaceId is returned by other search operations.

Note

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

See also: AWS API Documentation

Synopsis

  get-place
--index-name <value>
[--key <value>]
[--language <value>]
--place-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--index-name (string)

The name of the place index resource that you want to use for the search.

--key (string)

The optional API key to authorize the request.

--language (string)

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we’ll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en . The city in the results will most likely be returned as Athens .

If you set the language parameter to el , for Greek, then the city in the results will more likely be returned as Αθήνα .

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

--place-id (string)

The identifier of the place to find.

While you can use PlaceID in subsequent requests, PlaceID is not intended to be a permanent identifier and the ID can change between consecutive API calls. Please see the following PlaceID behaviour for each data provider:

• Esri: Place IDs will change every quarter at a minimum. The typical time period for these changes would be March, June, September, and December. Place IDs might also change between the typical quarterly change but that will be much less frequent.
• HERE: We recommend that you cache data for no longer than a week to keep your data data fresh. You can assume that less than 1% ID shifts will release over release which is approximately 1 - 2 times per week.
• Grab: Place IDs can expire or become invalid in the following situations.
  • Data operations: The POI may be removed from Grab POI database by Grab Map Ops based on the ground-truth, such as being closed in the real world, being detected as a duplicate POI, or having incorrect information. Grab will synchronize data to the Waypoint environment on weekly basis.
  • Interpolated POI: Interpolated POI is a temporary POI generated in real time when serving a request, and it will be marked as derived in the place.result_type field in the response. The information of interpolated POIs will be retained for at least 30 days, which means that within 30 days, you are able to obtain POI details by Place ID from Place Details API. After 30 days, the interpolated POIs(both Place ID and details) may expire and inaccessible from the Places Details API.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

Place -> (structure)

Details about the result, such as its address and position.

AddressNumber -> (string)

The numerical portion of an address, such as a building number.

Categories -> (list)

The Amazon Location categories that describe this Place.

For more information about using categories, including a list of Amazon Location categories, see Categories and filtering , in the Amazon Location Service Developer Guide .

(string)

Country -> (string)

A country/region specified using ISO 3166 3-digit country/region code. For example, CAN .

Geometry -> (structure)

Places uses a point geometry to specify a location or a Place.

Point -> (list)

A single point geometry specifies a location for a Place using WGS 84 coordinates:

• x — Specifies the x coordinate or longitude.
• y — Specifies the y coordinate or latitude.

(double)

Interpolated -> (boolean)

True if the result is interpolated from other known places.

False if the Place is a known place.

Not returned when the partner does not provide the information.

For example, returns False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.

Label -> (string)

The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA .

Municipality -> (string)

A name for a local area, such as a city or town name. For example, Toronto .

Neighborhood -> (string)

The name of a community district. For example, Downtown .

PostalCode -> (string)

A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.

Region -> (string)

A name for an area or geographical division, such as a province or state name. For example, British Columbia .

Street -> (string)

The name for a street or a road to identify a location. For example, Main Street .

SubMunicipality -> (string)

An area that’s part of a larger municipality. For example, Blissville is a submunicipality in the Queen County in New York.

Note

This property is only returned for a place index that uses Esri as a data provider. The property is represented as a district .

For more information about data providers, see Amazon Location Service data providers .

SubRegion -> (string)

A county, or an area that’s part of a larger region. For example, Metro Vancouver .

SupplementalCategories -> (list)

Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.

(string)

TimeZone -> (structure)

The time zone in which the Place is located. Returned only when using HERE or Grab as the selected partner.

Name -> (string)

The name of the time zone, following the IANA time zone standard . For example, America/Los_Angeles .

Offset -> (integer)

The time zone’s offset, in seconds, from UTC.

UnitNumber -> (string)

For addresses with multiple units, the unit identifier. Can include numbers and letters, for example 3B or Unit 123 .

Note

This property is returned only for a place index that uses Esri or Grab as a data provider. It is not returned for SearchPlaceIndexForPosition .

UnitType -> (string)

For addresses with a UnitNumber , the type of unit. For example, Apartment .

Note

This property is returned only for a place index that uses Esri as a data provider.