LocationService / Client / update_place_index

update_place_index#

LocationService.Client.update_place_index(**kwargs)#

Updates the specified properties of a given place index resource.

See also: AWS API Documentation

Request Syntax

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

  • IndexName (string) –

    [REQUIRED]

    The name of the place index resource to update.

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

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

  • DataSourceConfiguration (dict) –

    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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • IndexName (string) –

      The name of the updated place index resource.

    • IndexArn (string) –

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

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

    • UpdateTime (datetime) –

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

Exceptions