Address ¶

class Address(TypedDict, closed=True):
    label: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.</p>"""
    country: NotRequired["capo_geo_places.types.country.Country"]
    """<p>The country component of the address.</p>"""
    region: NotRequired["capo_geo_places.types.region.Region"]
    """<p>The region or state results should be present in. </p> <p>Example: <code>North Rhine-Westphalia</code>.</p>"""
    sub_region: NotRequired["capo_geo_places.types.sub_region.SubRegion"]
    """<p>The sub-region or county for which results should be present in. </p>"""
    locality: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>The city or locality of the address.</p> <p>Example: <code>Vancouver</code>.</p>"""
    district: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>The district or division of a locality associated with this address.</p>"""
    sub_district: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>A subdivision of a district. </p> <p>Example: <code>Minden-Lübbecke</code>.</p>"""
    postal_code: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should possess. </p>"""
    block: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p> Name of the block. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <p>Example: <code>Sunny Mansion 203 block: 2 Chome</code> </p>"""
    sub_block: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p> Name of sub-block. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <p>Example: <code>Sunny Mansion 203 sub-block: 4</code> </p>"""
    intersection: NotRequired[
        "capo_geo_places.types.intersection_street_list.IntersectionStreetList"
    ]
    """<p> Name of the streets in the intersection. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <p>Example: <code>["Friedrichstraße","Unter den Linden"]</code> </p>"""
    street: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>The name of the street results should be present in.</p>"""
    street_components: NotRequired[
        "capo_geo_places.types.street_components_list.StreetComponentsList"
    ]
    """<p> Components of the street. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <p>Example: Yonge from "Yonge street".</p>"""
    address_number: NotRequired[
        "capo_geo_places.types.sensitive_string.SensitiveString"
    ]
    """<p>The number that identifies an address within a street.</p>"""
    building: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p> The name of the building at the address. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>"""
    secondary_address_components: NotRequired[
        "capo_geo_places.types.secondary_address_component_list.SecondaryAddressComponentList"
    ]
    """<p> Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <note> <p>Coverage for <code>Address.SecondaryAddressComponents</code> is available in the following countries:</p> <p>AUS, CAN, NZL, USA, PRI</p> </note>"""