find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-location-service:amazon-location-service-tracking-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon Location Service Tracking API
  version: '2020-11-19'
  description: Generated from AWS's published Smithy model for Amazon Location Service. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://geo.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Tracking
paths:
  /tracking/v0/trackers/{TrackerName}:
    get:
      operationId: DescribeTracker
      summary: Describe Tracker
      description: Retrieves the tracker resource details.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeTrackerResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeTrackerRequest'
      tags:
      - Tracking
    patch:
      operationId: UpdateTracker
      summary: Update Tracker
      description: Updates the specified properties of a given tracker resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateTrackerResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTrackerRequest'
      tags:
      - Tracking
    delete:
      operationId: DeleteTracker
      summary: Delete Tracker
      description: Deletes a tracker resource from your Amazon Web Services account. This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteTrackerResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteTrackerRequest'
      tags:
      - Tracking
components:
  schemas:
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    DescribeTrackerResponse:
      type: object
      properties:
        TrackerName:
          type: string
          description: The name of the tracker resource.
        TrackerArn:
          type: string
          description: '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'
        Description:
          type: string
          description: The optional description for the tracker resource.
        PricingPlan:
          type: string
          description: Always returns RequestBasedUsage.
        PricingPlanDataSource:
          type: string
          description: No longer used. Always returns an empty string.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags associated with the tracker resource.
        CreateTime:
          type: string
          format: date-time
          description: 'The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.'
        UpdateTime:
          type: string
          format: date-time
          description: 'The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.'
        KmsKeyId:
          type: string
          description: A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource.
        PositionFiltering:
          type: string
          description: The position filtering method of the tracker resource.
        EventBridgeEnabled:
          type: boolean
          description: Whether UPDATE events from this tracker in EventBridge are enabled. If set to true these events will be sent to EventBridge.
        KmsKeyEnableGeospatialQueries:
          type: boolean
          description: 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. Thi
      required:
      - TrackerName
      - TrackerArn
      - Description
      - CreateTime
      - UpdateTime
    DeleteTrackerResponse:
      type: object
      properties: {}
    UpdateTrackerRequest:
      type: object
      properties:
        TrackerName:
          type: string
          description: The name of the tracker resource to update.
        PricingPlan:
          type: string
          description: No longer used. If included, the only allowed value is RequestBasedUsage.
        PricingPlanDataSource:
          type: string
          description: This parameter is no longer used.
        Description:
          type: string
          description: Updates the description for the tracker resource.
        PositionFiltering:
          type: string
          description: 'Updates the position filtering for the tracker resource. Valid values: TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID. DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and his'
        EventBridgeEnabled:
          type: boolean
          description: Whether to enable position UPDATE events from this tracker to be sent to EventBridge. You do not need enable this feature to get ENTER and EXIT events for geofences with this tracker. Those events are always sent to EventBridge.
        KmsKeyEnableGeospatialQueries:
          type: boolean
          description: 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.
      required:
      - TrackerName
    ValidationException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          description: A message with the reason for the validation exception error.
        FieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The field where the invalid entry was detected.
      required:
      - Message
      - Reason
      - FieldList
    UpdateTrackerResponse:
      type: object
      properties:
        TrackerName:
          type: string
          description: The name of the updated tracker resource.
        TrackerArn:
          type: string
          description: 'The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS. Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker'
        UpdateTime:
          type: string
          format: date-time
          description: 'The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.'
      required:
      - TrackerName
      - TrackerArn
      - UpdateTime
    DescribeTrackerRequest:
      type: object
      properties:
        TrackerName:
          type: string
          description: The name of the tracker resource.
      required:
      - TrackerName
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    DeleteTrackerRequest:
      type: object
      properties:
        TrackerName:
          type: string
          description: The name of the tracker resource to be deleted.
      required:
      - TrackerName
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ValidationExceptionField:
      type: object
      properties:
        Name:
          type: string
          description: The field name where the invalid entry was detected.
        Message:
          type: string
          description: A message with the reason for the validation exception error.
      required:
      - Name
      - Message
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: geo
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/location/service/2020-11-19/location-2020-11-19.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)