[ aws . location ]

update-place-index

Description

Updates the specified properties of a given place index resource.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-place-index
[--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-configuration (structure)

Updates the data storage option for the place index resource.

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)

Updates the description for the place index resource.

--index-name (string)

The name of the place index resource to update.

--pricing-plan (string)

No longer used. If included, the only allowed value is RequestBasedUsage .

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

See ‘aws help’ for descriptions of global parameters.

Output

IndexArn -> (string)

The Amazon Resource Name (ARN) of the upated 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 of the updated place index resource.

UpdateTime -> (timestamp)

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