[ 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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  batch-put-geofence
--collection-name <value>
--entries <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

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 of the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.

Note

Each geofence polygon can have a maximum of 1,000 vertices.

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).

Polygon -> (list)

An array of 1 or more linear rings. 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 of the form: [longitude, latitude] .

The first linear ring is an outer ring, describing the polygon’s boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring’s center, where the left side is the polygon’s exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon’s interior.

A geofence polygon can consist of between 4 and 1,000 vertices.

(list)

(list)

(double)

JSON Syntax:

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

--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.

See ‘aws help’ for descriptions of global parameters.

Output

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.

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.

GeofenceId -> (string)

The geofence associated with the error message.

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.

CreateTime -> (timestamp)

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

GeofenceId -> (string)

The geofence successfully stored in a geofence collection.

UpdateTime -> (timestamp)

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