Class: Aws::LocationService::Types::GetGeofenceResponse

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:create_time, :update_time, :geofence_properties]

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ Time

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

Returns:

  • (Time) 


3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3564

class GetGeofenceResponse < Struct.new(
  :geofence_id,
  :geometry,
  :status,
  :create_time,
  :update_time,
  :geofence_properties)
  SENSITIVE = [:create_time, :update_time, :geofence_properties]
  include Aws::Structure
end

#geofence_id ⇒ String

The geofence identifier.

Returns:

  • (String) 


3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3564

class GetGeofenceResponse < Struct.new(
  :geofence_id,
  :geometry,
  :status,
  :create_time,
  :update_time,
  :geofence_properties)
  SENSITIVE = [:create_time, :update_time, :geofence_properties]
  include Aws::Structure
end

#geofence_properties ⇒ Hash<String,String>

User defined properties of 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>) 


3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3564

class GetGeofenceResponse < Struct.new(
  :geofence_id,
  :geometry,
  :status,
  :create_time,
  :update_time,
  :geofence_properties)
  SENSITIVE = [:create_time, :update_time, :geofence_properties]
  include Aws::Structure
end

#geometry ⇒ Types::GeofenceGeometry

Contains the geofence geometry details describing the position of the geofence. Can be a circle, a polygon, or a multipolygon.

Returns:



3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3564

class GetGeofenceResponse < Struct.new(
  :geofence_id,
  :geometry,
  :status,
  :create_time,
  :update_time,
  :geofence_properties)
  SENSITIVE = [:create_time, :update_time, :geofence_properties]
  include Aws::Structure
end

#status ⇒ String

Identifies the state of the geofence. A geofence will hold one of the following states:

  • ACTIVE — The geofence has been indexed by the system.

  • PENDING — The geofence is being processed by the system.

  • FAILED — The geofence failed to be indexed by the system.

  • DELETED — The geofence has been deleted from the system index.

  • DELETING — The geofence is being deleted from the system index.

Returns:

  • (String) 


3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3564

class GetGeofenceResponse < Struct.new(
  :geofence_id,
  :geometry,
  :status,
  :create_time,
  :update_time,
  :geofence_properties)
  SENSITIVE = [:create_time, :update_time, :geofence_properties]
  include Aws::Structure
end

#update_time ⇒ Time

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

Returns:

  • (Time) 


3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3564

class GetGeofenceResponse < Struct.new(
  :geofence_id,
  :geometry,
  :status,
  :create_time,
  :update_time,
  :geofence_properties)
  SENSITIVE = [:create_time, :update_time, :geofence_properties]
  include Aws::Structure
end