[ aws . location ]

create-place-index

Description

Creates a place index resource in your AWS account, which supports functions with geospatial data sourced from your chosen data provider.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-place-index
--data-source <value>
[--data-source-configuration <value>]
[--description <value>]
--index-name <value>
--pricing-plan <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--data-source (string)

Specifies the data provider of geospatial data.

Note

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

• Esri – For additional information about Esri ‘s coverage in your region of interest, see Esri details on geocoding coverage .

• Here – For additional information about HERE Technologies ‘ coverage in your region of interest, see HERE details on goecoding coverage .

Warning

Place index resources using HERE Technologies as a data provider can’t store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide .

--data-source-configuration (structure)

Specifies the data storage option requesting Places.

IntendedUse -> (string)

Specifies how the results of an operation will be stored by the caller.

Valid values include:

• SingleUse specifies that the results won’t be stored.

• Storage specifies that the result can be cached or stored in a database.

Default value: SingleUse

Shorthand Syntax:

IntendedUse=string

JSON Syntax:

{
  "IntendedUse": "SingleUse"|"Storage"
}

--description (string)

The optional description for the place index resource.

--index-name (string)

The name of the place index resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique place index resource name.

• No spaces allowed. For example, ExamplePlaceIndex .

--pricing-plan (string)

Specifies the pricing plan for your place index resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .

Possible values:

• RequestBasedUsage

• MobileAssetTracking

• MobileAssetManagement

--tags (map)

Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

See ‘aws help’ for descriptions of global parameters.

Output

CreateTime -> (timestamp)

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

IndexArn -> (string)

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.

• Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

IndexName -> (string)

The name for the place index resource.