Amazonka.Location.Types.CalculateRouteMatrixSummary

Documentation

data CalculateRouteMatrixSummary

A summary of the calculated route matrix.

See: newCalculateRouteMatrixSummary smart constructor.

Constructors

CalculateRouteMatrixSummary'

Fields

• dataSource :: Text

  The data provider of traffic and road network data used to calculate the routes. Indicates one of the available providers:

  • Esri

  • Here

  For more information about data providers, see Amazon Location Service data providers.

• distanceUnit :: DistanceUnit

  The unit of measurement for route distances.

• errorCount :: Natural

  The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

• routeCount :: Natural

  The count of cells in the route matrix. Equal to the number of DeparturePositions multiplied by the number of DestinationPositions.

Instances

FromJSON CalculateRouteMatrixSummary

Defined in Amazonka.Location.Types.CalculateRouteMatrixSummary

Methods

parseJSON :: Value -> Parser CalculateRouteMatrixSummary

parseJSONList :: Value -> Parser [CalculateRouteMatrixSummary]

Generic CalculateRouteMatrixSummary

Defined in Amazonka.Location.Types.CalculateRouteMatrixSummary

Associated Types

type Rep CalculateRouteMatrixSummary :: Type -> Type

Methods

from :: CalculateRouteMatrixSummary -> Rep CalculateRouteMatrixSummary x

to :: Rep CalculateRouteMatrixSummary x -> CalculateRouteMatrixSummary

Read CalculateRouteMatrixSummary

Defined in Amazonka.Location.Types.CalculateRouteMatrixSummary

Methods

readsPrec :: Int -> ReadS CalculateRouteMatrixSummary

readList :: ReadS [CalculateRouteMatrixSummary]

readPrec :: ReadPrec CalculateRouteMatrixSummary

readListPrec :: ReadPrec [CalculateRouteMatrixSummary]

Show CalculateRouteMatrixSummary

Defined in Amazonka.Location.Types.CalculateRouteMatrixSummary

Methods

showsPrec :: Int -> CalculateRouteMatrixSummary -> ShowS

show :: CalculateRouteMatrixSummary -> String

showList :: [CalculateRouteMatrixSummary] -> ShowS

NFData CalculateRouteMatrixSummary

Defined in Amazonka.Location.Types.CalculateRouteMatrixSummary

Methods

rnf :: CalculateRouteMatrixSummary -> ()

Eq CalculateRouteMatrixSummary

Defined in Amazonka.Location.Types.CalculateRouteMatrixSummary

Methods

(==) :: CalculateRouteMatrixSummary -> CalculateRouteMatrixSummary -> Bool

(/=) :: CalculateRouteMatrixSummary -> CalculateRouteMatrixSummary -> Bool

Hashable CalculateRouteMatrixSummary

Defined in Amazonka.Location.Types.CalculateRouteMatrixSummary

Methods

hashWithSalt :: Int -> CalculateRouteMatrixSummary -> Int

hash :: CalculateRouteMatrixSummary -> Int

type Rep CalculateRouteMatrixSummary

Defined in Amazonka.Location.Types.CalculateRouteMatrixSummary

type Rep CalculateRouteMatrixSummary = D1 ('MetaData "CalculateRouteMatrixSummary" "Amazonka.Location.Types.CalculateRouteMatrixSummary" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "CalculateRouteMatrixSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "distanceUnit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DistanceUnit)) :*: (S1 ('MetaSel ('Just "errorCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "routeCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newCalculateRouteMatrixSummary

Arguments

:: Text

$sel:dataSource:CalculateRouteMatrixSummary'

-> DistanceUnit

$sel:distanceUnit:CalculateRouteMatrixSummary'

-> Natural

$sel:errorCount:CalculateRouteMatrixSummary'

-> Natural

$sel:routeCount:CalculateRouteMatrixSummary'

-> CalculateRouteMatrixSummary

Create a value of CalculateRouteMatrixSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSource:CalculateRouteMatrixSummary', calculateRouteMatrixSummary_dataSource - The data provider of traffic and road network data used to calculate the routes. Indicates one of the available providers:

• Esri

• Here

For more information about data providers, see Amazon Location Service data providers.

$sel:distanceUnit:CalculateRouteMatrixSummary', calculateRouteMatrixSummary_distanceUnit - The unit of measurement for route distances.

$sel:errorCount:CalculateRouteMatrixSummary', calculateRouteMatrixSummary_errorCount - The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

$sel:routeCount:CalculateRouteMatrixSummary', calculateRouteMatrixSummary_routeCount - The count of cells in the route matrix. Equal to the number of DeparturePositions multiplied by the number of DestinationPositions.

calculateRouteMatrixSummary_dataSource :: Lens' CalculateRouteMatrixSummary Text

The data provider of traffic and road network data used to calculate the routes. Indicates one of the available providers:

• Esri

• Here

For more information about data providers, see Amazon Location Service data providers.

calculateRouteMatrixSummary_distanceUnit :: Lens' CalculateRouteMatrixSummary DistanceUnit

The unit of measurement for route distances.

calculateRouteMatrixSummary_errorCount :: Lens' CalculateRouteMatrixSummary Natural

The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

calculateRouteMatrixSummary_routeCount :: Lens' CalculateRouteMatrixSummary Natural

The count of cells in the route matrix. Equal to the number of DeparturePositions multiplied by the number of DestinationPositions.