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-routes-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 Routes API
  version: '2020-11-19'
  description: Generated from AWS's published Smithy model for Amazon Location Service. 5 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: Routes
paths:
  /routes/v0/calculators:
    post:
      operationId: CreateRouteCalculator
      summary: Create Route Calculator
      description: This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data. CreateRouteCalculator is part of a previous Amazon Location Service Routes API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2). The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources. If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Routes API version 2 is found under geo-routes or geo_routes, not under location. Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab. Start your version 2 API journey with the Routes V2 API Reference or the Developer Guide. Creates a route calculator resource in your Amazon Web Services account. You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider. If your application is tracking or routing assets you use in your business, such as deliv
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateRouteCalculatorResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '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/CreateRouteCalculatorRequest'
      tags:
      - Routes
  /routes/v0/calculators/{CalculatorName}:
    get:
      operationId: DescribeRouteCalculator
      summary: Describe Route Calculator
      description: This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data. DescribeRouteCalculator is part of a previous Amazon Location Service Routes API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2). The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources. If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Routes API version 2 is found under geo-routes or geo_routes, not under location. Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab. Start your version 2 API journey with the Routes V2 API Reference or the Developer Guide. Retrieves the route calculator resource details.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeRouteCalculatorResponse'
        '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/DescribeRouteCalculatorRequest'
      tags:
      - Routes
    patch:
      operationId: UpdateRouteCalculator
      summary: Update Route Calculator
      description: This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data. UpdateRouteCalculator is part of a previous Amazon Location Service Routes API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2). The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources. If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Routes API version 2 is found under geo-routes or geo_routes, not under location. Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab. Start your version 2 API journey with the Routes V2 API Reference or the Developer Guide. Updates the specified properties for a given route calculator resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRouteCalculatorResponse'
        '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/UpdateRouteCalculatorRequest'
      tags:
      - Routes
    delete:
      operationId: DeleteRouteCalculator
      summary: Delete Route Calculator
      description: This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data. DeleteRouteCalculator is part of a previous Amazon Location Service Routes API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2). The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources. If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Routes API version 2 is found under geo-routes or geo_routes, not under location. Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab. Start your version 2 API journey with the Routes V2 API Reference or the Developer Guide. Deletes a route calculator resource from your Amazon Web Services account. This operation deletes the resource permanently.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteRouteCalculatorResponse'
        '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/DeleteRouteCalculatorRequest'
      tags:
      - Routes
  /routes/v0/list-calculators:
    post:
      operationId: ListRouteCalculators
      summary: List Route Calculators
      description: This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data. ListRouteCalculators is part of a previous Amazon Location Service Routes API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2). The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources. If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Routes API version 2 is found under geo-routes or geo_routes, not under location. Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab. Start your version 2 API journey with the Routes V2 API Reference or the Developer Guide. Lists route calculator resources in your Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRouteCalculatorsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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/ListRouteCalculatorsRequest'
      tags:
      - Routes
