Class: Aws::LocationService::Types::PutGeofenceRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-locationservice/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:geofence_properties]

Instance Attribute Summary collapse

Instance Attribute Details

#collection_name ⇒ String

The geofence collection to store the geofence in.

Returns:

  • (String) 


5405
5406
5407
5408
5409
5410
5411
5412
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5405

class PutGeofenceRequest < Struct.new(
  :collection_name,
  :geofence_id,
  :geometry,
  :geofence_properties)
  SENSITIVE = [:geofence_properties]
  include Aws::Structure
end

#geofence_id ⇒ String

An identifier for the geofence. For example, ‘ExampleGeofence-1`.

Returns:

  • (String) 


5405
5406
5407
5408
5409
5410
5411
5412
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5405

class PutGeofenceRequest < Struct.new(
  :collection_name,
  :geofence_id,
  :geometry,
  :geofence_properties)
  SENSITIVE = [:geofence_properties]
  include Aws::Structure
end

#geofence_properties ⇒ Hash<String,String>

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”`

Returns:

  • (Hash<String,String>) 


5405
5406
5407
5408
5409
5410
5411
5412
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5405

class PutGeofenceRequest < Struct.new(
  :collection_name,
  :geofence_id,
  :geometry,
  :geofence_properties)
  SENSITIVE = [:geofence_properties]
  include Aws::Structure
end

#geometry ⇒ Types::GeofenceGeometry

Contains the details to specify the position of the geofence. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

<note markdown=“1”> The [ geofence polygon] format supports a maximum of 1,000 vertices. The [Geofence Geobuf] format supports a maximum of 100,000 vertices.

</note>

[1]: docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html

Returns:



5405
5406
5407
5408
5409
5410
5411
5412
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5405

class PutGeofenceRequest < Struct.new(
  :collection_name,
  :geofence_id,
  :geometry,
  :geofence_properties)
  SENSITIVE = [:geofence_properties]
  include Aws::Structure
end