[ aws . location ]

describe-place-index

Description

Retrieves the Place index resource details.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-place-index
--index-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--index-name (string)

The name of the Place index resource.

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

DataSource -> (string)

The data provider of geospatial data.

DataSourceConfiguration -> (structure)

The specified 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

Description -> (string)

The optional description for the Place index resource.

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 of the Place index resource being described.

UpdateTime -> (timestamp)

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