LocationService / Client / describe_place_index

describe_place_index

LocationService.Client.describe_place_index(**kwargs)

Retrieves the place index resource details.

See also: AWS API Documentation

Request Syntax

response = client.describe_place_index(
    IndexName='string'
)

Parameters:

IndexName (string) –

[REQUIRED]

The name of the place index resource.

Return type:

dict

Returns:

Response Syntax

{
    'IndexName': 'string',
    'IndexArn': 'string',
    'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    'Description': 'string',
    'CreateTime': datetime(2015, 1, 1),
    'UpdateTime': datetime(2015, 1, 1),
    'DataSource': 'string',
    'DataSourceConfiguration': {
        'IntendedUse': 'SingleUse'|'Storage'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) –

  • IndexName (string) –

    The name of the place index resource being described.

  • 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

  • PricingPlan (string) –

    No longer used. Always returns RequestBasedUsage.

  • Description (string) –

    The optional description for the place index resource.

  • CreateTime (datetime) –

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

  • UpdateTime (datetime) –

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

  • DataSource (string) –

    The data provider of geospatial data. Values can be one of the following:

    • Esri

    • Grab

    • Here

    For more information about data providers, see Amazon Location Service data providers.

  • DataSourceConfiguration (dict) –

    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

  • Tags (dict) –

    Tags associated with place index resource.

    • (string) –

      • (string) –

Exceptions

• LocationService.Client.exceptions.InternalServerException

• LocationService.Client.exceptions.ResourceNotFoundException

• LocationService.Client.exceptions.AccessDeniedException

• LocationService.Client.exceptions.ValidationException

• LocationService.Client.exceptions.ThrottlingException