Skip to content

DescribeTrackerResponse

Source code in docs_src/capo_location/types/describe_tracker_response.py
class DescribeTrackerResponse(TypedDict, closed=True):
    tracker_name: "capo_location.types.resource_name.ResourceName"
    """<p>The name of the tracker resource.</p>"""
    tracker_arn: "capo_location.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) for the tracker 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:tracker/ExampleTracker</code> </p> </li> </ul>"""
    description: "capo_location.types.resource_description.ResourceDescription"
    """<p>The optional description for the tracker resource.</p>"""
    pricing_plan: NotRequired["capo_location.types.pricing_plan.PricingPlan"]
    """<p>Always returns <code>RequestBasedUsage</code>.</p>"""
    pricing_plan_data_source: NotRequired["str"]
    """<p>No longer used. Always returns an empty string.</p>"""
    tags: NotRequired["capo_location.types.tag_map.TagMap"]
    """<p>The tags associated with the tracker resource.</p>"""
    create_time: "capo_location.types.timestamp.Timestamp"
    """<p>The timestamp for when the tracker 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 tracker 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>"""
    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>"""
    position_filtering: NotRequired[
        "capo_location.types.position_filtering.PositionFiltering"
    ]
    """<p>The position filtering method of the tracker resource.</p>"""
    event_bridge_enabled: NotRequired["bool"]
    """<p>Whether <code>UPDATE</code> events from this tracker in EventBridge are enabled. If set to <code>true</code> these events will be sent to EventBridge.</p>"""
    kms_key_enable_geospatial_queries: NotRequired["bool"]
    """<p>Enables <code>GeospatialQueries</code> for a tracker that uses a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>.</p> <p>This parameter is only used if you are using a KMS customer managed key.</p> <note> <p>If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.</p> <p>You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the <code>KmsKeyEnableGeospatialQueries</code> parameter to true when creating or updating a Tracker.</p> </note>"""

create_time instance-attribute

create_time: Timestamp

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

description instance-attribute

description: ResourceDescription

The optional description for the tracker resource.

event_bridge_enabled instance-attribute

event_bridge_enabled: NotRequired[bool]

Whether UPDATE events from this tracker in EventBridge are enabled. If set to true these events will be sent to EventBridge.

kms_key_enable_geospatial_queries instance-attribute

kms_key_enable_geospatial_queries: NotRequired[bool]

Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.

This parameter is only used if you are using a KMS customer managed key.

If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.

You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.

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.

position_filtering instance-attribute

position_filtering: NotRequired[PositionFiltering]

The position filtering method of the tracker resource.

pricing_plan instance-attribute

pricing_plan: NotRequired[PricingPlan]

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]

The tags associated with the tracker resource.

tracker_arn instance-attribute

tracker_arn: Arn

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

  • Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

tracker_name instance-attribute

tracker_name: ResourceName

The name of the tracker resource.

update_time instance-attribute

update_time: Timestamp

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