Class: Aws::GeoRoutes::Types::RouteAvoidanceOptions

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

Overview

Specifies options for areas to avoid when calculating the route. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.

See Also:

Constant Summary collapse

SENSITIVE = 
[:car_shuttle_trains, :controlled_access_highways, :dirt_roads, :ferries, :seasonal_closure, :toll_roads, :toll_transponders, :truck_road_types, :tunnels, :u_turns]

Instance Attribute Summary collapse

Instance Attribute Details

#areas ⇒ Array<Types::RouteAvoidanceArea>

Areas to be avoided. Not supported in ‘ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps] customers.

[1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

Returns:



2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
 
# File 'lib/aws-sdk-georoutes/types.rb', line 2591

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = [:car_shuttle_trains, :controlled_access_highways, :dirt_roads, :ferries, :seasonal_closure, :toll_roads, :toll_transponders, :truck_road_types, :tunnels, :u_turns]
  include Aws::Structure
end

#car_shuttle_trains ⇒ Boolean

Avoid car-shuttle-trains while calculating the route. Not supported in ‘ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps] customers.

[1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

Returns:

  • (Boolean) 


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
 
# File 'lib/aws-sdk-georoutes/types.rb', line 2591

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = [:car_shuttle_trains, :controlled_access_highways, :dirt_roads, :ferries, :seasonal_closure, :toll_roads, :toll_transponders, :truck_road_types, :tunnels, :u_turns]
  include Aws::Structure
end

#controlled_access_highways ⇒ Boolean

Avoid controlled access highways while calculating the route.

Returns:

  • (Boolean) 


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
 
# File 'lib/aws-sdk-georoutes/types.rb', line 2591

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = [:car_shuttle_trains, :controlled_access_highways, :dirt_roads, :ferries, :seasonal_closure, :toll_roads, :toll_transponders, :truck_road_types, :tunnels, :u_turns]
  include Aws::Structure
end

#dirt_roads ⇒ Boolean

Avoid dirt roads while calculating the route. Not supported in ‘ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps] customers.

[1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

Returns:

  • (Boolean) 


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
 
# File 'lib/aws-sdk-georoutes/types.rb', line 2591

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = [:car_shuttle_trains, :controlled_access_highways, :dirt_roads, :ferries, :seasonal_closure, :toll_roads, :toll_transponders, :truck_road_types, :tunnels, :u_turns]
  include Aws::Structure
end

#ferries ⇒ Boolean

Avoid ferries while calculating the route.

Returns:

  • (Boolean) 


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
 
# File 'lib/aws-sdk-georoutes/types.rb', line 2591

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = [:car_shuttle_trains, :controlled_access_highways, :dirt_roads, :ferries, :seasonal_closure, :toll_roads, :toll_transponders, :truck_road_types, :tunnels, :u_turns]
  include Aws::Structure
end

#seasonal_closure ⇒ Boolean

Avoid roads that have seasonal closure while calculating the route. Not supported in ‘ap-southeast-1` and `ap-southeast-5` regions for

GrabMaps][1

customers.

[1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

Returns:

  • (Boolean) 


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
 
# File 'lib/aws-sdk-georoutes/types.rb', line 2591

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = [:car_shuttle_trains, :controlled_access_highways, :dirt_roads, :ferries, :seasonal_closure, :toll_roads, :toll_transponders, :truck_road_types, :tunnels, :u_turns]
  include Aws::Structure
end

#toll_roads ⇒ Boolean

Avoids roads where the specified toll transponders are the only mode of payment.

Returns:

  • (Boolean) 


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
 
# File 'lib/aws-sdk-georoutes/types.rb', line 2591

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = [:car_shuttle_trains, :controlled_access_highways, :dirt_roads, :ferries, :seasonal_closure, :toll_roads, :toll_transponders, :truck_road_types, :tunnels, :u_turns]
  include Aws::Structure
end

#toll_transponders ⇒ Boolean

Avoids roads where the specified toll transponders are the only mode of payment. Not supported in ‘ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps] customers.

[1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

Returns:

  • (Boolean) 


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
 
# File 'lib/aws-sdk-georoutes/types.rb', line 2591

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = [:car_shuttle_trains, :controlled_access_highways, :dirt_roads, :ferries, :seasonal_closure, :toll_roads, :toll_transponders, :truck_road_types, :tunnels, :u_turns]
  include Aws::Structure
end

#truck_road_types ⇒ Array<String>

Truck road type identifiers. ‘BK1` through `BK4` apply only to Sweden. `A2,A4,B2,B4,C,D,ET2,ET4` apply only to Mexico. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for

GrabMaps][1

customers.

<note markdown=“1”> There are currently no other supported values as of 26th April 2024.

</note>

[1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

Returns:

  • (Array<String>) 


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
 
# File 'lib/aws-sdk-georoutes/types.rb', line 2591

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = [:car_shuttle_trains, :controlled_access_highways, :dirt_roads, :ferries, :seasonal_closure, :toll_roads, :toll_transponders, :truck_road_types, :tunnels, :u_turns]
  include Aws::Structure
end

#tunnels ⇒ Boolean

Avoid tunnels while calculating the route. Not supported in ‘ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps] customers.

[1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

Returns:

  • (Boolean) 


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
 
# File 'lib/aws-sdk-georoutes/types.rb', line 2591

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = [:car_shuttle_trains, :controlled_access_highways, :dirt_roads, :ferries, :seasonal_closure, :toll_roads, :toll_transponders, :truck_road_types, :tunnels, :u_turns]
  include Aws::Structure
end

#u_turns ⇒ Boolean

Avoid U-turns for calculation on highways and motorways. Not supported in ‘ap-southeast-1` and `ap-southeast-5` regions for

GrabMaps][1

customers.

[1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

Returns:

  • (Boolean) 


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
 
# File 'lib/aws-sdk-georoutes/types.rb', line 2591

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = [:car_shuttle_trains, :controlled_access_highways, :dirt_roads, :ferries, :seasonal_closure, :toll_roads, :toll_transponders, :truck_road_types, :tunnels, :u_turns]
  include Aws::Structure
end

#zone_categories ⇒ Array<Types::RouteAvoidanceZoneCategory>

Zone categories to be avoided. Not supported in ‘ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps] customers.

[1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

Returns:



2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
 
# File 'lib/aws-sdk-georoutes/types.rb', line 2591

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = [:car_shuttle_trains, :controlled_access_highways, :dirt_roads, :ferries, :seasonal_closure, :toll_roads, :toll_transponders, :truck_road_types, :tunnels, :u_turns]
  include Aws::Structure
end