[ aws . location ]

create-place-index

Description

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

Note

By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.

Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

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>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--data-source (string)

Specifies the data provider of geospatial data.

--data-source-configuration (structure)

Specifies the data storage option for 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 (-) 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. There’s three pricing plan options:

• RequestBasedUsage — Selects the “Request-Based Usage” pricing plan.

• MobileAssetTracking — Selects the “Mobile Asset Tracking” pricing plan.

• MobileAssetManagement — Selects the “Mobile Asset Management” pricing plan.

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

Possible values:

• RequestBasedUsage

• MobileAssetTracking

• MobileAssetManagement

--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 when you need to specify a resource across all AWS.

IndexName -> (string)

The name for the Place index resource.