AWS CLI Command Reference

[ aws . location ]

batch-put-geofence

Description

A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.

See also: AWS API Documentation

Synopsis

  batch-put-geofence
--collection-name <value>
--entries <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--collection-name (string)

The geofence collection storing the geofences.

--entries (list)

The batch of geofences to be stored in a geofence collection.

(structure)

Contains geofence geometry details.

GeofenceId -> (string)

The identifier for the geofence to be stored in a given geofence collection.

Geometry -> (structure)

Contains the details to specify the position of the geofence. Can be a circle, a polygon, or a multipolygon. Polygon and MultiPolygon geometries can be defined using their respective parameters, or encoded in Geobuf format using the Geobuf parameter. Including multiple geometry types in the same request will return a validation error.

Note

The geofence Polygon and MultiPolygon formats support a maximum of 1,000 total vertices. The Geobuf format supports a maximum of 100,000 vertices.

Polygon -> (list)

A Polygon is a list of up to 250 linear rings which represent the shape of a geofence. This list must include 1 exterior ring (representing the outer perimeter of the geofence), and can optionally include up to 249 interior rings (representing polygonal spaces within the perimeter, which are excluded from the geofence area).

A linear ring is an array of 4 or more vertices, where the first and last vertex are the same (to form a closed boundary). Each vertex is a 2-dimensional point represented as an array of doubles of length 2: [longitude, latitude] .

Each linear ring is represented as an array of arrays of doubles ([[longitude, latitude], [longitude, latitude], ...] ). The vertices for the exterior ring must be listed in counter-clockwise sequence. Vertices for all interior rings must be listed in clockwise sequence.

The list of linear rings that describe the entire Polygon is represented as an array of arrays of arrays of doubles ([[[longitude, latitude], [longitude, latitude], ...], [[longitude, latitude], [longitude, latitude], ...], ...] ). The exterior ring must be listed first, before any interior rings.

Note

The following additional requirements and limitations apply to geometries defined using the Polygon parameter:

  • The entire Polygon must consist of no more than 1,000 vertices, including all vertices from the exterior ring and all interior rings.
  • Rings must not touch or cross each other.
  • All interior rings must be fully contained within the exterior ring.
  • Interior rings must not contain other interior rings.
  • No ring is permitted to intersect itself.

(list)

(list)

(double)

Circle -> (structure)

A circle on the earth, as defined by a center point and a radius.

Center -> (list)

A single point geometry, specifying the center of the circle, using WGS 84 coordinates, in the form [longitude, latitude] .

(double)

Radius -> (double)

The radius of the circle in meters. Must be greater than zero and no larger than 100,000 (100 kilometers).

Geobuf -> (blob)

Geobuf is a compact binary encoding for geographic data that provides lossless compression of GeoJSON polygons. The Geobuf must be Base64-encoded.

This parameter can contain a Geobuf-encoded GeoJSON geometry object of type Polygon OR MultiPolygon . For more information and specific configuration requirements for these object types, see Polygon and MultiPolygon .

Note

The following limitations apply specifically to geometries defined using the Geobuf parameter, and supercede the corresponding limitations of the Polygon and MultiPolygon parameters:

  • A Polygon in Geobuf format can have up to 25,000 rings and up to 100,000 total vertices, including all vertices from all component rings.
  • A MultiPolygon in Geobuf format can contain up to 10,000 Polygons and up to 100,000 total vertices, including all vertices from all component Polygons .

MultiPolygon -> (list)

A MultiPolygon is a list of up to 250 Polygon elements which represent the shape of a geofence. The Polygon components of a MultiPolygon geometry can define separate geographical areas that are considered part of the same geofence, perimeters of larger exterior areas with smaller interior spaces that are excluded from the geofence, or some combination of these use cases to form complex geofence boundaries.

For more information and specific configuration requirements for the Polygon components that form a MultiPolygon , see Polygon .

Note

The following additional requirements and limitations apply to geometries defined using the MultiPolygon parameter:

  • The entire MultiPolygon must consist of no more than 1,000 vertices, including all vertices from all component Polygons .
  • Each edge of a component Polygon must intersect no more than 5 edges from other Polygons . Parallel edges that are shared but do not cross are not counted toward this limit.
  • The total number of intersecting edges of component Polygons must be no more than 100,000. Parallel edges that are shared but do not cross are not counted toward this limit.

(list)

(list)

(list)

(double)

GeofenceProperties -> (map)

Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

Format: "key" : "value"

key -> (string)

value -> (string)

JSON Syntax:

[
  {
    "GeofenceId": "string",
    "Geometry": {
      "Polygon": [
        [
          [double, ...]
          ...
        ]
        ...
      ],
      "Circle": {
        "Center": [double, ...],
        "Radius": double
      },
      "Geobuf": blob,
      "MultiPolygon": [
        [
          [
            [double, ...]
            ...
          ]
          ...
        ]
        ...
      ]
    },
    "GeofenceProperties": {"string": "string"
      ...}
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

Successes -> (list)

Contains each geofence that was successfully stored in a geofence collection.

(structure)

Contains a summary of each geofence that was successfully stored in a given geofence collection.

GeofenceId -> (string)

The geofence successfully stored in a geofence collection.

CreateTime -> (timestamp)

The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

UpdateTime -> (timestamp)

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

Errors -> (list)

Contains additional error details for each geofence that failed to be stored in a geofence collection.

(structure)

Contains error details for each geofence that failed to be stored in a given geofence collection.

GeofenceId -> (string)

The geofence associated with the error message.

Error -> (structure)

Contains details associated to the batch error.

Code -> (string)

The error code associated with the batch request error.

Message -> (string)

A message with the reason for the batch request error.
© Copyright 2025, Amazon Web Services. Created using Sphinx.