Amazonka.Location.Types.RouteMatrixEntryError

Documentation

data RouteMatrixEntryError

An error corresponding to the calculation of a route between the DeparturePosition and DestinationPosition.

The error code can be one of the following:

• RouteNotFound - Unable to find a valid route with the given parameters.
• RouteTooLong - Route calculation went beyond the maximum size of a route and was terminated before completion.
• PositionsNotFound - One or more of the input positions were not found on the route network.
• DestinationPositionNotFound - The destination position was not found on the route network.
• DeparturePositionNotFound - The departure position was not found on the route network.
• OtherValidationError - The given inputs were not valid or a route was not found. More information is given in the error Message

See: newRouteMatrixEntryError smart constructor.

Constructors

RouteMatrixEntryError'

Fields

• message :: Maybe Text

  A message about the error that occurred for the route calculation.

• code :: RouteMatrixErrorCode

  The type of error which occurred for the route calculation.

Instances

FromJSON RouteMatrixEntryError

Defined in Amazonka.Location.Types.RouteMatrixEntryError

Methods

parseJSON :: Value -> Parser RouteMatrixEntryError

parseJSONList :: Value -> Parser [RouteMatrixEntryError]

Generic RouteMatrixEntryError

Defined in Amazonka.Location.Types.RouteMatrixEntryError

Associated Types

type Rep RouteMatrixEntryError :: Type -> Type

Methods

from :: RouteMatrixEntryError -> Rep RouteMatrixEntryError x

to :: Rep RouteMatrixEntryError x -> RouteMatrixEntryError

Read RouteMatrixEntryError

Defined in Amazonka.Location.Types.RouteMatrixEntryError

Methods

readsPrec :: Int -> ReadS RouteMatrixEntryError

readList :: ReadS [RouteMatrixEntryError]

readPrec :: ReadPrec RouteMatrixEntryError

readListPrec :: ReadPrec [RouteMatrixEntryError]

Show RouteMatrixEntryError

Defined in Amazonka.Location.Types.RouteMatrixEntryError

Methods

showsPrec :: Int -> RouteMatrixEntryError -> ShowS

show :: RouteMatrixEntryError -> String

showList :: [RouteMatrixEntryError] -> ShowS

NFData RouteMatrixEntryError

Defined in Amazonka.Location.Types.RouteMatrixEntryError

Methods

rnf :: RouteMatrixEntryError -> ()

Eq RouteMatrixEntryError

Defined in Amazonka.Location.Types.RouteMatrixEntryError

Methods

(==) :: RouteMatrixEntryError -> RouteMatrixEntryError -> Bool

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

Hashable RouteMatrixEntryError

Defined in Amazonka.Location.Types.RouteMatrixEntryError

Methods

hashWithSalt :: Int -> RouteMatrixEntryError -> Int

hash :: RouteMatrixEntryError -> Int

type Rep RouteMatrixEntryError

Defined in Amazonka.Location.Types.RouteMatrixEntryError

type Rep RouteMatrixEntryError = D1 ('MetaData "RouteMatrixEntryError" "Amazonka.Location.Types.RouteMatrixEntryError" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "RouteMatrixEntryError'" 'PrefixI 'True) (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RouteMatrixErrorCode)))

newRouteMatrixEntryError

Arguments

:: RouteMatrixErrorCode

$sel:code:RouteMatrixEntryError'

-> RouteMatrixEntryError

Create a value of RouteMatrixEntryError 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:message:RouteMatrixEntryError', routeMatrixEntryError_message - A message about the error that occurred for the route calculation.

$sel:code:RouteMatrixEntryError', routeMatrixEntryError_code - The type of error which occurred for the route calculation.

routeMatrixEntryError_message :: Lens' RouteMatrixEntryError (Maybe Text)

A message about the error that occurred for the route calculation.

routeMatrixEntryError_code :: Lens' RouteMatrixEntryError RouteMatrixErrorCode

The type of error which occurred for the route calculation.