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 |
Creates a route calculator resource in your AWS account.
You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details.
Synopsis
- data CreateRouteCalculator = CreateRouteCalculator' {
- description :: Maybe Text
- pricingPlan :: Maybe PricingPlan
- tags :: Maybe (HashMap Text Text)
- calculatorName :: Text
- dataSource :: Text
- newCreateRouteCalculator :: Text -> Text -> CreateRouteCalculator
- createRouteCalculator_description :: Lens' CreateRouteCalculator (Maybe Text)
- createRouteCalculator_pricingPlan :: Lens' CreateRouteCalculator (Maybe PricingPlan)
- createRouteCalculator_tags :: Lens' CreateRouteCalculator (Maybe (HashMap Text Text))
- createRouteCalculator_calculatorName :: Lens' CreateRouteCalculator Text
- createRouteCalculator_dataSource :: Lens' CreateRouteCalculator Text
- data CreateRouteCalculatorResponse = CreateRouteCalculatorResponse' {}
- newCreateRouteCalculatorResponse :: Int -> Text -> Text -> UTCTime -> CreateRouteCalculatorResponse
- createRouteCalculatorResponse_httpStatus :: Lens' CreateRouteCalculatorResponse Int
- createRouteCalculatorResponse_calculatorArn :: Lens' CreateRouteCalculatorResponse Text
- createRouteCalculatorResponse_calculatorName :: Lens' CreateRouteCalculatorResponse Text
- createRouteCalculatorResponse_createTime :: Lens' CreateRouteCalculatorResponse UTCTime
Creating a Request
data CreateRouteCalculator Source #
See: newCreateRouteCalculator
smart constructor.
CreateRouteCalculator' | |
|
Instances
newCreateRouteCalculator Source #
Create a value of CreateRouteCalculator
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:
CreateRouteCalculator
, createRouteCalculator_description
- The optional description for the route calculator resource.
CreateRouteCalculator
, createRouteCalculator_pricingPlan
- No longer used. If included, the only allowed value is
RequestBasedUsage
.
$sel:tags:CreateRouteCalculator'
, createRouteCalculator_tags
- Applies one or more tags to the route calculator resource. A tag is a
key-value pair helps manage, identify, search, and filter your resources
by labelling them.
- For example: {
"tag1" : "value1"
,"tag2" : "value2"
}
Format: "key" : "value"
Restrictions:
- Maximum 50 tags per resource
- Each resource tag must be unique with a maximum of one value.
- Maximum key length: 128 Unicode characters in UTF-8
- Maximum value length: 256 Unicode characters in UTF-8
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
- Cannot use "aws:" as a prefix for a key.
CreateRouteCalculator
, createRouteCalculator_calculatorName
- The name of the route calculator resource.
Requirements:
- Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
- Must be a unique Route calculator resource name.
- No spaces allowed. For example,
ExampleRouteCalculator
.
CreateRouteCalculator
, createRouteCalculator_dataSource
- Specifies the data provider of traffic and road network data.
This field is case-sensitive. Enter the valid values as shown. For
example, entering HERE
returns an error. Route calculators that use
Esri as a data source only calculate routes that are shorter than 400
km.
Valid values include:
Esri
– For additional information about Esri's coverage in your region of interest, see Esri details on street networks and traffic coverage.Here
– For additional information about HERE Technologies' coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage.
For additional information , see Data providers on the Amazon Location Service Developer Guide.
Request Lenses
createRouteCalculator_description :: Lens' CreateRouteCalculator (Maybe Text) Source #
The optional description for the route calculator resource.
createRouteCalculator_pricingPlan :: Lens' CreateRouteCalculator (Maybe PricingPlan) Source #
No longer used. If included, the only allowed value is
RequestBasedUsage
.
createRouteCalculator_tags :: Lens' CreateRouteCalculator (Maybe (HashMap Text Text)) Source #
Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
- For example: {
"tag1" : "value1"
,"tag2" : "value2"
}
Format: "key" : "value"
Restrictions:
- Maximum 50 tags per resource
- Each resource tag must be unique with a maximum of one value.
- Maximum key length: 128 Unicode characters in UTF-8
- Maximum value length: 256 Unicode characters in UTF-8
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
- Cannot use "aws:" as a prefix for a key.
createRouteCalculator_calculatorName :: Lens' CreateRouteCalculator Text Source #
The name of the route calculator resource.
Requirements:
- Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
- Must be a unique Route calculator resource name.
- No spaces allowed. For example,
ExampleRouteCalculator
.
createRouteCalculator_dataSource :: Lens' CreateRouteCalculator Text Source #
Specifies the data provider of traffic and road network data.
This field is case-sensitive. Enter the valid values as shown. For
example, entering HERE
returns an error. Route calculators that use
Esri as a data source only calculate routes that are shorter than 400
km.
Valid values include:
Esri
– For additional information about Esri's coverage in your region of interest, see Esri details on street networks and traffic coverage.Here
– For additional information about HERE Technologies' coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage.
For additional information , see Data providers on the Amazon Location Service Developer Guide.
Destructuring the Response
data CreateRouteCalculatorResponse Source #
See: newCreateRouteCalculatorResponse
smart constructor.
CreateRouteCalculatorResponse' | |
|
Instances
newCreateRouteCalculatorResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> UTCTime | |
-> CreateRouteCalculatorResponse |
Create a value of CreateRouteCalculatorResponse
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:httpStatus:CreateRouteCalculatorResponse'
, createRouteCalculatorResponse_httpStatus
- The response's http status code.
$sel:calculatorArn:CreateRouteCalculatorResponse'
, createRouteCalculatorResponse_calculatorArn
- The Amazon Resource Name (ARN) for the route calculator resource. Use
the ARN when you specify a resource across all AWS.
- Format example:
arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
CreateRouteCalculator
, createRouteCalculatorResponse_calculatorName
- The name of the route calculator resource.
- For example,
ExampleRouteCalculator
.
CreateRouteCalculatorResponse
, createRouteCalculatorResponse_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
Response Lenses
createRouteCalculatorResponse_httpStatus :: Lens' CreateRouteCalculatorResponse Int Source #
The response's http status code.
createRouteCalculatorResponse_calculatorArn :: Lens' CreateRouteCalculatorResponse Text Source #
The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS.
- Format example:
arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
createRouteCalculatorResponse_calculatorName :: Lens' CreateRouteCalculatorResponse Text Source #
The name of the route calculator resource.
- For example,
ExampleRouteCalculator
.
createRouteCalculatorResponse_createTime :: Lens' CreateRouteCalculatorResponse 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