Skip to content

DescribePlaceIndexResponse

Source code in docs_src/capo_location/types/describe_place_index_response.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class DescribePlaceIndexResponse(TypedDict, closed=True):
    index_name: "capo_location.types.resource_name.ResourceName"
    """<p>The name of the place index resource being described.</p>"""
    index_arn: "capo_location.types.geo_arn.GeoArn"
    """<p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services. </p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex</code> </p> </li> </ul>"""
    pricing_plan: NotRequired["capo_location.types.pricing_plan.PricingPlan"]
    """<p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>"""
    description: "capo_location.types.resource_description.ResourceDescription"
    """<p>The optional description for the place index resource.</p>"""
    create_time: "capo_location.types.timestamp.Timestamp"
    """<p>The timestamp for when the place index resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>"""
    update_time: "capo_location.types.timestamp.Timestamp"
    """<p>The timestamp for when the place index resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>"""
    data_source: "str"
    """<p>The data provider of geospatial data. Values can be one of the following:</p> <ul> <li> <p> <code>Esri</code> </p> </li> <li> <p> <code>Grab</code> </p> </li> <li> <p> <code>Here</code> </p> </li> </ul> <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/previous/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>"""
    data_source_configuration: (
        "capo_location.types.data_source_configuration.DataSourceConfiguration"
    )
    """<p>The specified data storage option for requesting Places.</p>"""
    tags: NotRequired["capo_location.types.tag_map.TagMap"]
    """<p>Tags associated with place index resource.</p>"""

create_time instance-attribute 

create_time: Timestamp

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

data_source instance-attribute 

data_source: str

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.

data_source_configuration instance-attribute 

data_source_configuration: DataSourceConfiguration

The specified data storage option for requesting Places.

description instance-attribute 

description: ResourceDescription

The optional description for the place index resource.

index_arn instance-attribute 

index_arn: GeoArn

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

index_name instance-attribute 

index_name: ResourceName

The name of the place index resource being described.

pricing_plan instance-attribute 

pricing_plan: NotRequired[PricingPlan]

No longer used. Always returns RequestBasedUsage.

tags instance-attribute 

tags: NotRequired[TagMap]

Tags associated with place index resource.

update_time instance-attribute 

update_time: Timestamp

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