Skip to content

DescribeGeofenceCollectionResponse

Source code in docs_src/capo_location/types/describe_geofence_collection_response.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class DescribeGeofenceCollectionResponse(TypedDict, closed=True):
    collection_name: "capo_location.types.resource_name.ResourceName"
    """<p>The name of the geofence collection.</p>"""
    collection_arn: "capo_location.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services. </p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection</code> </p> </li> </ul>"""
    description: "capo_location.types.resource_description.ResourceDescription"
    """<p>The optional description for the geofence collection.</p>"""
    pricing_plan: NotRequired["capo_location.types.pricing_plan.PricingPlan"]
    """<p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>"""
    pricing_plan_data_source: NotRequired["str"]
    """<p>No longer used. Always returns an empty string.</p>"""
    kms_key_id: NotRequired["capo_location.types.kms_key_id.KmsKeyId"]
    """<p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a> assigned to the Amazon Location resource</p>"""
    tags: NotRequired["capo_location.types.tag_map.TagMap"]
    """<p>Displays the key, value pairs of tags associated with this resource.</p>"""
    create_time: "capo_location.types.timestamp.Timestamp"
    """<p>The timestamp for when the geofence 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 geofence collection 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>"""
    geofence_count: NotRequired["int"]
    """<p>The number of geofences in the geofence collection.</p>"""

collection_arn instance-attribute 

collection_arn: Arn

The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services.

  • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

collection_name instance-attribute 

collection_name: ResourceName

The name of the geofence collection.

create_time instance-attribute 

create_time: Timestamp

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

description instance-attribute 

description: ResourceDescription

The optional description for the geofence collection.

geofence_count instance-attribute 

geofence_count: NotRequired[int]

The number of geofences in the geofence collection.

kms_key_id instance-attribute 

kms_key_id: NotRequired[KmsKeyId]

A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource

pricing_plan instance-attribute 

pricing_plan: NotRequired[PricingPlan]

No longer used. Always returns RequestBasedUsage.

pricing_plan_data_source instance-attribute 

pricing_plan_data_source: NotRequired[str]

No longer used. Always returns an empty string.

tags instance-attribute 

tags: NotRequired[TagMap]

Displays the key, value pairs of tags associated with this resource.

update_time instance-attribute 

update_time: Timestamp

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