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.DescribeRouteCalculator

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the route calculator resource details.

Synopsis

Creating a Request

data DescribeRouteCalculator Source #

See: newDescribeRouteCalculator smart constructor.

Constructors

DescribeRouteCalculator'
Fields calculatorName :: Text The name of the route calculator resource.

Instances

Instances details

ToHeaders DescribeRouteCalculator Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator Methods toHeaders :: DescribeRouteCalculator -> [Header] #
ToPath DescribeRouteCalculator Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator Methods toPath :: DescribeRouteCalculator -> ByteString #
ToQuery DescribeRouteCalculator Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator Methods toQuery :: DescribeRouteCalculator -> QueryString #
AWSRequest DescribeRouteCalculator Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator Associated Types type AWSResponse DescribeRouteCalculator # Methods request :: (Service -> Service) -> DescribeRouteCalculator -> Request DescribeRouteCalculator # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeRouteCalculator -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeRouteCalculator))) #
Generic DescribeRouteCalculator Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator Associated Types type Rep DescribeRouteCalculator :: Type -> Type # Methods from :: DescribeRouteCalculator -> Rep DescribeRouteCalculator x # to :: Rep DescribeRouteCalculator x -> DescribeRouteCalculator #
Read DescribeRouteCalculator Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator Methods readsPrec :: Int -> ReadS DescribeRouteCalculator # readList :: ReadS [DescribeRouteCalculator] # readPrec :: ReadPrec DescribeRouteCalculator # readListPrec :: ReadPrec [DescribeRouteCalculator] #
Show DescribeRouteCalculator Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator Methods showsPrec :: Int -> DescribeRouteCalculator -> ShowS # show :: DescribeRouteCalculator -> String # showList :: [DescribeRouteCalculator] -> ShowS #
NFData DescribeRouteCalculator Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator Methods rnf :: DescribeRouteCalculator -> () #
Eq DescribeRouteCalculator Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator Methods (==) :: DescribeRouteCalculator -> DescribeRouteCalculator -> Bool # (/=) :: DescribeRouteCalculator -> DescribeRouteCalculator -> Bool #
Hashable DescribeRouteCalculator Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator Methods hashWithSalt :: Int -> DescribeRouteCalculator -> Int # hash :: DescribeRouteCalculator -> Int #
type AWSResponse DescribeRouteCalculator Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator type AWSResponse DescribeRouteCalculator = DescribeRouteCalculatorResponse
type Rep DescribeRouteCalculator Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator type Rep DescribeRouteCalculator = D1 ('MetaData "DescribeRouteCalculator" "Amazonka.Location.DescribeRouteCalculator" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "DescribeRouteCalculator'" 'PrefixI 'True) (S1 ('MetaSel ('Just "calculatorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeRouteCalculator Source #

Arguments

:: Text	`DescribeRouteCalculator`
-> DescribeRouteCalculator

Create a value of DescribeRouteCalculator 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:

DescribeRouteCalculator, describeRouteCalculator_calculatorName - The name of the route calculator resource.

Request Lenses

describeRouteCalculator_calculatorName :: Lens' DescribeRouteCalculator Text Source #

The name of the route calculator resource.

Destructuring the Response

data DescribeRouteCalculatorResponse Source #

See: newDescribeRouteCalculatorResponse smart constructor.

Constructors

DescribeRouteCalculatorResponse'

Fields

pricingPlan :: Maybe PricingPlan
Always returns RequestBasedUsage.
tags :: Maybe (HashMap Text Text)
Tags associated with route calculator resource.
httpStatus :: Int
The response's http status code.
calculatorArn :: Text
The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.
- Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
calculatorName :: Text
The name of the route calculator resource being described.
createTime :: ISO8601
The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
- For example, 2020–07-2T12:15:20.000Z+01:00
dataSource :: Text
The data provider of traffic and road network data. Indicates one of the available providers:
- ```
Esri
```
- ```
Here
```
For more information about data providers, see Amazon Location Service data providers.
description :: Text
The optional description of the route calculator resource.
updateTime :: ISO8601
The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
- For example, 2020–07-2T12:15:20.000Z+01:00

Instances

Instances details

Generic DescribeRouteCalculatorResponse Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator Associated Types type Rep DescribeRouteCalculatorResponse :: Type -> Type # Methods from :: DescribeRouteCalculatorResponse -> Rep DescribeRouteCalculatorResponse x # to :: Rep DescribeRouteCalculatorResponse x -> DescribeRouteCalculatorResponse #
Read DescribeRouteCalculatorResponse Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator Methods readsPrec :: Int -> ReadS DescribeRouteCalculatorResponse # readList :: ReadS [DescribeRouteCalculatorResponse] # readPrec :: ReadPrec DescribeRouteCalculatorResponse # readListPrec :: ReadPrec [DescribeRouteCalculatorResponse] #
Show DescribeRouteCalculatorResponse Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator Methods showsPrec :: Int -> DescribeRouteCalculatorResponse -> ShowS # show :: DescribeRouteCalculatorResponse -> String # showList :: [DescribeRouteCalculatorResponse] -> ShowS #
NFData DescribeRouteCalculatorResponse Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator Methods rnf :: DescribeRouteCalculatorResponse -> () #
Eq DescribeRouteCalculatorResponse Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator Methods (==) :: DescribeRouteCalculatorResponse -> DescribeRouteCalculatorResponse -> Bool # (/=) :: DescribeRouteCalculatorResponse -> DescribeRouteCalculatorResponse -> Bool #
type Rep DescribeRouteCalculatorResponse Source #
Instance details Defined in Amazonka.Location.DescribeRouteCalculator type Rep DescribeRouteCalculatorResponse = D1 ('MetaData "DescribeRouteCalculatorResponse" "Amazonka.Location.DescribeRouteCalculator" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "DescribeRouteCalculatorResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "pricingPlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PricingPlan)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "calculatorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "calculatorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601)) :: (S1 ('MetaSel ('Just "dataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "updateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601))))))

newDescribeRouteCalculatorResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeRouteCalculatorResponse'`
-> Text	`$sel:calculatorArn:DescribeRouteCalculatorResponse'`
-> Text	`DescribeRouteCalculator`
-> UTCTime	`DescribeRouteCalculatorResponse`
-> Text	`DescribeRouteCalculatorResponse`
-> Text	`DescribeRouteCalculatorResponse`
-> UTCTime	`DescribeRouteCalculatorResponse`
-> DescribeRouteCalculatorResponse

Create a value of DescribeRouteCalculatorResponse 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:

DescribeRouteCalculatorResponse, describeRouteCalculatorResponse_pricingPlan - Always returns RequestBasedUsage.

$sel:tags:DescribeRouteCalculatorResponse', describeRouteCalculatorResponse_tags - Tags associated with route calculator resource.

$sel:httpStatus:DescribeRouteCalculatorResponse', describeRouteCalculatorResponse_httpStatus - The response's http status code.

$sel:calculatorArn:DescribeRouteCalculatorResponse', describeRouteCalculatorResponse_calculatorArn - The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.

Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator

DescribeRouteCalculator, describeRouteCalculatorResponse_calculatorName - The name of the route calculator resource being described.

DescribeRouteCalculatorResponse, describeRouteCalculatorResponse_createTime - The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

For example, 2020–07-2T12:15:20.000Z+01:00

DescribeRouteCalculatorResponse, describeRouteCalculatorResponse_dataSource - The data provider of traffic and road network data. Indicates one of the available providers:

```
Esri
```
```
Here
```

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

DescribeRouteCalculatorResponse, describeRouteCalculatorResponse_description - The optional description of the route calculator resource.

DescribeRouteCalculatorResponse, describeRouteCalculatorResponse_updateTime - The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

For example, 2020–07-2T12:15:20.000Z+01:00

Response Lenses

describeRouteCalculatorResponse_pricingPlan :: Lens' DescribeRouteCalculatorResponse (Maybe PricingPlan) Source #

Always returns RequestBasedUsage.

describeRouteCalculatorResponse_tags :: Lens' DescribeRouteCalculatorResponse (Maybe (HashMap Text Text)) Source #

Tags associated with route calculator resource.

describeRouteCalculatorResponse_httpStatus :: Lens' DescribeRouteCalculatorResponse Int Source #

The response's http status code.

describeRouteCalculatorResponse_calculatorArn :: Lens' DescribeRouteCalculatorResponse Text Source #

The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.

Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator

describeRouteCalculatorResponse_calculatorName :: Lens' DescribeRouteCalculatorResponse Text Source #

The name of the route calculator resource being described.

describeRouteCalculatorResponse_createTime :: Lens' DescribeRouteCalculatorResponse UTCTime Source #

The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

For example, 2020–07-2T12:15:20.000Z+01:00

describeRouteCalculatorResponse_dataSource :: Lens' DescribeRouteCalculatorResponse Text Source #

The data provider of traffic and road network data. Indicates one of the available providers:

```
Esri
```
```
Here
```

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

describeRouteCalculatorResponse_description :: Lens' DescribeRouteCalculatorResponse Text Source #

The optional description of the route calculator resource.

describeRouteCalculatorResponse_updateTime :: Lens' DescribeRouteCalculatorResponse UTCTime Source #

The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

For example, 2020–07-2T12:15:20.000Z+01:00