Amazon Location Service REST API

openapi: 3.1.0
info:
  title: Amazon Location Service API
  description: The Amazon Location Service API provides programmatic access to manage Location Service resources.
  version: '2024-01-01'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
servers:
- url: https://geo.us-east-1.amazonaws.com
  description: Amazon Location Service endpoint
security:
- sigv4: []
tags:
- name: Maps
  description: Map resource management
paths:
  /maps:
    post:
      operationId: CreateMap
      summary: Amazon Location Service Create Map
      description: Creates a map resource in your AWS account.
      tags:
      - Maps
      responses:
        '200':
          description: Success
        '400':
          description: Bad request
        '403':
          description: Access denied
        '500':
          description: Internal server error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: ListMaps
      summary: Amazon Location Service List Maps
      description: Lists map resources in your AWS account.
      tags:
      - Maps
      responses:
        '200':
          description: Success
        '400':
          description: Bad request
        '403':
          description: Access denied
        '500':
          description: Internal server error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /maps/{MapName}:
    get:
      operationId: DescribeMap
      summary: Amazon Location Service Describe Map
      description: Retrieves the map resource details.
      tags:
      - Maps
      parameters:
      - name: MapName
        in: path
        required: true
        schema:
          type: string
        description: The name of the map resource.
      responses:
        '200':
          description: Success
        '400':
          description: Bad request
        '403':
          description: Access denied
        '500':
          description: Internal server error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: DeleteMap
      summary: Amazon Location Service Delete Map
      description: Deletes a map resource from your AWS account.
      tags:
      - Maps
      parameters:
      - name: MapName
        in: path
        required: true
        schema:
          type: string
        description: The name of the map resource.
      responses:
        '200':
          description: Success
        '400':
          description: Bad request
        '403':
          description: Access denied
        '500':
          description: Internal server error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /tracking/v0/trackers:
    post:
      operationId: CreateTracker
      summary: Amazon Location Service Create Tracker
      description: Creates a tracker resource in your AWS account.
      tags:
      - Maps
      responses:
        '200':
          description: Success
        '400':
          description: Bad request
        '403':
          description: Access denied
        '500':
          description: Internal server error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: ListTrackers
      summary: Amazon Location Service List Trackers
      description: Lists tracker resources in your AWS account.
      tags:
      - Maps
      responses:
        '200':
          description: Success
        '400':
          description: Bad request
        '403':
          description: Access denied
        '500':
          description: Internal server error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /tracking/v0/trackers/{TrackerName}/positions:
    post:
      operationId: BatchUpdateDevicePosition
      summary: Amazon Location Service Batch Update Device Position
      description: Uploads position update data for one or more devices to a tracker resource.
      tags:
      - Maps
      parameters:
      - name: TrackerName
        in: path
        required: true
        schema:
          type: string
        description: The name of the tracker.
      responses:
        '200':
          description: Success
        '400':
          description: Bad request
        '403':
          description: Access denied
        '500':
          description: Internal server error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /places/v0/indexes/{IndexName}/search/text:
    post:
      operationId: SearchPlaceIndexForText
      summary: Amazon Location Service Search Place Index for Text
      description: Geocodes free-form text, such as an address, name, city, or region.
      tags:
      - Maps
      parameters:
      - name: IndexName
        in: path
        required: true
        schema:
          type: string
        description: The name of the place index resource.
      responses:
        '200':
          description: Success
        '400':
          description: Bad request
        '403':
          description: Access denied
        '500':
          description: Internal server error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication
  schemas:
    MapResource:
      type: object
      description: An Amazon Location Service map resource.
      properties:
        MapName:
          type: string
          description: The name of the map resource.
          example: my-map
        MapArn:
          type: string
          description: The Amazon Resource Name (ARN) for the map resource.
        DataSource:
          type: string
          description: Specifies the map data provider.
          example: HERE
        Description:
          type: string
          description: An optional description for the map resource.
        CreateTime:
          type: string
          description: The timestamp for when the map resource was created.
          format: date-time
        UpdateTime:
          type: string
          description: The timestamp for when the map resource was last updated.
          format: date-time
    Tracker:
      type: object
      description: An Amazon Location Service tracker resource for tracking device positions.
      properties:
        TrackerName:
          type: string
          description: The name of the tracker resource.
          example: fleet-tracker
        TrackerArn:
          type: string
          description: The Amazon Resource Name (ARN) for the tracker.
        Description:
          type: string
          description: The optional description for the tracker resource.
        PositionFiltering:
          type: string
          description: The position filtering method of the tracker resource.
          example: TimeBased
          enum:
          - TimeBased
          - DistanceBased
          - AccuracyBased
        CreateTime:
          type: string
          description: The timestamp for when the tracker resource was created.
          format: date-time