LocationService / Client / create_place_index

create_place_index

LocationService.Client.create_place_index(**kwargs)

Warning

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

  • CreatePlaceIndex is part of a previous Amazon Location Service Places API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).

  • The Places API version 2 has a simplified interface that can be used without creating or managing place index resources.

  • If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Places API version 2 is found under geo-places or geo_places, not under location.

  • Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.

  • Start your version 2 API journey with the Places V2 API Reference or the Developer Guide.

Creates a place index resource in your Amazon Web Services account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.

Note

If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.

See also: AWS API Documentation

Request Syntax

response = client.create_place_index(
    IndexName='string',
    DataSource='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    Description='string',
    DataSourceConfiguration={
        'IntendedUse': 'SingleUse'|'Storage'
    },
    Tags={
        'string': 'string'
    }
)
Parameters:

  • IndexName (string) –

    [REQUIRED]

    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.

  • DataSource (string) –

    [REQUIRED]

    Specifies the geospatial data provider for the new place index.

    Note

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

    Valid values include:

    Warning

    If you specify HERE Technologies ( Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services service terms for Amazon Location Service.

    For additional information , see Data providers on the Amazon Location Service developer guide.

  • PricingPlan (string) – No longer used. If included, the only allowed value is RequestBasedUsage.

  • Description (string) – The optional description for the place index resource.

  • DataSourceConfiguration (dict) –

    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

  • Tags (dict) –

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

    Format: "key" : "value"

    Restrictions:

    • Maximum 50 tags per resource.

    • Each tag key must be unique and must have exactly one associated 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: + - = . _ : / @

    • Cannot use “aws:” as a prefix for a key.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'IndexName': 'string',
    'IndexArn': 'string',
    'CreateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • IndexName (string) –

      The name for the place index resource.

    • IndexArn (string) –

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

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

    • CreateTime (datetime) –

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

Exceptions