1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package location
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/location/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Creates a route calculator resource in your Amazon Web Services 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 must not use Esri as your geolocation provider. See section 82 of the
// Amazon Web Services service terms (http://aws.amazon.com/service-terms) for more
// details.
func (c *Client) CreateRouteCalculator(ctx context.Context, params *CreateRouteCalculatorInput, optFns ...func(*Options)) (*CreateRouteCalculatorOutput, error) {
if params == nil {
params = &CreateRouteCalculatorInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateRouteCalculator", params, optFns, c.addOperationCreateRouteCalculatorMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateRouteCalculatorOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateRouteCalculatorInput struct {
// 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 .
//
// This member is required.
CalculatorName *string
// 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. Valid values include:
// - Esri – For additional information about Esri (https://docs.aws.amazon.com/location/latest/developerguide/esri.html)
// 's coverage in your region of interest, see Esri details on street networks
// and traffic coverage (https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm)
// . Route calculators that use Esri as a data source only calculate routes that
// are shorter than 400 km.
// - Grab – Grab provides routing functionality for Southeast Asia. For
// additional information about GrabMaps (https://docs.aws.amazon.com/location/latest/developerguide/grab.html)
// ' coverage, see GrabMaps countries and areas covered (https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area)
// .
// - Here – For additional information about HERE Technologies (https://docs.aws.amazon.com/location/latest/developerguide/HERE.html)
// ' coverage in your region of interest, see HERE car routing coverage (https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html)
// and HERE truck routing coverage (https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html)
// .
// For additional information , see Data providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html)
// on the Amazon Location Service Developer Guide.
//
// This member is required.
DataSource *string
// The optional description for the route calculator resource.
Description *string
// No longer used. If included, the only allowed value is RequestBasedUsage .
//
// Deprecated: Deprecated. If included, the only allowed value is
// RequestBasedUsage.
PricingPlan types.PricingPlan
// 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.
Tags map[string]string
noSmithyDocumentSerde
}
type CreateRouteCalculatorOutput struct {
// The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN
// when you specify a resource across all Amazon Web Services.
// - Format example:
// arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
//
// This member is required.
CalculatorArn *string
// The name of the route calculator resource.
// - For example, ExampleRouteCalculator .
//
// This member is required.
CalculatorName *string
// The timestamp when the route calculator resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html)
// format: YYYY-MM-DDThh:mm:ss.sssZ .
// - For example, 2020–07-2T12:15:20.000Z+01:00
//
// This member is required.
CreateTime *time.Time
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateRouteCalculatorMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreateRouteCalculator{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreateRouteCalculator{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateRouteCalculator"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addEndpointPrefix_opCreateRouteCalculatorMiddleware(stack); err != nil {
return err
}
if err = addOpCreateRouteCalculatorValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateRouteCalculator(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
type endpointPrefix_opCreateRouteCalculatorMiddleware struct {
}
func (*endpointPrefix_opCreateRouteCalculatorMiddleware) ID() string {
return "EndpointHostPrefix"
}
func (m *endpointPrefix_opCreateRouteCalculatorMiddleware) HandleFinalize(ctx context.Context, in middleware.FinalizeInput, next middleware.FinalizeHandler) (
out middleware.FinalizeOutput, metadata middleware.Metadata, err error,
) {
if smithyhttp.GetHostnameImmutable(ctx) || smithyhttp.IsEndpointHostPrefixDisabled(ctx) {
return next.HandleFinalize(ctx, in)
}
req, ok := in.Request.(*smithyhttp.Request)
if !ok {
return out, metadata, fmt.Errorf("unknown transport type %T", in.Request)
}
req.URL.Host = "cp.routes." + req.URL.Host
return next.HandleFinalize(ctx, in)
}
func addEndpointPrefix_opCreateRouteCalculatorMiddleware(stack *middleware.Stack) error {
return stack.Finalize.Insert(&endpointPrefix_opCreateRouteCalculatorMiddleware{}, "ResolveEndpointV2", middleware.After)
}
func newServiceMetadataMiddleware_opCreateRouteCalculator(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateRouteCalculator",
}
}
|