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

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::GetGeofenceResponse

Includes:

Structure

Defined in:

lib/aws-sdk-locationservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:geofence_properties]

Instance Attribute Summary

• #create_time ⇒ Time

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

• #geofence_id ⇒ String

  The geofence identifier.

• #geofence_properties ⇒ Hash<String,String>

  User defined properties of the geofence.

• #geometry ⇒ Types::GeofenceGeometry

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

• #status ⇒ String

  Identifies the state of the geofence.

• #update_time ⇒ Time

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

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)

# File 'lib/aws-sdk-locationservice/types.rb', line 3437

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)

# File 'lib/aws-sdk-locationservice/types.rb', line 3437

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

# File 'lib/aws-sdk-locationservice/types.rb', line 3437

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:

• (Types::GeofenceGeometry)

# File 'lib/aws-sdk-locationservice/types.rb', line 3437

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)

# File 'lib/aws-sdk-locationservice/types.rb', line 3437

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)

# File 'lib/aws-sdk-locationservice/types.rb', line 3437

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