libZSservicesZSamazonka-locationZSamazonka-location
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Location.DescribeRouteCalculator

Description

Retrieves the route calculator resource details.

Synopsis

Creating a Request

data DescribeRouteCalculator Source #

See: newDescribeRouteCalculator smart constructor.

Constructors

DescribeRouteCalculator' 

Fields

Instances

Instances details
Eq DescribeRouteCalculator Source # 
Instance details

Defined in Amazonka.Location.DescribeRouteCalculator

Methods

(==) :: DescribeRouteCalculator -> DescribeRouteCalculator -> Bool #

(/=) :: DescribeRouteCalculator -> DescribeRouteCalculator -> Bool #

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 #

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 #

NFData DescribeRouteCalculator Source # 
Instance details

Defined in Amazonka.Location.DescribeRouteCalculator

Methods

rnf :: DescribeRouteCalculator -> () #

Hashable DescribeRouteCalculator Source # 
Instance details

Defined in Amazonka.Location.DescribeRouteCalculator

Methods

hashWithSalt :: Int -> DescribeRouteCalculator -> Int #

hash :: DescribeRouteCalculator -> Int #

AWSRequest DescribeRouteCalculator Source # 
Instance details

Defined in Amazonka.Location.DescribeRouteCalculator

Associated Types

type AWSResponse DescribeRouteCalculator #

Methods

request :: DescribeRouteCalculator -> Request DescribeRouteCalculator #

response :: MonadResource m => Logger -> Service -> Proxy DescribeRouteCalculator -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeRouteCalculator))) #

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 #

type Rep DescribeRouteCalculator Source # 
Instance details

Defined in Amazonka.Location.DescribeRouteCalculator

type Rep DescribeRouteCalculator = D1 ('MetaData "DescribeRouteCalculator" "Amazonka.Location.DescribeRouteCalculator" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "DescribeRouteCalculator'" 'PrefixI 'True) (S1 ('MetaSel ('Just "calculatorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeRouteCalculator Source # 
Instance details

Defined in Amazonka.Location.DescribeRouteCalculator

type AWSResponse DescribeRouteCalculator = DescribeRouteCalculatorResponse

newDescribeRouteCalculator Source #

Arguments

:: Text

$sel:calculatorName: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:

$sel:calculatorName: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

  • 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 :: POSIX

    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.

  • pricingPlan :: PricingPlan

    The pricing plan selected for the specified route calculator resource.

    For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

  • updateTime :: POSIX

    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
Eq DescribeRouteCalculatorResponse Source # 
Instance details

Defined in Amazonka.Location.DescribeRouteCalculator

Methods

(==) :: DescribeRouteCalculatorResponse -> DescribeRouteCalculatorResponse -> Bool #

(/=) :: DescribeRouteCalculatorResponse -> DescribeRouteCalculatorResponse -> Bool #

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 #

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 #

NFData DescribeRouteCalculatorResponse Source # 
Instance details

Defined in Amazonka.Location.DescribeRouteCalculator

Methods

rnf :: DescribeRouteCalculatorResponse -> () #

type Rep DescribeRouteCalculatorResponse Source # 
Instance details

Defined in Amazonka.Location.DescribeRouteCalculator

type Rep DescribeRouteCalculatorResponse = D1 ('MetaData "DescribeRouteCalculatorResponse" "Amazonka.Location.DescribeRouteCalculator" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "DescribeRouteCalculatorResponse'" 'PrefixI 'True) (((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 POSIX) :*: S1 ('MetaSel ('Just "dataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "pricingPlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PricingPlan) :*: S1 ('MetaSel ('Just "updateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newDescribeRouteCalculatorResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeRouteCalculatorResponse'

-> Text

$sel:calculatorArn:DescribeRouteCalculatorResponse'

-> Text

$sel:calculatorName:DescribeRouteCalculator'

-> UTCTime

$sel:createTime:DescribeRouteCalculatorResponse'

-> Text

$sel:dataSource:DescribeRouteCalculatorResponse'

-> Text

$sel:description:DescribeRouteCalculatorResponse'

-> PricingPlan

$sel:pricingPlan:DescribeRouteCalculatorResponse'

-> UTCTime

$sel:updateTime: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:

$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

$sel:calculatorName:DescribeRouteCalculator', describeRouteCalculatorResponse_calculatorName - The name of the route calculator resource being described.

$sel:createTime: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

$sel:dataSource: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.

$sel:description:DescribeRouteCalculatorResponse', describeRouteCalculatorResponse_description - The optional description of the route calculator resource.

$sel:pricingPlan:DescribeRouteCalculatorResponse', describeRouteCalculatorResponse_pricingPlan - The pricing plan selected for the specified route calculator resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

$sel:updateTime: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_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_pricingPlan :: Lens' DescribeRouteCalculatorResponse PricingPlan Source #

The pricing plan selected for the specified route calculator resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

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