Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Location.Types.CalculateRouteMatrixSummary

Description

Documentation

data CalculateRouteMatrixSummary Source #

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

Instances details

FromJSON CalculateRouteMatrixSummary Source #
Instance details Defined in Amazonka.Location.Types.CalculateRouteMatrixSummary Methods parseJSON :: Value -> Parser CalculateRouteMatrixSummary # parseJSONList :: Value -> Parser [CalculateRouteMatrixSummary] #
Generic CalculateRouteMatrixSummary Source #
Instance details 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 Source #
Instance details Defined in Amazonka.Location.Types.CalculateRouteMatrixSummary Methods readsPrec :: Int -> ReadS CalculateRouteMatrixSummary # readList :: ReadS [CalculateRouteMatrixSummary] # readPrec :: ReadPrec CalculateRouteMatrixSummary # readListPrec :: ReadPrec [CalculateRouteMatrixSummary] #
Show CalculateRouteMatrixSummary Source #
Instance details Defined in Amazonka.Location.Types.CalculateRouteMatrixSummary Methods showsPrec :: Int -> CalculateRouteMatrixSummary -> ShowS # show :: CalculateRouteMatrixSummary -> String # showList :: [CalculateRouteMatrixSummary] -> ShowS #
NFData CalculateRouteMatrixSummary Source #
Instance details Defined in Amazonka.Location.Types.CalculateRouteMatrixSummary Methods rnf :: CalculateRouteMatrixSummary -> () #
Eq CalculateRouteMatrixSummary Source #
Instance details Defined in Amazonka.Location.Types.CalculateRouteMatrixSummary Methods (==) :: CalculateRouteMatrixSummary -> CalculateRouteMatrixSummary -> Bool # (/=) :: CalculateRouteMatrixSummary -> CalculateRouteMatrixSummary -> Bool #
Hashable CalculateRouteMatrixSummary Source #
Instance details Defined in Amazonka.Location.Types.CalculateRouteMatrixSummary Methods hashWithSalt :: Int -> CalculateRouteMatrixSummary -> Int # hash :: CalculateRouteMatrixSummary -> Int #
type Rep CalculateRouteMatrixSummary Source #
Instance details 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 Source #

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 Source #

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 Source #

The unit of measurement for route distances.

calculateRouteMatrixSummary_errorCount :: Lens' CalculateRouteMatrixSummary Natural Source #

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

calculateRouteMatrixSummary_routeCount :: Lens' CalculateRouteMatrixSummary Natural Source #

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