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 place index resource in your Amazon Web Services account. Use a place
// index resource to geocode addresses and other text queries by using the
// SearchPlaceIndexForText operation, and reverse geocode coordinates by using the
// SearchPlaceIndexForPosition operation, and enable autosuggestions by using the
// SearchPlaceIndexForSuggestions operation. 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) CreatePlaceIndex(ctx context.Context, params *CreatePlaceIndexInput, optFns ...func(*Options)) (*CreatePlaceIndexOutput, error) {
if params == nil {
params = &CreatePlaceIndexInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreatePlaceIndex", params, optFns, c.addOperationCreatePlaceIndexMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreatePlaceIndexOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreatePlaceIndexInput struct {
// Specifies the geospatial data provider for the new place index. 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 geocoding coverage (https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm)
// .
// - Grab – Grab provides place index 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 details on goecoding coverage (https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html)
// . If you specify HERE Technologies ( Here ) as the data provider, you may not
// store results (https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html)
// for locations in Japan. For more information, see the Amazon Web Services
// Service Terms (http://aws.amazon.com/service-terms/) for Amazon Location
// Service.
// 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 name of the place index resource. Requirements:
// - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods
// (.), and underscores (_).
// - Must be a unique place index resource name.
// - No spaces allowed. For example, ExamplePlaceIndex .
//
// This member is required.
IndexName *string
// Specifies the data storage option requesting Places.
DataSourceConfiguration *types.DataSourceConfiguration
// The optional description for the place index 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 place index resource. A tag is a key-value pair
// that helps you manage, identify, search, and filter your resources. Format:
// "key" : "value" Restrictions:
// - Maximum 50 tags per resource.
// - Each tag key must be unique and must have exactly one associated 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 CreatePlaceIndexOutput struct {
// The timestamp for when the place index resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html)
// format: YYYY-MM-DDThh:mm:ss.sssZ .
//
// This member is required.
CreateTime *time.Time
// The Amazon Resource Name (ARN) for the place index resource. Used to specify a
// resource across Amazon Web Services.
// - Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
//
// This member is required.
IndexArn *string
// The name for the place index resource.
//
// This member is required.
IndexName *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreatePlaceIndexMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreatePlaceIndex{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreatePlaceIndex{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreatePlaceIndex"); 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_opCreatePlaceIndexMiddleware(stack); err != nil {
return err
}
if err = addOpCreatePlaceIndexValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreatePlaceIndex(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_opCreatePlaceIndexMiddleware struct {
}
func (*endpointPrefix_opCreatePlaceIndexMiddleware) ID() string {
return "EndpointHostPrefix"
}
func (m *endpointPrefix_opCreatePlaceIndexMiddleware) 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.places." + req.URL.Host
return next.HandleFinalize(ctx, in)
}
func addEndpointPrefix_opCreatePlaceIndexMiddleware(stack *middleware.Stack) error {
return stack.Finalize.Insert(&endpointPrefix_opCreatePlaceIndexMiddleware{}, "ResolveEndpointV2", middleware.After)
}
func newServiceMetadataMiddleware_opCreatePlaceIndex(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreatePlaceIndex",
}
}
|