LocationService / Client / describe_tracker

describe_tracker#

LocationService.Client.describe_tracker(**kwargs)#

Retrieves the tracker resource details.

See also: AWS API Documentation

Request Syntax

response = client.describe_tracker(
    TrackerName='string'
)
Parameters:

TrackerName (string) –

[REQUIRED]

The name of the tracker resource.

Return type:

dict

Returns:

Response Syntax

{
    'CreateTime': datetime(2015, 1, 1),
    'Description': 'string',
    'KmsKeyId': 'string',
    'PositionFiltering': 'TimeBased'|'DistanceBased'|'AccuracyBased',
    'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    'PricingPlanDataSource': 'string',
    'Tags': {
        'string': 'string'
    },
    'TrackerArn': 'string',
    'TrackerName': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • CreateTime (datetime) –

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

    • Description (string) –

      The optional description for the tracker resource.

    • KmsKeyId (string) –

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

    • PositionFiltering (string) –

      The position filtering method of the tracker resource.

    • PricingPlan (string) –

      Always returns RequestBasedUsage.

    • PricingPlanDataSource (string) –

      No longer used. Always returns an empty string.

    • Tags (dict) –

      The tags associated with the tracker resource.

      • (string) –

        • (string) –

    • TrackerArn (string) –

      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

    • TrackerName (string) –

      The name of the tracker resource.

    • UpdateTime (datetime) –

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

Exceptions

  • LocationService.Client.exceptions.InternalServerException

  • LocationService.Client.exceptions.ResourceNotFoundException

  • LocationService.Client.exceptions.AccessDeniedException

  • LocationService.Client.exceptions.ValidationException

  • LocationService.Client.exceptions.ThrottlingException