:doc:`LocationService <../../location>` / Client / describe_place_index

********************
describe_place_index
********************



.. py:method:: LocationService.Client.describe_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.

     

    
    * ``DescribePlaceIndex`` 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 </location/latest/APIReference/API_Operations_Amazon_Location_Service_Places_V2.html>`__ or the `Developer Guide </location/latest/developerguide/places.html>`__.
    

    

   

  Retrieves the place index resource details.

  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribePlaceIndex>`_  


  **Request Syntax**
  ::

    response = client.describe_place_index(
        IndexName='string'
    )
    
  :type IndexName: string
  :param IndexName: **[REQUIRED]** 

    The name of the place index resource.

    

  
  
  :rtype: 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 <https://www.iso.org/iso-8601-date-and-time-format.html>`__ format: ``YYYY-MM-DDThh:mm:ss.sssZ``.

        
      

      - **UpdateTime** *(datetime) --* 

        The timestamp for when the place index resource was last updated in `ISO 8601 <https://www.iso.org/iso-8601-date-and-time-format.html>`__ 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 <https://docs.aws.amazon.com/location/previous/developerguide/what-is-data-provider.html>`__.

        
      

      - **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**
  
  *   :py:class:`LocationService.Client.exceptions.InternalServerException`

  
  *   :py:class:`LocationService.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`LocationService.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`LocationService.Client.exceptions.ValidationException`

  
  *   :py:class:`LocationService.Client.exceptions.ThrottlingException`

  