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-geofencing-api"

All apis

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

Discovery needs no key. Ratings and market analysis are Pro.

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 Geofencing 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: Geofencing
paths:
  /geofencing/v0/collections:
    post:
      operationId: CreateGeofenceCollection
      summary: Create Geofence Collection
      description: Creates a geofence collection, which manages and stores geofences.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGeofenceCollectionResponse'
        '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/CreateGeofenceCollectionRequest'
      tags:
      - Geofencing
  /geofencing/v0/collections/{CollectionName}:
    get:
      operationId: DescribeGeofenceCollection
      summary: Describe Geofence Collection
      description: Retrieves the geofence collection details.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeGeofenceCollectionResponse'
        '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/DescribeGeofenceCollectionRequest'
      tags:
      - Geofencing
    patch:
      operationId: UpdateGeofenceCollection
      summary: Update Geofence Collection
      description: Updates the specified properties of a given geofence collection.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateGeofenceCollectionResponse'
        '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/UpdateGeofenceCollectionRequest'
      tags:
      - Geofencing
    delete:
      operationId: DeleteGeofenceCollection
      summary: Delete Geofence Collection
      description: Deletes a geofence collection from your Amazon Web Services account. This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteGeofenceCollectionResponse'
        '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/DeleteGeofenceCollectionRequest'
      tags:
      - Geofencing
  /geofencing/v0/list-collections:
    post:
      operationId: ListGeofenceCollections
      summary: List Geofence Collections
      description: Lists geofence collections in your Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGeofenceCollectionsResponse'
        '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/ListGeofenceCollectionsRequest'
      tags:
      - Geofencing
components:
  schemas:
    DeleteGeofenceCollectionResponse:
      type: object
      properties: {}
    DescribeGeofenceCollectionResponse:
      type: object
      properties:
        CollectionName:
          type: string
          description: The name of the geofence collection.
        CollectionArn:
          type: string
          description: 'The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services. Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection'
        Description:
          type: string
          description: The optional description for the geofence collection.
        PricingPlan:
          type: string
          description: No longer used. Always returns RequestBasedUsage.
        PricingPlanDataSource:
          type: string
          description: No longer used. Always returns an empty string.
        KmsKeyId:
          type: string
          description: A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource
        Tags:
          type: object
          additionalProperties:
            type: string
          description: Displays the key, value pairs of tags associated with this resource.
        CreateTime:
          type: string
          format: date-time
          description: 'The timestamp for when the geofence 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 geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ'
        GeofenceCount:
          type: integer
          description: The number of geofences in the geofence collection.
      required:
      - CollectionName
      - CollectionArn
      - Description
      - CreateTime
      - UpdateTime
    DeleteGeofenceCollectionRequest:
      type: object
      properties:
        CollectionName:
          type: string
          description: The name of the geofence collection to be deleted.
      required:
      - CollectionName
    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
    ConflictException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ListGeofenceCollectionsResponseEntry:
      type: object
      properties:
        CollectionName:
          type: string
          description: The name of the geofence collection.
        Description:
          type: string
          description: The description for the geofence collection
        PricingPlan:
          type: string
          description: No longer used. Always returns RequestBasedUsage.
        PricingPlanDataSource:
          type: string
          description: No longer used. Always returns an empty string.
        CreateTime:
          type: string
          format: date-time
          description: 'The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ'
        UpdateTime:
          type: string
          format: date-time
          description: 'Specifies a timestamp for when the resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ'
      required:
      - CollectionName
      - Description
      - CreateTime
      - UpdateTime
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    UpdateGeofenceCollectionResponse:
      type: object
      properties:
        CollectionName:
          type: string
          description: The name of the updated geofence collection.
        CollectionArn:
          type: string
          description: 'The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a resource across Amazon Web Services. Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection'
        UpdateTime:
          type: string
          format: date-time
          description: 'The time when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ'
      required:
      - CollectionName
      - CollectionArn
      - UpdateTime
    ListGeofenceCollectionsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: 'An optional limit for the number of resources 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'
    CreateGeofenceCollectionResponse:
      type: object
      properties:
        CollectionName:
          type: string
          description: The name for the geofence collection.
        CollectionArn:
          type: string
          description: 'The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services. Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection'
        CreateTime:
          type: string
          format: date-time
          description: 'The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ'
      required:
      - CollectionName
      - CollectionArn
      - CreateTime
    UpdateGeofenceCollectionRequest:
      type: object
      properties:
        CollectionName:
          type: string
          description: The name of the geofence collection 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 geofence collection.
      required:
      - CollectionName
    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
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ListGeofenceCollectionsResponse:
      type: object
      properties:
        Entries:
          type: array
          items:
            $ref: '#/components/schemas/ListGeofenceCollectionsResponseEntry'
          description: Lists the geofence collections 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 following request to fetch the next set of results.
      required:
      - Entries
    CreateGeofenceCollectionRequest:
      type: object
      properties:
        CollectionName:
          type: string
          description: 'A custom name for the geofence collection. Requirements: Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). Must be a unique geofence collection name. No spaces allowed. For example, ExampleGeofenceCollection.'
        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: An optional description for the geofence collection.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them. 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.'
        KmsKeyId:
          type: string
          description: A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
      required:
      - CollectionName
    DescribeGeofenceCollectionRequest:
      type: object
      properties:
        CollectionName:
          type: string
          description: The name of the geofence collection.
      required:
      - CollectionName
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
          description: A message with the reason for the service quota exceeded exception error.
      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)