components:
  schemas:
    ListRouteCalculatorsResponseEntry:
      type: object
      properties:
        CalculatorName:
          type: string
          description: The name of the route calculator resource.
        Description:
          type: string
          description: The optional description of the route calculator resource.
        DataSource:
          type: string
          description: 'The data provider of traffic and road network data. Indicates one of the available providers: Esri Grab Here For more information about data providers, see Amazon Location Service data providers.'
        PricingPlan:
          type: string
          description: Always returns RequestBasedUsage.
        CreateTime:
          type: string
          format: date-time
          description: 'The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00'
        UpdateTime:
          type: string
          format: date-time
          description: 'The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00'
      required:
      - CalculatorName
      - Description
      - DataSource
      - CreateTime
      - UpdateTime
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    UpdateRouteCalculatorResponse:
      type: object
      properties:
        CalculatorName:
          type: string
          description: The name of the updated route calculator resource.
        CalculatorArn:
          type: string
          description: 'The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource across AWS. Format example: arn:aws:geo:region:account-id:route- calculator/ExampleCalculator'
        UpdateTime:
          type: string
          format: date-time
          description: 'The timestamp for when the route calculator was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.'
      required:
      - CalculatorName
      - CalculatorArn
      - UpdateTime
    ListRouteCalculatorsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: 'An optional maximum number of results returned in a single call. Default Value: 100'
        NextToken:
          type: string
          description: 'The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default Value: null'
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
          description: A message with the reason for the service quota exceeded exception error.
      required:
      - Message
    DescribeRouteCalculatorResponse:
      type: object
      properties:
        CalculatorName:
          type: string
          description: The name of the route calculator resource being described.
        CalculatorArn:
          type: string
          description: 'The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across Amazon Web Services. Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator'
        PricingPlan:
          type: string
          description: Always returns RequestBasedUsage.
        Description:
          type: string
          description: The optional description of the route calculator resource.
        CreateTime:
          type: string
          format: date-time
          description: 'The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00'
        UpdateTime:
          type: string
          format: date-time
          description: 'The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00'
        DataSource:
          type: string
          description: 'The data provider of traffic and road network data. Indicates one of the available providers: Esri Grab Here For more information about data providers, see Amazon Location Service data providers.'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: Tags associated with route calculator resource.
      required:
      - CalculatorName
      - CalculatorArn
      - Description
      - CreateTime
      - UpdateTime
      - DataSource
    CreateRouteCalculatorResponse:
      type: object
      properties:
        CalculatorName:
          type: string
          description: The name of the route calculator resource. For example, ExampleRouteCalculator.
        CalculatorArn:
          type: string
          description: 'The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all Amazon Web Services. Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator'
        CreateTime:
          type: string
          format: date-time
          description: 'The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00'
      required:
      - CalculatorName
      - CalculatorArn
      - CreateTime
    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
    ConflictException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    DeleteRouteCalculatorResponse:
      type: object
      properties: {}
    ListRouteCalculatorsResponse:
      type: object
      properties:
        Entries:
          type: array
          items:
            $ref: '#/components/schemas/ListRouteCalculatorsResponseEntry'
          description: Lists the route calculator resources that exist in your Amazon Web Services account
        NextToken:
          type: string
          description: A pagination token indicating there are additional pages available. You can use the token in a subsequent request to fetch the next set of results.
      required:
      - Entries
    CreateRouteCalculatorRequest:
      type: object
      properties:
        CalculatorName:
          type: string
          description: 'The name of the route calculator resource. Requirements: Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_). Must be a unique Route calculator resource name. No spaces allowed. For example, ExampleRouteCalculator.'
        DataSource:
          type: string
          description: 'Specifies the data provider of traffic and road network data. This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error. Valid values include: Esri – For additional information about Esri''s coverage in your region of interest, see Esri details on street networks and traffic coverage. Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km. Grab – Grab provides routing functionality for Southeast Asia. For additional information about GrabMaps'' coverage, see GrabMaps countries and areas covered. Here – '
        PricingPlan:
          type: string
          description: No longer used. If included, the only allowed value is RequestBasedUsage.
        Description:
          type: string
          description: The optional description for the route calculator resource.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them. For example: { "tag1" : "value1", "tag2" : "value2"} Format: "key" : "value" Restrictions: Maximum 50 tags per resource Each resource tag must be unique with a maximum of one value. Maximum key length: 128 Unicode characters in UTF-8 Maximum value length: 256 Unicode characters in UTF-8 Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. Cannot use "aws:" as a prefix for a key.'
      required:
      - CalculatorName
      - DataSource
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    DeleteRouteCalculatorRequest:
      type: object
      properties:
        CalculatorName:
          type: string
          description: The name of the route calculator resource to be deleted.
      required:
      - CalculatorName
    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
    UpdateRouteCalculatorRequest:
      type: object
      properties:
        CalculatorName:
          type: string
          description: The name of the route calculator resource to update.
        PricingPlan:
          type: string
          description: No longer used. If included, the only allowed value is RequestBasedUsage.
        Description:
          type: string
          description: Updates the description for the route calculator resource.
      required:
      - CalculatorName
    DescribeRouteCalculatorRequest:
      type: object
      properties:
        CalculatorName:
          type: string
          description: The name of the route calculator resource.
      required:
      - CalculatorName
  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)