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

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

#create_time ⇒ Time

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

[1]: www.iso.org/iso-8601-date-and-time-format.html

Returns:

  • (Time) 


3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'lib/aws-sdk-locationservice/types.rb', line 3435

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

#geofence_id ⇒ String

The geofence identifier.

Returns:

  • (String) 


3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'lib/aws-sdk-locationservice/types.rb', line 3435

class GetGeofenceResponse < Struct.new(
  :geofence_id,
  :geometry,
  :status,
  :create_time,
  :update_time,
  :geofence_properties)
  SENSITIVE = [: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>) 


3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'lib/aws-sdk-locationservice/types.rb', line 3435

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

#geometry ⇒ Types::GeofenceGeometry

Contains the geofence geometry details describing a polygon or a circle.

Returns:



3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'lib/aws-sdk-locationservice/types.rb', line 3435

class GetGeofenceResponse < Struct.new(
  :geofence_id,
  :geometry,
  :status,
  :create_time,
  :update_time,
  :geofence_properties)
  SENSITIVE = [: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) 


3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'lib/aws-sdk-locationservice/types.rb', line 3435

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

#update_time ⇒ Time

The timestamp for when the geofence collection was last updated in

ISO 8601][1

format: ‘YYYY-MM-DDThh:mm:ss.sssZ`

[1]: www.iso.org/iso-8601-date-and-time-format.html

Returns:

  • (Time) 


3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'lib/aws-sdk-locationservice/types.rb', line 3435

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