location

package module
v1.42.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 44 Imported by: 12

Documentation

Overview

Package location provides the API client, operations, and parameter types for Amazon Location Service.

"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"

Index

Constants

View Source 
const ServiceAPIVersion = "2020-11-19"
View Source 
const ServiceID = "Location"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.26.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.30.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.30.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AssociateTrackerConsumerInput 

type AssociateTrackerConsumerInput struct {

	// The Amazon Resource Name (ARN) for the geofence collection to be associated to
	// tracker resource. Used when you need to specify a resource across all Amazon Web
	// Services.
	//
	//   - Format example:
	//   arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
	//
	// This member is required.
	ConsumerArn *string

	// The name of the tracker resource to be associated with a geofence collection.
	//
	// This member is required.
	TrackerName *string
	// contains filtered or unexported fields
}

type AssociateTrackerConsumerOutput 

type AssociateTrackerConsumerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.30.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.30.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchDeleteDevicePositionHistoryInput added in v1.2.0 

type BatchDeleteDevicePositionHistoryInput struct {

	// Devices whose position history you want to delete.
	//
	//   - For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]
	//
	// This member is required.
	DeviceIds []string

	// The name of the tracker resource to delete the device position history from.
	//
	// This member is required.
	TrackerName *string
	// contains filtered or unexported fields
}

type BatchDeleteDevicePositionHistoryOutput added in v1.2.0 

type BatchDeleteDevicePositionHistoryOutput struct {

	// Contains error details for each device history that failed to delete.
	//
	// This member is required.
	Errors []types.BatchDeleteDevicePositionHistoryError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchDeleteGeofenceInput 

type BatchDeleteGeofenceInput struct {

	// The geofence collection storing the geofences to be deleted.
	//
	// This member is required.
	CollectionName *string

	// The batch of geofences to be deleted.
	//
	// This member is required.
	GeofenceIds []string
	// contains filtered or unexported fields
}

type BatchDeleteGeofenceOutput 

type BatchDeleteGeofenceOutput struct {

	// Contains error details for each geofence that failed to delete.
	//
	// This member is required.
	Errors []types.BatchDeleteGeofenceError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchEvaluateGeofencesInput 

type BatchEvaluateGeofencesInput struct {

	// The geofence collection used in evaluating the position of devices against its
	// geofences.
	//
	// This member is required.
	CollectionName *string

	// Contains device details for each device to be evaluated against the given
	// geofence collection.
	//
	// This member is required.
	DevicePositionUpdates []types.DevicePositionUpdate
	// contains filtered or unexported fields
}

type BatchEvaluateGeofencesOutput 

type BatchEvaluateGeofencesOutput struct {

	// Contains error details for each device that failed to evaluate its position
	// against the given geofence collection.
	//
	// This member is required.
	Errors []types.BatchEvaluateGeofencesError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchGetDevicePositionInput 

type BatchGetDevicePositionInput struct {

	// Devices whose position you want to retrieve.
	//
	//   - For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2
	//
	// This member is required.
	DeviceIds []string

	// The tracker resource retrieving the device position.
	//
	// This member is required.
	TrackerName *string
	// contains filtered or unexported fields
}

type BatchGetDevicePositionOutput 

type BatchGetDevicePositionOutput struct {

	// Contains device position details such as the device ID, position, and
	// timestamps for when the position was received and sampled.
	//
	// This member is required.
	DevicePositions []types.DevicePosition

	// Contains error details for each device that failed to send its position to the
	// tracker resource.
	//
	// This member is required.
	Errors []types.BatchGetDevicePositionError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchPutGeofenceInput 

type BatchPutGeofenceInput struct {

	// The geofence collection storing the geofences.
	//
	// This member is required.
	CollectionName *string

	// The batch of geofences to be stored in a geofence collection.
	//
	// This member is required.
	Entries []types.BatchPutGeofenceRequestEntry
	// contains filtered or unexported fields
}

type BatchPutGeofenceOutput 

type BatchPutGeofenceOutput struct {

	// Contains additional error details for each geofence that failed to be stored in
	// a geofence collection.
	//
	// This member is required.
	Errors []types.BatchPutGeofenceError

	// Contains each geofence that was successfully stored in a geofence collection.
	//
	// This member is required.
	Successes []types.BatchPutGeofenceSuccess

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchUpdateDevicePositionInput 

type BatchUpdateDevicePositionInput struct {

	// The name of the tracker resource to update.
	//
	// This member is required.
	TrackerName *string

	// Contains the position update details for each device, up to 10 devices.
	//
	// This member is required.
	Updates []types.DevicePositionUpdate
	// contains filtered or unexported fields
}

type BatchUpdateDevicePositionOutput 

type BatchUpdateDevicePositionOutput struct {

	// Contains error details for each device that failed to update its position.
	//
	// This member is required.
	Errors []types.BatchUpdateDevicePositionError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CalculateRouteInput added in v1.2.0 

type CalculateRouteInput struct {

	// The name of the route calculator resource that you want to use to calculate the
	// route.
	//
	// This member is required.
	CalculatorName *string

	// The start position for the route. Defined in [World Geodetic System (WGS 84)] format: [longitude, latitude] .
	//
	//   - For example, [-123.115, 49.285]
	//
	// If you specify a departure that's not located on a road, Amazon Location [moves the position to the nearest road]. If
	// Esri is the provider for your route calculator, specifying a route that is
	// longer than 400 km returns a 400 RoutesValidationException error.
	//
	// Valid Values: [-180 to 180,-90 to 90]
	//
	// [moves the position to the nearest road]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
	// [World Geodetic System (WGS 84)]: https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84
	//
	// This member is required.
	DeparturePosition []float64

	// The finish position for the route. Defined in [World Geodetic System (WGS 84)] format: [longitude, latitude] .
	//
	//   - For example, [-122.339, 47.615]
	//
	// If you specify a destination that's not located on a road, Amazon Location [moves the position to the nearest road].
	//
	// Valid Values: [-180 to 180,-90 to 90]
	//
	// [moves the position to the nearest road]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
	// [World Geodetic System (WGS 84)]: https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84
	//
	// This member is required.
	DestinationPosition []float64

	// Specifies the desired time of arrival. Uses the given time to calculate the
	// route. Otherwise, the best time of day to travel with the best traffic
	// conditions is used to calculate the route.
	//
	// ArrivalTime is not supported Esri.
	ArrivalTime *time.Time

	// Specifies route preferences when traveling by Car , such as avoiding routes that
	// use ferries or tolls.
	//
	// Requirements: TravelMode must be specified as Car .
	CarModeOptions *types.CalculateRouteCarModeOptions

	// Sets the time of departure as the current time. Uses the current time to
	// calculate a route. Otherwise, the best time of day to travel with the best
	// traffic conditions is used to calculate the route.
	//
	// Default Value: false
	//
	// Valid Values: false | true
	DepartNow *bool

	// Specifies the desired time of departure. Uses the given time to calculate the
	// route. Otherwise, the best time of day to travel with the best traffic
	// conditions is used to calculate the route.
	//
	//   - In [ISO 8601]format: YYYY-MM-DDThh:mm:ss.sssZ . For example,
	//   2020–07-2T12:15:20.000Z+01:00
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	DepartureTime *time.Time

	// Set the unit system to specify the distance.
	//
	// Default Value: Kilometers
	DistanceUnit types.DistanceUnit

	// Set to include the geometry details in the result for each path between a pair
	// of positions.
	//
	// Default Value: false
	//
	// Valid Values: false | true
	IncludeLegGeometry *bool

	// The optional [API key] to authorize the request.
	//
	// [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
	Key *string

	// Specifies the distance to optimize for when calculating a route.
	OptimizeFor types.OptimizationMode

	// Specifies the mode of transport when calculating a route. Used in estimating
	// the speed of travel and road compatibility. You can choose Car , Truck , Walking
	// , Bicycle or Motorcycle as options for the TravelMode .
	//
	// Bicycle and Motorcycle are only valid when using Grab as a data provider, and
	// only within Southeast Asia.
	//
	// Truck is not available for Grab.
	//
	// For more details on the using Grab for routing, including areas of coverage,
	// see [GrabMaps]in the Amazon Location Service Developer Guide.
	//
	// The TravelMode you specify also determines how you specify route preferences:
	//
	//   - If traveling by Car use the CarModeOptions parameter.
	//
	//   - If traveling by Truck use the TruckModeOptions parameter.
	//
	// Default Value: Car
	//
	// [GrabMaps]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html
	TravelMode types.TravelMode

	// Specifies route preferences when traveling by Truck , such as avoiding routes
	// that use ferries or tolls, and truck specifications to consider when choosing an
	// optimal road.
	//
	// Requirements: TravelMode must be specified as Truck .
	TruckModeOptions *types.CalculateRouteTruckModeOptions

	// Specifies an ordered list of up to 23 intermediate positions to include along a
	// route between the departure position and destination position.
	//
	//   - For example, from the DeparturePosition [-123.115, 49.285] , the route
	//   follows the order that the waypoint positions are given [[-122.757,
	//   49.0021],[-122.349, 47.620]]
	//
	// If you specify a waypoint position that's not located on a road, Amazon
	// Location [moves the position to the nearest road].
	//
	// Specifying more than 23 waypoints returns a 400 ValidationException error.
	//
	// If Esri is the provider for your route calculator, specifying a route that is
	// longer than 400 km returns a 400 RoutesValidationException error.
	//
	// Valid Values: [-180 to 180,-90 to 90]
	//
	// [moves the position to the nearest road]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
	WaypointPositions [][]float64
	// contains filtered or unexported fields
}

type CalculateRouteMatrixInput added in v1.13.0 

type CalculateRouteMatrixInput struct {

	// The name of the route calculator resource that you want to use to calculate the
	// route matrix.
	//
	// This member is required.
	CalculatorName *string

	// The list of departure (origin) positions for the route matrix. An array of
	// points, each of which is itself a 2-value array defined in [WGS 84]format: [longitude,
	// latitude] . For example, [-123.115, 49.285] .
	//
	// Depending on the data provider selected in the route calculator resource there
	// may be additional restrictions on the inputs you can choose. See [Position restrictions]in the Amazon
	// Location Service Developer Guide.
	//
	// For route calculators that use Esri as the data provider, if you specify a
	// departure that's not located on a road, Amazon Location [moves the position to the nearest road]. The snapped value is
	// available in the result in SnappedDeparturePositions .
	//
	// Valid Values: [-180 to 180,-90 to 90]
	//
	// [moves the position to the nearest road]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
	// [WGS 84]: https://earth-info.nga.mil/GandG/wgs84/index.html
	// [Position restrictions]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
	//
	// This member is required.
	DeparturePositions [][]float64

	// The list of destination positions for the route matrix. An array of points,
	// each of which is itself a 2-value array defined in [WGS 84]format: [longitude, latitude]
	// . For example, [-122.339, 47.615]
	//
	// Depending on the data provider selected in the route calculator resource there
	// may be additional restrictions on the inputs you can choose. See [Position restrictions]in the Amazon
	// Location Service Developer Guide.
	//
	// For route calculators that use Esri as the data provider, if you specify a
	// destination that's not located on a road, Amazon Location [moves the position to the nearest road]. The snapped value
	// is available in the result in SnappedDestinationPositions .
	//
	// Valid Values: [-180 to 180,-90 to 90]
	//
	// [moves the position to the nearest road]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
	// [WGS 84]: https://earth-info.nga.mil/GandG/wgs84/index.html
	// [Position restrictions]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
	//
	// This member is required.
	DestinationPositions [][]float64

	// Specifies route preferences when traveling by Car , such as avoiding routes that
	// use ferries or tolls.
	//
	// Requirements: TravelMode must be specified as Car .
	CarModeOptions *types.CalculateRouteCarModeOptions

	// Sets the time of departure as the current time. Uses the current time to
	// calculate the route matrix. You can't set both DepartureTime and DepartNow . If
	// neither is set, the best time of day to travel with the best traffic conditions
	// is used to calculate the route matrix.
	//
	// Default Value: false
	//
	// Valid Values: false | true
	DepartNow *bool

	// Specifies the desired time of departure. Uses the given time to calculate the
	// route matrix. You can't set both DepartureTime and DepartNow . If neither is
	// set, the best time of day to travel with the best traffic conditions is used to
	// calculate the route matrix.
	//
	// Setting a departure time in the past returns a 400 ValidationException error.
	//
	//   - In [ISO 8601]format: YYYY-MM-DDThh:mm:ss.sssZ . For example,
	//   2020–07-2T12:15:20.000Z+01:00
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	DepartureTime *time.Time

	// Set the unit system to specify the distance.
	//
	// Default Value: Kilometers
	DistanceUnit types.DistanceUnit

	// The optional [API key] to authorize the request.
	//
	// [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
	Key *string

	// Specifies the mode of transport when calculating a route. Used in estimating
	// the speed of travel and road compatibility.
	//
	// The TravelMode you specify also determines how you specify route preferences:
	//
	//   - If traveling by Car use the CarModeOptions parameter.
	//
	//   - If traveling by Truck use the TruckModeOptions parameter.
	//
	// Bicycle or Motorcycle are only valid when using Grab as a data provider, and
	// only within Southeast Asia.
	//
	// Truck is not available for Grab.
	//
	// For more information about using Grab as a data provider, see [GrabMaps] in the Amazon
	// Location Service Developer Guide.
	//
	// Default Value: Car
	//
	// [GrabMaps]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html
	TravelMode types.TravelMode

	// Specifies route preferences when traveling by Truck , such as avoiding routes
	// that use ferries or tolls, and truck specifications to consider when choosing an
	// optimal road.
	//
	// Requirements: TravelMode must be specified as Truck .
	TruckModeOptions *types.CalculateRouteTruckModeOptions
	// contains filtered or unexported fields
}

type CalculateRouteMatrixOutput added in v1.13.0 

type CalculateRouteMatrixOutput struct {

	// The calculated route matrix containing the results for all pairs of
	// DeparturePositions to DestinationPositions . Each row corresponds to one entry
	// in DeparturePositions . Each entry in the row corresponds to the route from that
	// entry in DeparturePositions to an entry in DestinationPositions .
	//
	// This member is required.
	RouteMatrix [][]types.RouteMatrixEntry

	// Contains information about the route matrix, DataSource , DistanceUnit ,
	// RouteCount and ErrorCount .
	//
	// This member is required.
	Summary *types.CalculateRouteMatrixSummary

	// For routes calculated using an Esri route calculator resource, departure
	// positions are snapped to the closest road. For Esri route calculator resources,
	// this returns the list of departure/origin positions used for calculation of the
	// RouteMatrix .
	SnappedDeparturePositions [][]float64

	// The list of destination positions for the route matrix used for calculation of
	// the RouteMatrix .
	SnappedDestinationPositions [][]float64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Returns the result of the route matrix calculation.

type CalculateRouteOutput added in v1.2.0 

type CalculateRouteOutput struct {

	// Contains details about each path between a pair of positions included along a
	// route such as: StartPosition , EndPosition , Distance , DurationSeconds ,
	// Geometry , and Steps . The number of legs returned corresponds to one fewer than
	// the total number of positions in the request.
	//
	// For example, a route with a departure position and destination position returns
	// one leg with the positions [snapped to a nearby road]:
	//
	//   - The StartPosition is the departure position.
	//
	//   - The EndPosition is the destination position.
	//
	// A route with a waypoint between the departure and destination position returns
	// two legs with the positions snapped to a nearby road:
	//
	//   - Leg 1: The StartPosition is the departure position . The EndPosition is the
	//   waypoint positon.
	//
	//   - Leg 2: The StartPosition is the waypoint position. The EndPosition is the
	//   destination position.
	//
	// [snapped to a nearby road]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
	//
	// This member is required.
	Legs []types.Leg

	// Contains information about the whole route, such as: RouteBBox , DataSource ,
	// Distance , DistanceUnit , and DurationSeconds .
	//
	// This member is required.
	Summary *types.CalculateRouteSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Returns the result of the route calculation. Metadata includes legs and route summary.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Location Service.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateTrackerConsumer 

func (c *Client) AssociateTrackerConsumer(ctx context.Context, params *AssociateTrackerConsumerInput, optFns ...func(*Options)) (*AssociateTrackerConsumerOutput, error)

Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection.

You can associate up to five geofence collections to each tracker resource.

Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.

func (*Client) BatchDeleteDevicePositionHistory added in v1.2.0 

func (c *Client) BatchDeleteDevicePositionHistory(ctx context.Context, params *BatchDeleteDevicePositionHistoryInput, optFns ...func(*Options)) (*BatchDeleteDevicePositionHistoryOutput, error)

Deletes the position history of one or more devices from a tracker resource.

func (*Client) BatchDeleteGeofence 

func (c *Client) BatchDeleteGeofence(ctx context.Context, params *BatchDeleteGeofenceInput, optFns ...func(*Options)) (*BatchDeleteGeofenceOutput, error)

Deletes a batch of geofences from a geofence collection.

This operation deletes the resource permanently.

func (*Client) BatchEvaluateGeofences 

func (c *Client) BatchEvaluateGeofences(ctx context.Context, params *BatchEvaluateGeofencesInput, optFns ...func(*Options)) (*BatchEvaluateGeofencesOutput, error)

Evaluates device positions against the geofence geometries from a given geofence collection.

This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge:

  • ENTER if Amazon Location determines that the tracked device has entered a geofenced area.

  • EXIT if Amazon Location determines that the tracked device has exited a geofenced area.

The last geofence that a device was observed within is tracked for 30 days after the most recent device position update.

Geofence evaluation uses the given device position. It does not account for the optional Accuracy of a DevicePositionUpdate .

The DeviceID is used as a string to represent the device. You do not need to have a Tracker associated with the DeviceID .

func (*Client) BatchGetDevicePosition 

func (c *Client) BatchGetDevicePosition(ctx context.Context, params *BatchGetDevicePositionInput, optFns ...func(*Options)) (*BatchGetDevicePositionOutput, error)

Lists the latest device positions for requested devices.

func (*Client) BatchPutGeofence 

func (c *Client) BatchPutGeofence(ctx context.Context, params *BatchPutGeofenceInput, optFns ...func(*Options)) (*BatchPutGeofenceOutput, error)

A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.

func (*Client) BatchUpdateDevicePosition 

func (c *Client) BatchUpdateDevicePosition(ctx context.Context, params *BatchUpdateDevicePositionInput, optFns ...func(*Options)) (*BatchUpdateDevicePositionOutput, error)

Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch). Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days.

Position updates are handled based on the PositionFiltering property of the tracker. When PositionFiltering is set to TimeBased , updates are evaluated against linked geofence collections, and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device ID.

When PositionFiltering is set to DistanceBased filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).

When PositionFiltering is set to AccuracyBased filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is neither stored or evaluated if the device has moved less than 15 m. If PositionFiltering is set to AccuracyBased filtering, Amazon Location uses the default value { "Horizontal": 0} when accuracy is not provided on a DevicePositionUpdate .

func (*Client) CalculateRoute added in v1.2.0 

func (c *Client) CalculateRoute(ctx context.Context, params *CalculateRouteInput, optFns ...func(*Options)) (*CalculateRouteOutput, error)

Calculates a route given the following required parameters: DeparturePosition and DestinationPosition . Requires that you first create a route calculator resource.

By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route.

Additional options include:

Specifying a departure time

  • using either DepartureTime or DepartNow . This calculates a route based on predictive traffic data at the given time.

You can't specify both DepartureTime and DepartNow in a single request. 

Specifying both parameters returns a validation error.

Specifying a travel mode

  • using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in CarModeOptions if traveling by Car , or TruckModeOptions if traveling by Truck .

If you specify walking for the travel mode and your data provider is Esri, the 

start and destination must be within 40km.

func (*Client) CalculateRouteMatrix added in v1.13.0 

func (c *Client) CalculateRouteMatrix(ctx context.Context, params *CalculateRouteMatrixInput, optFns ...func(*Options)) (*CalculateRouteMatrixOutput, error)

Calculates a route matrix given the following required parameters: DeparturePositions and DestinationPositions . CalculateRouteMatrix calculates routes and returns the travel time and travel distance from each departure position to each destination position in the request. For example, given departure positions A and B, and destination positions X and Y, CalculateRouteMatrix will return time and distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned (and routes calculated) will be the number of DeparturePositions times the number of DestinationPositions .

Your account is charged for each route calculated, not the number of requests.

Requires that you first create a route calculator resource.

By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating routes.

Additional options include:

Specifying a departure time

  • using either DepartureTime or DepartNow . This calculates routes based on predictive traffic data at the given time.

You can't specify both DepartureTime and DepartNow in a single request. 

Specifying both parameters returns a validation error.

Specifying a travel mode

  • using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in CarModeOptions if traveling by Car , or TruckModeOptions if traveling by Truck .

func (*Client) CreateGeofenceCollection 

func (c *Client) CreateGeofenceCollection(ctx context.Context, params *CreateGeofenceCollectionInput, optFns ...func(*Options)) (*CreateGeofenceCollectionOutput, error)

Creates a geofence collection, which manages and stores geofences.

func (*Client) CreateKey added in v1.22.0 

func (c *Client) CreateKey(ctx context.Context, params *CreateKeyInput, optFns ...func(*Options)) (*CreateKeyOutput, error)

Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer.

For more information, see Using API keys.

func (*Client) CreateMap 

func (c *Client) CreateMap(ctx context.Context, params *CreateMapInput, optFns ...func(*Options)) (*CreateMapOutput, error)

Creates a map resource in your Amazon Web Services account, which provides map tiles of different styles sourced from global location data providers.

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 termsfor more details.

func (*Client) CreatePlaceIndex 

func (c *Client) CreatePlaceIndex(ctx context.Context, params *CreatePlaceIndexInput, optFns ...func(*Options)) (*CreatePlaceIndexOutput, error)

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 termsfor more details.

func (*Client) CreateRouteCalculator added in v1.2.0 

func (c *Client) CreateRouteCalculator(ctx context.Context, params *CreateRouteCalculatorInput, optFns ...func(*Options)) (*CreateRouteCalculatorOutput, error)

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 termsfor more details.

func (*Client) CreateTracker 

func (c *Client) CreateTracker(ctx context.Context, params *CreateTrackerInput, optFns ...func(*Options)) (*CreateTrackerOutput, error)

Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.

func (*Client) DeleteGeofenceCollection 

func (c *Client) DeleteGeofenceCollection(ctx context.Context, params *DeleteGeofenceCollectionInput, optFns ...func(*Options)) (*DeleteGeofenceCollectionOutput, error)

Deletes a geofence collection from your Amazon Web Services account.

This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.

func (*Client) DeleteKey added in v1.22.0 

func (c *Client) DeleteKey(ctx context.Context, params *DeleteKeyInput, optFns ...func(*Options)) (*DeleteKeyOutput, error)

Deletes the specified API key. The API key must have been deactivated more than 90 days previously.

func (*Client) DeleteMap 

func (c *Client) DeleteMap(ctx context.Context, params *DeleteMapInput, optFns ...func(*Options)) (*DeleteMapOutput, error)

Deletes a map resource from your Amazon Web Services account.

This operation deletes the resource permanently. If the map is being used in an application, the map may not render.

func (*Client) DeletePlaceIndex 

func (c *Client) DeletePlaceIndex(ctx context.Context, params *DeletePlaceIndexInput, optFns ...func(*Options)) (*DeletePlaceIndexOutput, error)

Deletes a place index resource from your Amazon Web Services account.

This operation deletes the resource permanently.

func (*Client) DeleteRouteCalculator added in v1.2.0 

func (c *Client) DeleteRouteCalculator(ctx context.Context, params *DeleteRouteCalculatorInput, optFns ...func(*Options)) (*DeleteRouteCalculatorOutput, error)

Deletes a route calculator resource from your Amazon Web Services account.

This operation deletes the resource permanently.

func (*Client) DeleteTracker 

func (c *Client) DeleteTracker(ctx context.Context, params *DeleteTrackerInput, optFns ...func(*Options)) (*DeleteTrackerOutput, error)

Deletes a tracker resource from your Amazon Web Services account.

This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications.

func (*Client) DescribeGeofenceCollection 

func (c *Client) DescribeGeofenceCollection(ctx context.Context, params *DescribeGeofenceCollectionInput, optFns ...func(*Options)) (*DescribeGeofenceCollectionOutput, error)

Retrieves the geofence collection details.

func (*Client) DescribeKey added in v1.22.0 

func (c *Client) DescribeKey(ctx context.Context, params *DescribeKeyInput, optFns ...func(*Options)) (*DescribeKeyOutput, error)

Retrieves the API key resource details.

func (*Client) DescribeMap 

func (c *Client) DescribeMap(ctx context.Context, params *DescribeMapInput, optFns ...func(*Options)) (*DescribeMapOutput, error)

Retrieves the map resource details.

func (*Client) DescribePlaceIndex 

func (c *Client) DescribePlaceIndex(ctx context.Context, params *DescribePlaceIndexInput, optFns ...func(*Options)) (*DescribePlaceIndexOutput, error)

Retrieves the place index resource details.

func (*Client) DescribeRouteCalculator added in v1.2.0 

func (c *Client) DescribeRouteCalculator(ctx context.Context, params *DescribeRouteCalculatorInput, optFns ...func(*Options)) (*DescribeRouteCalculatorOutput, error)

Retrieves the route calculator resource details.

func (*Client) DescribeTracker 

func (c *Client) DescribeTracker(ctx context.Context, params *DescribeTrackerInput, optFns ...func(*Options)) (*DescribeTrackerOutput, error)

Retrieves the tracker resource details.

func (*Client) DisassociateTrackerConsumer 

func (c *Client) DisassociateTrackerConsumer(ctx context.Context, params *DisassociateTrackerConsumerInput, optFns ...func(*Options)) (*DisassociateTrackerConsumerOutput, error)

Removes the association between a tracker resource and a geofence collection.

Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.

func (*Client) ForecastGeofenceEvents added in v1.38.0 

func (c *Client) ForecastGeofenceEvents(ctx context.Context, params *ForecastGeofenceEventsInput, optFns ...func(*Options)) (*ForecastGeofenceEventsOutput, error)

Evaluates device positions against geofence geometries from a given geofence collection. The event forecasts three states for which a device can be in relative to a geofence:

ENTER : If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

EXIT : If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

IDLE : If a device is inside of a geofence, and the device is not moving.

func (*Client) GetDevicePosition 

func (c *Client) GetDevicePosition(ctx context.Context, params *GetDevicePositionInput, optFns ...func(*Options)) (*GetDevicePositionOutput, error)

Retrieves a device's most recent position according to its sample time.

Device positions are deleted after 30 days.

func (*Client) GetDevicePositionHistory 

func (c *Client) GetDevicePositionHistory(ctx context.Context, params *GetDevicePositionHistoryInput, optFns ...func(*Options)) (*GetDevicePositionHistoryOutput, error)

Retrieves the device position history from a tracker resource within a specified range of time.

Device positions are deleted after 30 days.

func (*Client) GetGeofence 

func (c *Client) GetGeofence(ctx context.Context, params *GetGeofenceInput, optFns ...func(*Options)) (*GetGeofenceOutput, error)

Retrieves the geofence details from a geofence collection.

The returned geometry will always match the geometry format used when the geofence was created.

func (*Client) GetMapGlyphs 

func (c *Client) GetMapGlyphs(ctx context.Context, params *GetMapGlyphsInput, optFns ...func(*Options)) (*GetMapGlyphsOutput, error)

Retrieves glyphs used to display labels on a map.

func (*Client) GetMapSprites 

func (c *Client) GetMapSprites(ctx context.Context, params *GetMapSpritesInput, optFns ...func(*Options)) (*GetMapSpritesOutput, error)

Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.

func (*Client) GetMapStyleDescriptor 

func (c *Client) GetMapStyleDescriptor(ctx context.Context, params *GetMapStyleDescriptorInput, optFns ...func(*Options)) (*GetMapStyleDescriptorOutput, error)

Retrieves the map style descriptor from a map resource.

The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification.

func (*Client) GetMapTile 

func (c *Client) GetMapTile(ctx context.Context, params *GetMapTileInput, optFns ...func(*Options)) (*GetMapTileOutput, error)

Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.

The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).

func (*Client) GetPlace added in v1.19.0 

func (c *Client) GetPlace(ctx context.Context, params *GetPlaceInput, optFns ...func(*Options)) (*GetPlaceOutput, error)

Finds a place by its unique ID. A PlaceId is returned by other search operations.

A PlaceId is valid only if all of the following are the same in the original search request and the call to GetPlace .

  • Customer Amazon Web Services account

  • Amazon Web Services Region

  • Data provider specified in the place index resource

func (*Client) ListDevicePositions added in v1.2.0 

func (c *Client) ListDevicePositions(ctx context.Context, params *ListDevicePositionsInput, optFns ...func(*Options)) (*ListDevicePositionsOutput, error)

A batch request to retrieve all device positions.

func (*Client) ListGeofenceCollections 

func (c *Client) ListGeofenceCollections(ctx context.Context, params *ListGeofenceCollectionsInput, optFns ...func(*Options)) (*ListGeofenceCollectionsOutput, error)

Lists geofence collections in your Amazon Web Services account.

func (*Client) ListGeofences 

func (c *Client) ListGeofences(ctx context.Context, params *ListGeofencesInput, optFns ...func(*Options)) (*ListGeofencesOutput, error)

Lists geofences stored in a given geofence collection.

func (*Client) ListKeys added in v1.22.0 

func (c *Client) ListKeys(ctx context.Context, params *ListKeysInput, optFns ...func(*Options)) (*ListKeysOutput, error)

Lists API key resources in your Amazon Web Services account.

func (*Client) ListMaps 

func (c *Client) ListMaps(ctx context.Context, params *ListMapsInput, optFns ...func(*Options)) (*ListMapsOutput, error)

Lists map resources in your Amazon Web Services account.

func (*Client) ListPlaceIndexes 

func (c *Client) ListPlaceIndexes(ctx context.Context, params *ListPlaceIndexesInput, optFns ...func(*Options)) (*ListPlaceIndexesOutput, error)

Lists place index resources in your Amazon Web Services account.

func (*Client) ListRouteCalculators added in v1.2.0 

func (c *Client) ListRouteCalculators(ctx context.Context, params *ListRouteCalculatorsInput, optFns ...func(*Options)) (*ListRouteCalculatorsOutput, error)

Lists route calculator resources in your Amazon Web Services account.

func (*Client) ListTagsForResource added in v1.2.0 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Returns a list of tags that are applied to the specified Amazon Location resource.

func (*Client) ListTrackerConsumers 

func (c *Client) ListTrackerConsumers(ctx context.Context, params *ListTrackerConsumersInput, optFns ...func(*Options)) (*ListTrackerConsumersOutput, error)

Lists geofence collections currently associated to the given tracker resource.

func (*Client) ListTrackers 

func (c *Client) ListTrackers(ctx context.Context, params *ListTrackersInput, optFns ...func(*Options)) (*ListTrackersOutput, error)

Lists tracker resources in your Amazon Web Services account.

func (*Client) Options added in v1.32.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutGeofence 

func (c *Client) PutGeofence(ctx context.Context, params *PutGeofenceInput, optFns ...func(*Options)) (*PutGeofenceOutput, error)

Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.

func (*Client) SearchPlaceIndexForPosition 

func (c *Client) SearchPlaceIndexForPosition(ctx context.Context, params *SearchPlaceIndexForPositionInput, optFns ...func(*Options)) (*SearchPlaceIndexForPositionOutput, error)

Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.

func (*Client) SearchPlaceIndexForSuggestions added in v1.10.0 

func (c *Client) SearchPlaceIndexForSuggestions(ctx context.Context, params *SearchPlaceIndexForSuggestionsInput, optFns ...func(*Options)) (*SearchPlaceIndexForSuggestionsOutput, error)

Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching.

Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.

You can search for suggested place names near a specified position by using BiasPosition , or filter results within a bounding box by using FilterBBox . These parameters are mutually exclusive; using both BiasPosition and FilterBBox in the same command returns an error.

func (*Client) SearchPlaceIndexForText 

func (c *Client) SearchPlaceIndexForText(ctx context.Context, params *SearchPlaceIndexForTextInput, optFns ...func(*Options)) (*SearchPlaceIndexForTextOutput, error)

Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.

Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.

You can search for places near a given position using BiasPosition , or filter results within a bounding box using FilterBBox . Providing both parameters simultaneously returns an error.

Search results are returned in order of highest to lowest relevance.

func (*Client) TagResource added in v1.2.0 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.

You can use the TagResource operation with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that's already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate up to 50 tags with a resource.

func (*Client) UntagResource added in v1.2.0 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes one or more tags from the specified Amazon Location resource.

func (*Client) UpdateGeofenceCollection added in v1.4.0 

func (c *Client) UpdateGeofenceCollection(ctx context.Context, params *UpdateGeofenceCollectionInput, optFns ...func(*Options)) (*UpdateGeofenceCollectionOutput, error)

Updates the specified properties of a given geofence collection.

func (*Client) UpdateKey added in v1.22.0 

func (c *Client) UpdateKey(ctx context.Context, params *UpdateKeyInput, optFns ...func(*Options)) (*UpdateKeyOutput, error)

Updates the specified properties of a given API key resource.

func (*Client) UpdateMap added in v1.4.0 

func (c *Client) UpdateMap(ctx context.Context, params *UpdateMapInput, optFns ...func(*Options)) (*UpdateMapOutput, error)

Updates the specified properties of a given map resource.

func (*Client) UpdatePlaceIndex added in v1.4.0 

func (c *Client) UpdatePlaceIndex(ctx context.Context, params *UpdatePlaceIndexInput, optFns ...func(*Options)) (*UpdatePlaceIndexOutput, error)

Updates the specified properties of a given place index resource.

func (*Client) UpdateRouteCalculator added in v1.4.0 

func (c *Client) UpdateRouteCalculator(ctx context.Context, params *UpdateRouteCalculatorInput, optFns ...func(*Options)) (*UpdateRouteCalculatorOutput, error)

Updates the specified properties for a given route calculator resource.

func (*Client) UpdateTracker added in v1.4.0 

func (c *Client) UpdateTracker(ctx context.Context, params *UpdateTrackerInput, optFns ...func(*Options)) (*UpdateTrackerOutput, error)

Updates the specified properties of a given tracker resource.

func (*Client) VerifyDevicePosition added in v1.38.0 

func (c *Client) VerifyDevicePosition(ctx context.Context, params *VerifyDevicePositionInput, optFns ...func(*Options)) (*VerifyDevicePositionOutput, error)

Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state.

type CreateGeofenceCollectionInput 

type CreateGeofenceCollectionInput struct {

	// A custom name for the geofence collection.
	//
	// Requirements:
	//
	//   - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods
	//   (.), and underscores (_).
	//
	//   - Must be a unique geofence collection name.
	//
	//   - No spaces allowed. For example, ExampleGeofenceCollection .
	//
	// This member is required.
	CollectionName *string

	// An optional description for the geofence collection.
	Description *string

	// A key identifier for an [Amazon Web Services KMS customer managed key]. Enter a key ID, key ARN, alias name, or alias ARN.
	//
	// [Amazon Web Services KMS customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
	KmsKeyId *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

	// This parameter is no longer used.
	//
	// Deprecated: Deprecated. No longer allowed.
	PricingPlanDataSource *string

	// Applies one or more tags to the geofence collection. A tag is a key-value pair
	// helps manage, identify, search, and filter your resources by labelling them.
	//
	// 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
	// contains filtered or unexported fields
}

type CreateGeofenceCollectionOutput 

type CreateGeofenceCollectionOutput struct {

	// The Amazon Resource Name (ARN) for the geofence collection resource. Used when
	// you need to specify a resource across all Amazon Web Services.
	//
	//   - Format example:
	//   arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
	//
	// This member is required.
	CollectionArn *string

	// The name for the geofence collection.
	//
	// This member is required.
	CollectionName *string

	// The timestamp for when the geofence collection was created in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	CreateTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateKeyInput added in v1.22.0 

type CreateKeyInput struct {

	// A custom name for the API key resource.
	//
	// Requirements:
	//
	//   - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods
	//   (.), and underscores (_).
	//
	//   - Must be a unique API key name.
	//
	//   - No spaces allowed. For example, ExampleAPIKey .
	//
	// This member is required.
	KeyName *string

	// The API key restrictions for the API key resource.
	//
	// This member is required.
	Restrictions *types.ApiKeyRestrictions

	// An optional description for the API key resource.
	Description *string

	// The optional timestamp for when the API key resource will expire in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ . One of NoExpiry or ExpireTime must be set.
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	ExpireTime *time.Time

	// Optionally set to true to set no expiration time for the API key. One of
	// NoExpiry or ExpireTime must be set.
	NoExpiry *bool

	// Applies one or more tags to the map resource. A tag is a key-value pair that
	// helps manage, identify, search, and filter your resources by labelling them.
	//
	// 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
	// contains filtered or unexported fields
}

type CreateKeyOutput added in v1.22.0 

type CreateKeyOutput struct {

	// The timestamp for when the API key resource was created in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	CreateTime *time.Time

	// The key value/string of an API key. This value is used when making API calls to
	// authorize the call. For example, see [GetMapGlyphs].
	//
	// [GetMapGlyphs]: https://docs.aws.amazon.com/location/latest/APIReference/API_GetMapGlyphs.html
	//
	// This member is required.
	Key *string

	// The Amazon Resource Name (ARN) for the API key resource. Used when you need to
	// specify a resource across all Amazon Web Services.
	//
	//   - Format example: arn:aws:geo:region:account-id:key/ExampleKey
	//
	// This member is required.
	KeyArn *string

	// The name of the API key resource.
	//
	// This member is required.
	KeyName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMapInput 

type CreateMapInput struct {

	// Specifies the MapConfiguration , including the map style, for the map resource
	// that you create. The map style defines the look of maps and the data provider
	// for your map resource.
	//
	// This member is required.
	Configuration *types.MapConfiguration

	// The name for the map resource.
	//
	// Requirements:
	//
	//   - Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-),
	//   periods (.), and underscores (_).
	//
	//   - Must be a unique map resource name.
	//
	//   - No spaces allowed. For example, ExampleMap .
	//
	// This member is required.
	MapName *string

	// An optional description for the map 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 map resource. A tag is a key-value pair helps
	// manage, identify, search, and filter your resources by labelling them.
	//
	// 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
	// contains filtered or unexported fields
}

type CreateMapOutput 

type CreateMapOutput struct {

	// The timestamp for when the map resource was created in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	CreateTime *time.Time

	// The Amazon Resource Name (ARN) for the map resource. Used to specify a resource
	// across all Amazon Web Services.
	//
	//   - Format example: arn:aws:geo:region:account-id:map/ExampleMap
	//
	// This member is required.
	MapArn *string

	// The name of the map resource.
	//
	// This member is required.
	MapName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreatePlaceIndexInput 

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]'s coverage in your region of
	//   interest, see [Esri details on geocoding coverage].
	//
	//   - Grab – Grab provides place index functionality for Southeast Asia. For
	//   additional information about [GrabMaps]' coverage, see [GrabMaps countries and areas covered].
	//
	//   - Here – For additional information about [HERE Technologies]' coverage in your region of
	//   interest, see [HERE details on goecoding coverage].
	//
	// If you specify HERE Technologies ( Here ) as the data provider, you may not [store results]for
	//   locations in Japan. For more information, see the [Amazon Web Services Service Terms]for Amazon Location Service.
	//
	// For additional information , see [Data providers] on the Amazon Location Service Developer
	// Guide.
	//
	// [Amazon Web Services Service Terms]: http://aws.amazon.com/service-terms/
	// [Esri]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html
	// [Esri details on geocoding coverage]: https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm
	// [HERE Technologies]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
	// [GrabMaps]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html
	// [Data providers]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
	// [GrabMaps countries and areas covered]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area
	// [store results]: https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html
	// [HERE details on goecoding coverage]: https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html
	//
	// 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
	// contains filtered or unexported fields
}

type CreatePlaceIndexOutput 

type CreatePlaceIndexOutput struct {

	// The timestamp for when the place index resource was created in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// 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
	// contains filtered or unexported fields
}

type CreateRouteCalculatorInput added in v1.2.0 

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]'s coverage in your region of
	//   interest, see [Esri details on street networks and traffic coverage].
	//
	// 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]' coverage, see [GrabMaps countries and areas covered].
	//
	//   - 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.
	//
	// [HERE car routing coverage]: https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html
	// [Esri]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html
	// [HERE truck routing coverage]: https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html
	// [HERE Technologies]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
	// [GrabMaps]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html
	// [Esri details on street networks and traffic coverage]: https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm
	// [Data providers]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
	// [GrabMaps countries and areas covered]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area
	//
	// 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
	// contains filtered or unexported fields
}

type CreateRouteCalculatorOutput added in v1.2.0 

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] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	//   - For example, 2020–07-2T12:15:20.000Z+01:00
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	CreateTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateTrackerInput 

type CreateTrackerInput struct {

	// The name for the tracker resource.
	//
	// Requirements:
	//
	//   - Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods
	//   (.), and underscores (_).
	//
	//   - Must be a unique tracker resource name.
	//
	//   - No spaces allowed. For example, ExampleTracker .
	//
	// This member is required.
	TrackerName *string

	// An optional description for the tracker resource.
	Description *string

	// Whether to enable position UPDATE events from this tracker to be sent to
	// EventBridge.
	//
	// You do not need enable this feature to get ENTER and EXIT events for geofences
	// with this tracker. Those events are always sent to EventBridge.
	EventBridgeEnabled *bool

	// Enables GeospatialQueries for a tracker that uses a [Amazon Web Services KMS customer managed key].
	//
	// This parameter is only used if you are using a KMS customer managed key.
	//
	// If you wish to encrypt your data using your own KMS customer managed key, then
	// the Bounding Polygon Queries feature will be disabled by default. This is
	// because by using this feature, a representation of your device positions will
	// not be encrypted using the your KMS managed key. The exact device position,
	// however; is still encrypted using your managed key.
	//
	// You can choose to opt-in to the Bounding Polygon Quseries feature. This is done
	// by setting the KmsKeyEnableGeospatialQueries parameter to true when creating or
	// updating a Tracker.
	//
	// [Amazon Web Services KMS customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
	KmsKeyEnableGeospatialQueries *bool

	// A key identifier for an [Amazon Web Services KMS customer managed key]. Enter a key ID, key ARN, alias name, or alias ARN.
	//
	// [Amazon Web Services KMS customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
	KmsKeyId *string

	// Specifies the position filtering for the tracker resource.
	//
	// Valid values:
	//
	//   - TimeBased - Location updates are evaluated against linked geofence
	//   collections, but not every location update is stored. If your update frequency
	//   is more often than 30 seconds, only one update per 30 seconds is stored for each
	//   unique device ID.
	//
	//   - DistanceBased - If the device has moved less than 30 m (98.4 ft), location
	//   updates are ignored. Location updates within this area are neither evaluated
	//   against linked geofence collections, nor stored. This helps control costs by
	//   reducing the number of geofence evaluations and historical device positions to
	//   paginate through. Distance-based filtering can also reduce the effects of GPS
	//   noise when displaying device trajectories on a map.
	//
	//   - AccuracyBased - If the device has moved less than the measured accuracy,
	//   location updates are ignored. For example, if two consecutive updates from a
	//   device have a horizontal accuracy of 5 m and 10 m, the second update is ignored
	//   if the device has moved less than 15 m. Ignored location updates are neither
	//   evaluated against linked geofence collections, nor stored. This can reduce the
	//   effects of GPS noise when displaying device trajectories on a map, and can help
	//   control your costs by reducing the number of geofence evaluations.
	//
	// This field is optional. If not specified, the default value is TimeBased .
	PositionFiltering types.PositionFiltering

	// No longer used. If included, the only allowed value is RequestBasedUsage .
	//
	// Deprecated: Deprecated. If included, the only allowed value is
	// RequestBasedUsage.
	PricingPlan types.PricingPlan

	// This parameter is no longer used.
	//
	// Deprecated: Deprecated. No longer allowed.
	PricingPlanDataSource *string

	// Applies one or more tags to the tracker resource. A tag is a key-value pair
	// helps manage, identify, search, and filter your resources by labelling them.
	//
	// 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
	// contains filtered or unexported fields
}

type CreateTrackerOutput 

type CreateTrackerOutput struct {

	// The timestamp for when the tracker resource was created in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	CreateTime *time.Time

	// The Amazon Resource Name (ARN) for the tracker resource. Used when you need to
	// specify a resource across all Amazon Web Services.
	//
	//   - Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker
	//
	// This member is required.
	TrackerArn *string

	// The name of the tracker resource.
	//
	// This member is required.
	TrackerName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteGeofenceCollectionInput 

type DeleteGeofenceCollectionInput struct {

	// The name of the geofence collection to be deleted.
	//
	// This member is required.
	CollectionName *string
	// contains filtered or unexported fields
}

type DeleteGeofenceCollectionOutput 

type DeleteGeofenceCollectionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteKeyInput added in v1.22.0 

type DeleteKeyInput struct {

	// The name of the API key to delete.
	//
	// This member is required.
	KeyName *string

	// ForceDelete bypasses an API key's expiry conditions and deletes the key. Set
	// the parameter true to delete the key or to false to not preemptively delete the
	// API key.
	//
	// Valid values: true , or false .
	//
	// Required: No
	//
	// This action is irreversible. Only use ForceDelete if you are certain the key is
	// no longer in use.
	ForceDelete *bool
	// contains filtered or unexported fields
}

type DeleteKeyOutput added in v1.22.0 

type DeleteKeyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMapInput 

type DeleteMapInput struct {

	// The name of the map resource to be deleted.
	//
	// This member is required.
	MapName *string
	// contains filtered or unexported fields
}

type DeleteMapOutput 

type DeleteMapOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePlaceIndexInput 

type DeletePlaceIndexInput struct {

	// The name of the place index resource to be deleted.
	//
	// This member is required.
	IndexName *string
	// contains filtered or unexported fields
}

type DeletePlaceIndexOutput 

type DeletePlaceIndexOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRouteCalculatorInput added in v1.2.0 

type DeleteRouteCalculatorInput struct {

	// The name of the route calculator resource to be deleted.
	//
	// This member is required.
	CalculatorName *string
	// contains filtered or unexported fields
}

type DeleteRouteCalculatorOutput added in v1.2.0 

type DeleteRouteCalculatorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTrackerInput 

type DeleteTrackerInput struct {

	// The name of the tracker resource to be deleted.
	//
	// This member is required.
	TrackerName *string
	// contains filtered or unexported fields
}

type DeleteTrackerOutput 

type DeleteTrackerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeGeofenceCollectionInput 

type DescribeGeofenceCollectionInput struct {

	// The name of the geofence collection.
	//
	// This member is required.
	CollectionName *string
	// contains filtered or unexported fields
}

type DescribeGeofenceCollectionOutput 

type DescribeGeofenceCollectionOutput struct {

	// The Amazon Resource Name (ARN) for the geofence collection resource. Used when
	// you need to specify a resource across all Amazon Web Services.
	//
	//   - Format example:
	//   arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
	//
	// This member is required.
	CollectionArn *string

	// The name of the geofence collection.
	//
	// This member is required.
	CollectionName *string

	// The timestamp for when the geofence resource was created in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	CreateTime *time.Time

	// The optional description for the geofence collection.
	//
	// This member is required.
	Description *string

	// The timestamp for when the geofence collection was last updated in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	UpdateTime *time.Time

	// The number of geofences in the geofence collection.
	GeofenceCount *int32

	// A key identifier for an [Amazon Web Services KMS customer managed key] assigned to the Amazon Location resource
	//
	// [Amazon Web Services KMS customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
	KmsKeyId *string

	// No longer used. Always returns RequestBasedUsage .
	//
	// Deprecated: Deprecated. Always returns RequestBasedUsage.
	PricingPlan types.PricingPlan

	// No longer used. Always returns an empty string.
	//
	// Deprecated: Deprecated. Unused.
	PricingPlanDataSource *string

	// Displays the key, value pairs of tags associated with this resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeKeyInput added in v1.22.0 

type DescribeKeyInput struct {

	// The name of the API key resource.
	//
	// This member is required.
	KeyName *string
	// contains filtered or unexported fields
}

type DescribeKeyOutput added in v1.22.0 

type DescribeKeyOutput struct {

	// The timestamp for when the API key resource was created in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	CreateTime *time.Time

	// The timestamp for when the API key resource will expire in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	ExpireTime *time.Time

	// The key value/string of an API key.
	//
	// This member is required.
	Key *string

	// The Amazon Resource Name (ARN) for the API key resource. Used when you need to
	// specify a resource across all Amazon Web Services.
	//
	//   - Format example: arn:aws:geo:region:account-id:key/ExampleKey
	//
	// This member is required.
	KeyArn *string

	// The name of the API key resource.
	//
	// This member is required.
	KeyName *string

	// API Restrictions on the allowed actions, resources, and referers for an API key
	// resource.
	//
	// This member is required.
	Restrictions *types.ApiKeyRestrictions

	// The timestamp for when the API key resource was last updated in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	UpdateTime *time.Time

	// The optional description for the API key resource.
	Description *string

	// Tags associated with the API key resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeMapInput 

type DescribeMapInput struct {

	// The name of the map resource.
	//
	// This member is required.
	MapName *string
	// contains filtered or unexported fields
}

type DescribeMapOutput 

type DescribeMapOutput struct {

	// Specifies the map tile style selected from a partner data provider.
	//
	// This member is required.
	Configuration *types.MapConfiguration

	// The timestamp for when the map resource was created in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	CreateTime *time.Time

	// Specifies the data provider for the associated map tiles.
	//
	// This member is required.
	DataSource *string

	// The optional description for the map resource.
	//
	// This member is required.
	Description *string

	// The Amazon Resource Name (ARN) for the map resource. Used to specify a resource
	// across all Amazon Web Services.
	//
	//   - Format example: arn:aws:geo:region:account-id:map/ExampleMap
	//
	// This member is required.
	MapArn *string

	// The map style selected from an available provider.
	//
	// This member is required.
	MapName *string

	// The timestamp for when the map resource was last update in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	UpdateTime *time.Time

	// No longer used. Always returns RequestBasedUsage .
	//
	// Deprecated: Deprecated. Always returns RequestBasedUsage.
	PricingPlan types.PricingPlan

	// Tags associated with the map resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribePlaceIndexInput 

type DescribePlaceIndexInput struct {

	// The name of the place index resource.
	//
	// This member is required.
	IndexName *string
	// contains filtered or unexported fields
}

type DescribePlaceIndexOutput 

type DescribePlaceIndexOutput struct {

	// The timestamp for when the place index resource was created in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	CreateTime *time.Time

	// The data provider of geospatial data. Values can be one of the following:
	//
	//   - Esri
	//
	//   - Grab
	//
	//   - Here
	//
	// For more information about data providers, see [Amazon Location Service data providers].
	//
	// [Amazon Location Service data providers]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
	//
	// This member is required.
	DataSource *string

	// The specified data storage option for requesting Places.
	//
	// This member is required.
	DataSourceConfiguration *types.DataSourceConfiguration

	// The optional description for the place index resource.
	//
	// This member is required.
	Description *string

	// 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 of the place index resource being described.
	//
	// This member is required.
	IndexName *string

	// The timestamp for when the place index resource was last updated in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	UpdateTime *time.Time

	// No longer used. Always returns RequestBasedUsage .
	//
	// Deprecated: Deprecated. Always returns RequestBasedUsage.
	PricingPlan types.PricingPlan

	// Tags associated with place index resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeRouteCalculatorInput added in v1.2.0 

type DescribeRouteCalculatorInput struct {

	// The name of the route calculator resource.
	//
	// This member is required.
	CalculatorName *string
	// contains filtered or unexported fields
}

type DescribeRouteCalculatorOutput added in v1.2.0 

type DescribeRouteCalculatorOutput struct {

	// The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN
	// when you specify a resource across 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 being described.
	//
	// This member is required.
	CalculatorName *string

	// 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
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	CreateTime *time.Time

	// The data provider of traffic and road network data. Indicates one of the
	// available providers:
	//
	//   - Esri
	//
	//   - Grab
	//
	//   - Here
	//
	// For more information about data providers, see [Amazon Location Service data providers].
	//
	// [Amazon Location Service data providers]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
	//
	// This member is required.
	DataSource *string

	// The optional description of the route calculator resource.
	//
	// This member is required.
	Description *string

	// 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
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	UpdateTime *time.Time

	// Always returns RequestBasedUsage .
	//
	// Deprecated: Deprecated. Always returns RequestBasedUsage.
	PricingPlan types.PricingPlan

	// Tags associated with route calculator resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeTrackerInput 

type DescribeTrackerInput struct {

	// The name of the tracker resource.
	//
	// This member is required.
	TrackerName *string
	// contains filtered or unexported fields
}

type DescribeTrackerOutput 

type DescribeTrackerOutput struct {

	// The timestamp for when the tracker resource was created in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	CreateTime *time.Time

	// The optional description for the tracker resource.
	//
	// This member is required.
	Description *string

	// The Amazon Resource Name (ARN) for the tracker resource. Used when you need to
	// specify a resource across all Amazon Web Services.
	//
	//   - Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker
	//
	// This member is required.
	TrackerArn *string

	// The name of the tracker resource.
	//
	// This member is required.
	TrackerName *string

	// The timestamp for when the tracker resource was last updated in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	UpdateTime *time.Time

	// Whether UPDATE events from this tracker in EventBridge are enabled. If set to
	// true these events will be sent to EventBridge.
	EventBridgeEnabled *bool

	// Enables GeospatialQueries for a tracker that uses a [Amazon Web Services KMS customer managed key].
	//
	// This parameter is only used if you are using a KMS customer managed key.
	//
	// If you wish to encrypt your data using your own KMS customer managed key, then
	// the Bounding Polygon Queries feature will be disabled by default. This is
	// because by using this feature, a representation of your device positions will
	// not be encrypted using the your KMS managed key. The exact device position,
	// however; is still encrypted using your managed key.
	//
	// You can choose to opt-in to the Bounding Polygon Quseries feature. This is done
	// by setting the KmsKeyEnableGeospatialQueries parameter to true when creating or
	// updating a Tracker.
	//
	// [Amazon Web Services KMS customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
	KmsKeyEnableGeospatialQueries *bool

	// A key identifier for an [Amazon Web Services KMS customer managed key] assigned to the Amazon Location resource.
	//
	// [Amazon Web Services KMS customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
	KmsKeyId *string

	// The position filtering method of the tracker resource.
	PositionFiltering types.PositionFiltering

	// Always returns RequestBasedUsage .
	//
	// Deprecated: Deprecated. Always returns RequestBasedUsage.
	PricingPlan types.PricingPlan

	// No longer used. Always returns an empty string.
	//
	// Deprecated: Deprecated. Unused.
	PricingPlanDataSource *string

	// The tags associated with the tracker resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateTrackerConsumerInput 

type DisassociateTrackerConsumerInput struct {

	// The Amazon Resource Name (ARN) for the geofence collection to be disassociated
	// from the tracker resource. Used when you need to specify a resource across all
	// Amazon Web Services.
	//
	//   - Format example:
	//   arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
	//
	// This member is required.
	ConsumerArn *string

	// The name of the tracker resource to be dissociated from the consumer.
	//
	// This member is required.
	TrackerName *string
	// contains filtered or unexported fields
}

type DisassociateTrackerConsumerOutput 

type DisassociateTrackerConsumerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.26.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.26.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.26.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.26.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.26.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type ForecastGeofenceEventsAPIClient added in v1.38.0 

type ForecastGeofenceEventsAPIClient interface {
	ForecastGeofenceEvents(context.Context, *ForecastGeofenceEventsInput, ...func(*Options)) (*ForecastGeofenceEventsOutput, error)
}

ForecastGeofenceEventsAPIClient is a client that implements the ForecastGeofenceEvents operation.

type ForecastGeofenceEventsInput added in v1.38.0 

type ForecastGeofenceEventsInput struct {

	// The name of the geofence collection.
	//
	// This member is required.
	CollectionName *string

	// The device's state, including current position and speed.
	//
	// This member is required.
	DeviceState *types.ForecastGeofenceEventsDeviceState

	// The distance unit used for the NearestDistance property returned in a
	// forecasted event. The measurement system must match for DistanceUnit and
	// SpeedUnit ; if Kilometers is specified for DistanceUnit , then SpeedUnit must
	// be KilometersPerHour .
	//
	// Default Value: Kilometers
	DistanceUnit types.DistanceUnit

	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 20
	MaxResults *int32

	// The pagination token specifying which page of results to return in the
	// response. If no token is provided, the default page is the first page.
	//
	// Default value: null
	NextToken *string

	// The speed unit for the device captured by the device state. The measurement
	// system must match for DistanceUnit and SpeedUnit ; if Kilometers is specified
	// for DistanceUnit , then SpeedUnit must be KilometersPerHour .
	//
	// Default Value: KilometersPerHour .
	SpeedUnit types.SpeedUnit

	// Specifies the time horizon in minutes for the forecasted events.
	TimeHorizonMinutes *float64
	// contains filtered or unexported fields
}

type ForecastGeofenceEventsOutput added in v1.38.0 

type ForecastGeofenceEventsOutput struct {

	// The distance unit for the forecasted events.
	//
	// This member is required.
	DistanceUnit types.DistanceUnit

	// The list of forecasted events.
	//
	// This member is required.
	ForecastedEvents []types.ForecastedEvent

	// The speed unit for the forecasted events.
	//
	// This member is required.
	SpeedUnit types.SpeedUnit

	// The pagination token specifying which page of results to return in the
	// response. If no token is provided, the default page is the first page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ForecastGeofenceEventsPaginator added in v1.38.0 

type ForecastGeofenceEventsPaginator struct {
	// contains filtered or unexported fields
}

ForecastGeofenceEventsPaginator is a paginator for ForecastGeofenceEvents

func NewForecastGeofenceEventsPaginator added in v1.38.0 

func NewForecastGeofenceEventsPaginator(client ForecastGeofenceEventsAPIClient, params *ForecastGeofenceEventsInput, optFns ...func(*ForecastGeofenceEventsPaginatorOptions)) *ForecastGeofenceEventsPaginator

NewForecastGeofenceEventsPaginator returns a new ForecastGeofenceEventsPaginator

func (*ForecastGeofenceEventsPaginator) HasMorePages added in v1.38.0 

func (p *ForecastGeofenceEventsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ForecastGeofenceEventsPaginator) NextPage added in v1.38.0 

func (p *ForecastGeofenceEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ForecastGeofenceEventsOutput, error)

NextPage retrieves the next ForecastGeofenceEvents page.

type ForecastGeofenceEventsPaginatorOptions added in v1.38.0 

type ForecastGeofenceEventsPaginatorOptions struct {
	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 20
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ForecastGeofenceEventsPaginatorOptions is the paginator options for ForecastGeofenceEvents

type GetDevicePositionHistoryAPIClient 

type GetDevicePositionHistoryAPIClient interface {
	GetDevicePositionHistory(context.Context, *GetDevicePositionHistoryInput, ...func(*Options)) (*GetDevicePositionHistoryOutput, error)
}

GetDevicePositionHistoryAPIClient is a client that implements the GetDevicePositionHistory operation.

type GetDevicePositionHistoryInput 

type GetDevicePositionHistoryInput struct {

	// The device whose position history you want to retrieve.
	//
	// This member is required.
	DeviceId *string

	// The tracker resource receiving the request for the device position history.
	//
	// This member is required.
	TrackerName *string

	// Specify the end time for the position history in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ . By default, the value will be the time that the
	// request is made.
	//
	// Requirement:
	//
	//   - The time specified for EndTimeExclusive must be after the time for
	//   StartTimeInclusive .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	EndTimeExclusive *time.Time

	// An optional limit for the number of device positions returned in a single call.
	//
	// Default value: 100
	MaxResults *int32

	// The pagination token specifying which page of results to return in the
	// response. If no token is provided, the default page is the first page.
	//
	// Default value: null
	NextToken *string

	// Specify the start time for the position history in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ . By default, the value will be 24 hours prior to the
	// time that the request is made.
	//
	// Requirement:
	//
	//   - The time specified for StartTimeInclusive must be before EndTimeExclusive .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	StartTimeInclusive *time.Time
	// contains filtered or unexported fields
}

type GetDevicePositionHistoryOutput 

type GetDevicePositionHistoryOutput struct {

	// Contains the position history details for the requested device.
	//
	// This member is required.
	DevicePositions []types.DevicePosition

	// A pagination token indicating there are additional pages available. You can use
	// the token in a following request to fetch the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetDevicePositionHistoryPaginator 

type GetDevicePositionHistoryPaginator struct {
	// contains filtered or unexported fields
}

GetDevicePositionHistoryPaginator is a paginator for GetDevicePositionHistory

func NewGetDevicePositionHistoryPaginator 

func NewGetDevicePositionHistoryPaginator(client GetDevicePositionHistoryAPIClient, params *GetDevicePositionHistoryInput, optFns ...func(*GetDevicePositionHistoryPaginatorOptions)) *GetDevicePositionHistoryPaginator

NewGetDevicePositionHistoryPaginator returns a new GetDevicePositionHistoryPaginator

func (*GetDevicePositionHistoryPaginator) HasMorePages 

func (p *GetDevicePositionHistoryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetDevicePositionHistoryPaginator) NextPage 

func (p *GetDevicePositionHistoryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetDevicePositionHistoryOutput, error)

NextPage retrieves the next GetDevicePositionHistory page.

type GetDevicePositionHistoryPaginatorOptions 

type GetDevicePositionHistoryPaginatorOptions struct {
	// An optional limit for the number of device positions returned in a single call.
	//
	// Default value: 100
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetDevicePositionHistoryPaginatorOptions is the paginator options for GetDevicePositionHistory

type GetDevicePositionInput 

type GetDevicePositionInput struct {

	// The device whose position you want to retrieve.
	//
	// This member is required.
	DeviceId *string

	// The tracker resource receiving the position update.
	//
	// This member is required.
	TrackerName *string
	// contains filtered or unexported fields
}

type GetDevicePositionOutput 

type GetDevicePositionOutput struct {

	// The last known device position.
	//
	// This member is required.
	Position []float64

	// The timestamp for when the tracker resource received the device position. Uses [ISO 8601]
	// format: YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	ReceivedTime *time.Time

	// The timestamp at which the device's position was determined. Uses [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	SampleTime *time.Time

	// The accuracy of the device position.
	Accuracy *types.PositionalAccuracy

	// The device whose position you retrieved.
	DeviceId *string

	// The properties associated with the position.
	PositionProperties map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetGeofenceInput 

type GetGeofenceInput struct {

	// The geofence collection storing the target geofence.
	//
	// This member is required.
	CollectionName *string

	// The geofence you're retrieving details for.
	//
	// This member is required.
	GeofenceId *string
	// contains filtered or unexported fields
}

type GetGeofenceOutput 

type GetGeofenceOutput struct {

	// The timestamp for when the geofence collection was created in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	CreateTime *time.Time

	// The geofence identifier.
	//
	// This member is required.
	GeofenceId *string

	// Contains the geofence geometry details describing a polygon or a circle.
	//
	// This member is required.
	Geometry *types.GeofenceGeometry

	// Identifies the state of the geofence. A geofence will hold one of the following
	// states:
	//
	//   - ACTIVE — The geofence has been indexed by the system.
	//
	//   - PENDING — The geofence is being processed by the system.
	//
	//   - FAILED — The geofence failed to be indexed by the system.
	//
	//   - DELETED — The geofence has been deleted from the system index.
	//
	//   - DELETING — The geofence is being deleted from the system index.
	//
	// This member is required.
	Status *string

	// The timestamp for when the geofence collection was last updated in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	UpdateTime *time.Time

	// User defined properties of the geofence. A property is a key-value pair stored
	// with the geofence and added to any geofence event triggered with that geofence.
	//
	// Format: "key" : "value"
	GeofenceProperties map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMapGlyphsInput 

type GetMapGlyphsInput struct {

	// A comma-separated list of fonts to load glyphs from in order of preference. For
	// example, Noto Sans Regular, Arial Unicode .
	//
	// Valid font stacks for [Esri] styles:
	//
	//   - VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | Ubuntu
	//   Italic | Ubuntu Regular | Ubuntu Bold
	//
	//   - VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu Regular | Ubuntu Light |
	//   Ubuntu Bold
	//
	//   - VectorEsriTopographic – Noto Sans Italic | Noto Sans Regular | Noto Sans
	//   Bold | Noto Serif Regular | Roboto Condensed Light Italic
	//
	//   - VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold
	//
	//   - VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold
	//
	// Valid font stacks for [HERE Technologies] styles:
	//
	//   - VectorHereContrast – Fira GO Regular | Fira GO Bold
	//
	//   - VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite –
	//   Fira GO Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold |
	//   Noto Sans CJK JP Light | Noto Sans CJK JP Regular
	//
	// Valid font stacks for [GrabMaps] styles:
	//
	//   - VectorGrabStandardLight, VectorGrabStandardDark – Noto Sans Regular | Noto
	//   Sans Medium | Noto Sans Bold
	//
	// Valid font stacks for [Open Data] styles:
	//
	//   - VectorOpenDataStandardLight, VectorOpenDataStandardDark,
	//   VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – Amazon
	//   Ember Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon
	//   Ember Medium,Noto Sans Medium | Amazon Ember Regular Italic,Noto Sans Italic |
	//   Amazon Ember Condensed RC Regular,Noto Sans Regular | Amazon Ember Condensed
	//   RC Bold,Noto Sans Bold | Amazon Ember Regular,Noto Sans Regular,Noto Sans
	//   Arabic Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans
	//   Arabic Condensed Bold | Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold
	//   | Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular |
	//   Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed
	//   Regular | Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium
	//
	// The fonts used by the Open Data map styles are combined fonts that use Amazon
	// Ember for most glyphs but Noto Sans for glyphs unsupported by Amazon Ember .
	//
	// [Esri]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html
	// [HERE Technologies]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
	// [GrabMaps]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html
	// [Open Data]: https://docs.aws.amazon.com/location/latest/developerguide/open-data.html
	//
	// This member is required.
	FontStack *string

	// A Unicode range of characters to download glyphs for. Each response will
	// contain 256 characters. For example, 0–255 includes all characters from range
	// U+0000 to 00FF . Must be aligned to multiples of 256.
	//
	// This member is required.
	FontUnicodeRange *string

	// The map resource associated with the glyph file.
	//
	// This member is required.
	MapName *string

	// The optional [API key] to authorize the request.
	//
	// [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
	Key *string
	// contains filtered or unexported fields
}

type GetMapGlyphsOutput 

type GetMapGlyphsOutput struct {

	// The glyph, as binary blob.
	Blob []byte

	// The HTTP Cache-Control directive for the value.
	CacheControl *string

	// The map glyph content type. For example, application/octet-stream .
	ContentType *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMapSpritesInput 

type GetMapSpritesInput struct {

	// The name of the sprite file. Use the following file names for the sprite sheet:
	//
	//   - sprites.png
	//
	//   - sprites@2x.png for high pixel density displays
	//
	// For the JSON document containing image offsets. Use the following file names:
	//
	//   - sprites.json
	//
	//   - sprites@2x.json for high pixel density displays
	//
	// This member is required.
	FileName *string

	// The map resource associated with the sprite file.
	//
	// This member is required.
	MapName *string

	// The optional [API key] to authorize the request.
	//
	// [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
	Key *string
	// contains filtered or unexported fields
}

type GetMapSpritesOutput 

type GetMapSpritesOutput struct {

	// Contains the body of the sprite sheet or JSON offset file.
	Blob []byte

	// The HTTP Cache-Control directive for the value.
	CacheControl *string

	// The content type of the sprite sheet and offsets. For example, the sprite sheet
	// content type is image/png , and the sprite offset JSON document is
	// application/json .
	ContentType *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMapStyleDescriptorInput 

type GetMapStyleDescriptorInput struct {

	// The map resource to retrieve the style descriptor from.
	//
	// This member is required.
	MapName *string

	// The optional [API key] to authorize the request.
	//
	// [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
	Key *string
	// contains filtered or unexported fields
}

type GetMapStyleDescriptorOutput 

type GetMapStyleDescriptorOutput struct {

	// Contains the body of the style descriptor.
	Blob []byte

	// The HTTP Cache-Control directive for the value.
	CacheControl *string

	// The style descriptor's content type. For example, application/json .
	ContentType *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMapTileInput 

type GetMapTileInput struct {

	// The map resource to retrieve the map tiles from.
	//
	// This member is required.
	MapName *string

	// The X axis value for the map tile.
	//
	// This member is required.
	X *string

	// The Y axis value for the map tile.
	//
	// This member is required.
	Y *string

	// The zoom value for the map tile.
	//
	// This member is required.
	Z *string

	// The optional [API key] to authorize the request.
	//
	// [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
	Key *string
	// contains filtered or unexported fields
}

type GetMapTileOutput 

type GetMapTileOutput struct {

	// Contains Mapbox Vector Tile (MVT) data.
	Blob []byte

	// The HTTP Cache-Control directive for the value.
	CacheControl *string

	// The map tile's content type. For example, application/vnd.mapbox-vector-tile .
	ContentType *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPlaceInput added in v1.19.0 

type GetPlaceInput struct {

	// The name of the place index resource that you want to use for the search.
	//
	// This member is required.
	IndexName *string

	// The identifier of the place to find.
	//
	// This member is required.
	PlaceId *string

	// The optional [API key] to authorize the request.
	//
	// [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
	Key *string

	// The preferred language used to return results. The value must be a valid [BCP 47]
	// language tag, for example, en for English.
	//
	// This setting affects the languages used in the results, but not the results
	// themselves. If no language is specified, or not supported for a particular
	// result, the partner automatically chooses a language for the result.
	//
	// For an example, we'll use the Greek language. You search for a location around
	// Athens, Greece, with the language parameter set to en . The city in the results
	// will most likely be returned as Athens .
	//
	// If you set the language parameter to el , for Greek, then the city in the
	// results will more likely be returned as Αθήνα .
	//
	// If the data provider does not have a value for Greek, the result will be in a
	// language that the provider does support.
	//
	// [BCP 47]: https://tools.ietf.org/search/bcp47
	Language *string
	// contains filtered or unexported fields
}

type GetPlaceOutput added in v1.19.0 

type GetPlaceOutput struct {

	// Details about the result, such as its address and position.
	//
	// This member is required.
	Place *types.Place

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListDevicePositionsAPIClient added in v1.2.0 

type ListDevicePositionsAPIClient interface {
	ListDevicePositions(context.Context, *ListDevicePositionsInput, ...func(*Options)) (*ListDevicePositionsOutput, error)
}

ListDevicePositionsAPIClient is a client that implements the ListDevicePositions operation.

type ListDevicePositionsInput added in v1.2.0 

type ListDevicePositionsInput struct {

	// The tracker resource containing the requested devices.
	//
	// This member is required.
	TrackerName *string

	// The geometry used to filter device positions.
	FilterGeometry *types.TrackingFilterGeometry

	// An optional limit for the number of entries returned in a single call.
	//
	// Default value: 100
	MaxResults *int32

	// The pagination token specifying which page of results to return in the
	// response. If no token is provided, the default page is the first page.
	//
	// Default value: null
	NextToken *string
	// contains filtered or unexported fields
}

type ListDevicePositionsOutput added in v1.2.0 

type ListDevicePositionsOutput struct {

	// Contains details about each device's last known position.
	//
	// This member is required.
	Entries []types.ListDevicePositionsResponseEntry

	// A pagination token indicating there are additional pages available. You can use
	// the token in a following request to fetch the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDevicePositionsPaginator added in v1.2.0 

type ListDevicePositionsPaginator struct {
	// contains filtered or unexported fields
}

ListDevicePositionsPaginator is a paginator for ListDevicePositions

func NewListDevicePositionsPaginator added in v1.2.0 

func NewListDevicePositionsPaginator(client ListDevicePositionsAPIClient, params *ListDevicePositionsInput, optFns ...func(*ListDevicePositionsPaginatorOptions)) *ListDevicePositionsPaginator

NewListDevicePositionsPaginator returns a new ListDevicePositionsPaginator

func (*ListDevicePositionsPaginator) HasMorePages added in v1.2.0 

func (p *ListDevicePositionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDevicePositionsPaginator) NextPage added in v1.2.0 

func (p *ListDevicePositionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDevicePositionsOutput, error)

NextPage retrieves the next ListDevicePositions page.

type ListDevicePositionsPaginatorOptions added in v1.2.0 

type ListDevicePositionsPaginatorOptions struct {
	// An optional limit for the number of entries returned in a single call.
	//
	// Default value: 100
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDevicePositionsPaginatorOptions is the paginator options for ListDevicePositions

type ListGeofenceCollectionsAPIClient 

type ListGeofenceCollectionsAPIClient interface {
	ListGeofenceCollections(context.Context, *ListGeofenceCollectionsInput, ...func(*Options)) (*ListGeofenceCollectionsOutput, error)
}

ListGeofenceCollectionsAPIClient is a client that implements the ListGeofenceCollections operation.

type ListGeofenceCollectionsInput 

type ListGeofenceCollectionsInput struct {

	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 100
	MaxResults *int32

	// The pagination token specifying which page of results to return in the
	// response. If no token is provided, the default page is the first page.
	//
	// Default value: null
	NextToken *string
	// contains filtered or unexported fields
}

type ListGeofenceCollectionsOutput 

type ListGeofenceCollectionsOutput struct {

	// Lists the geofence collections that exist in your Amazon Web Services account.
	//
	// This member is required.
	Entries []types.ListGeofenceCollectionsResponseEntry

	// A pagination token indicating there are additional pages available. You can use
	// the token in a following request to fetch the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGeofenceCollectionsPaginator 

type ListGeofenceCollectionsPaginator struct {
	// contains filtered or unexported fields
}

ListGeofenceCollectionsPaginator is a paginator for ListGeofenceCollections

func NewListGeofenceCollectionsPaginator 

func NewListGeofenceCollectionsPaginator(client ListGeofenceCollectionsAPIClient, params *ListGeofenceCollectionsInput, optFns ...func(*ListGeofenceCollectionsPaginatorOptions)) *ListGeofenceCollectionsPaginator

NewListGeofenceCollectionsPaginator returns a new ListGeofenceCollectionsPaginator

func (*ListGeofenceCollectionsPaginator) HasMorePages 

func (p *ListGeofenceCollectionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGeofenceCollectionsPaginator) NextPage 

func (p *ListGeofenceCollectionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGeofenceCollectionsOutput, error)

NextPage retrieves the next ListGeofenceCollections page.

type ListGeofenceCollectionsPaginatorOptions 

type ListGeofenceCollectionsPaginatorOptions struct {
	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 100
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListGeofenceCollectionsPaginatorOptions is the paginator options for ListGeofenceCollections

type ListGeofencesAPIClient 

type ListGeofencesAPIClient interface {
	ListGeofences(context.Context, *ListGeofencesInput, ...func(*Options)) (*ListGeofencesOutput, error)
}

ListGeofencesAPIClient is a client that implements the ListGeofences operation.

type ListGeofencesInput 

type ListGeofencesInput struct {

	// The name of the geofence collection storing the list of geofences.
	//
	// This member is required.
	CollectionName *string

	// An optional limit for the number of geofences returned in a single call.
	//
	// Default value: 100
	MaxResults *int32

	// The pagination token specifying which page of results to return in the
	// response. If no token is provided, the default page is the first page.
	//
	// Default value: null
	NextToken *string
	// contains filtered or unexported fields
}

type ListGeofencesOutput 

type ListGeofencesOutput struct {

	// Contains a list of geofences stored in the geofence collection.
	//
	// This member is required.
	Entries []types.ListGeofenceResponseEntry

	// A pagination token indicating there are additional pages available. You can use
	// the token in a following request to fetch the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGeofencesPaginator 

type ListGeofencesPaginator struct {
	// contains filtered or unexported fields
}

ListGeofencesPaginator is a paginator for ListGeofences

func NewListGeofencesPaginator 

func NewListGeofencesPaginator(client ListGeofencesAPIClient, params *ListGeofencesInput, optFns ...func(*ListGeofencesPaginatorOptions)) *ListGeofencesPaginator

NewListGeofencesPaginator returns a new ListGeofencesPaginator

func (*ListGeofencesPaginator) HasMorePages 

func (p *ListGeofencesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGeofencesPaginator) NextPage 

func (p *ListGeofencesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGeofencesOutput, error)

NextPage retrieves the next ListGeofences page.

type ListGeofencesPaginatorOptions 

type ListGeofencesPaginatorOptions struct {
	// An optional limit for the number of geofences returned in a single call.
	//
	// Default value: 100
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListGeofencesPaginatorOptions is the paginator options for ListGeofences

type ListKeysAPIClient added in v1.22.0 

type ListKeysAPIClient interface {
	ListKeys(context.Context, *ListKeysInput, ...func(*Options)) (*ListKeysOutput, error)
}

ListKeysAPIClient is a client that implements the ListKeys operation.

type ListKeysInput added in v1.22.0 

type ListKeysInput struct {

	// Optionally filter the list to only Active or Expired API keys.
	Filter *types.ApiKeyFilter

	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 100
	MaxResults *int32

	// The pagination token specifying which page of results to return in the
	// response. If no token is provided, the default page is the first page.
	//
	// Default value: null
	NextToken *string
	// contains filtered or unexported fields
}

type ListKeysOutput added in v1.22.0 

type ListKeysOutput struct {

	// Contains API key resources in your Amazon Web Services account. Details include
	// API key name, allowed referers and timestamp for when the API key will expire.
	//
	// This member is required.
	Entries []types.ListKeysResponseEntry

	// A pagination token indicating there are additional pages available. You can use
	// the token in a following request to fetch the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListKeysPaginator added in v1.22.0 

type ListKeysPaginator struct {
	// contains filtered or unexported fields
}

ListKeysPaginator is a paginator for ListKeys

func NewListKeysPaginator added in v1.22.0 

func NewListKeysPaginator(client ListKeysAPIClient, params *ListKeysInput, optFns ...func(*ListKeysPaginatorOptions)) *ListKeysPaginator

NewListKeysPaginator returns a new ListKeysPaginator

func (*ListKeysPaginator) HasMorePages added in v1.22.0 

func (p *ListKeysPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListKeysPaginator) NextPage added in v1.22.0 

func (p *ListKeysPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListKeysOutput, error)

NextPage retrieves the next ListKeys page.

type ListKeysPaginatorOptions added in v1.22.0 

type ListKeysPaginatorOptions struct {
	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 100
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListKeysPaginatorOptions is the paginator options for ListKeys

type ListMapsAPIClient 

type ListMapsAPIClient interface {
	ListMaps(context.Context, *ListMapsInput, ...func(*Options)) (*ListMapsOutput, error)
}

ListMapsAPIClient is a client that implements the ListMaps operation.

type ListMapsInput 

type ListMapsInput struct {

	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 100
	MaxResults *int32

	// The pagination token specifying which page of results to return in the
	// response. If no token is provided, the default page is the first page.
	//
	// Default value: null
	NextToken *string
	// contains filtered or unexported fields
}

type ListMapsOutput 

type ListMapsOutput struct {

	// Contains a list of maps in your Amazon Web Services account
	//
	// This member is required.
	Entries []types.ListMapsResponseEntry

	// A pagination token indicating there are additional pages available. You can use
	// the token in a following request to fetch the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMapsPaginator 

type ListMapsPaginator struct {
	// contains filtered or unexported fields
}

ListMapsPaginator is a paginator for ListMaps

func NewListMapsPaginator 

func NewListMapsPaginator(client ListMapsAPIClient, params *ListMapsInput, optFns ...func(*ListMapsPaginatorOptions)) *ListMapsPaginator

NewListMapsPaginator returns a new ListMapsPaginator

func (*ListMapsPaginator) HasMorePages 

func (p *ListMapsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMapsPaginator) NextPage 

func (p *ListMapsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMapsOutput, error)

NextPage retrieves the next ListMaps page.

type ListMapsPaginatorOptions 

type ListMapsPaginatorOptions struct {
	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 100
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMapsPaginatorOptions is the paginator options for ListMaps

type ListPlaceIndexesAPIClient 

type ListPlaceIndexesAPIClient interface {
	ListPlaceIndexes(context.Context, *ListPlaceIndexesInput, ...func(*Options)) (*ListPlaceIndexesOutput, error)
}

ListPlaceIndexesAPIClient is a client that implements the ListPlaceIndexes operation.

type ListPlaceIndexesInput 

type ListPlaceIndexesInput struct {

	// An optional limit for the maximum number of results returned in a single call.
	//
	// Default value: 100
	MaxResults *int32

	// The pagination token specifying which page of results to return in the
	// response. If no token is provided, the default page is the first page.
	//
	// Default value: null
	NextToken *string
	// contains filtered or unexported fields
}

type ListPlaceIndexesOutput 

type ListPlaceIndexesOutput struct {

	// Lists the place index resources that exist in your Amazon Web Services account
	//
	// This member is required.
	Entries []types.ListPlaceIndexesResponseEntry

	// A pagination token indicating that there are additional pages available. You
	// can use the token in a new request to fetch the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPlaceIndexesPaginator 

type ListPlaceIndexesPaginator struct {
	// contains filtered or unexported fields
}

ListPlaceIndexesPaginator is a paginator for ListPlaceIndexes

func NewListPlaceIndexesPaginator 

func NewListPlaceIndexesPaginator(client ListPlaceIndexesAPIClient, params *ListPlaceIndexesInput, optFns ...func(*ListPlaceIndexesPaginatorOptions)) *ListPlaceIndexesPaginator

NewListPlaceIndexesPaginator returns a new ListPlaceIndexesPaginator

func (*ListPlaceIndexesPaginator) HasMorePages 

func (p *ListPlaceIndexesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPlaceIndexesPaginator) NextPage 

func (p *ListPlaceIndexesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPlaceIndexesOutput, error)

NextPage retrieves the next ListPlaceIndexes page.

type ListPlaceIndexesPaginatorOptions 

type ListPlaceIndexesPaginatorOptions struct {
	// An optional limit for the maximum number of results returned in a single call.
	//
	// Default value: 100
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPlaceIndexesPaginatorOptions is the paginator options for ListPlaceIndexes

type ListRouteCalculatorsAPIClient added in v1.2.0 

type ListRouteCalculatorsAPIClient interface {
	ListRouteCalculators(context.Context, *ListRouteCalculatorsInput, ...func(*Options)) (*ListRouteCalculatorsOutput, error)
}

ListRouteCalculatorsAPIClient is a client that implements the ListRouteCalculators operation.

type ListRouteCalculatorsInput added in v1.2.0 

type ListRouteCalculatorsInput struct {

	// An optional maximum number of results returned in a single call.
	//
	// Default Value: 100
	MaxResults *int32

	// The pagination token specifying which page of results to return in the
	// response. If no token is provided, the default page is the first page.
	//
	// Default Value: null
	NextToken *string
	// contains filtered or unexported fields
}

type ListRouteCalculatorsOutput added in v1.2.0 

type ListRouteCalculatorsOutput struct {

	// Lists the route calculator resources that exist in your Amazon Web Services
	// account
	//
	// This member is required.
	Entries []types.ListRouteCalculatorsResponseEntry

	// A pagination token indicating there are additional pages available. You can use
	// the token in a subsequent request to fetch the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRouteCalculatorsPaginator added in v1.2.0 

type ListRouteCalculatorsPaginator struct {
	// contains filtered or unexported fields
}

ListRouteCalculatorsPaginator is a paginator for ListRouteCalculators

func NewListRouteCalculatorsPaginator added in v1.2.0 

func NewListRouteCalculatorsPaginator(client ListRouteCalculatorsAPIClient, params *ListRouteCalculatorsInput, optFns ...func(*ListRouteCalculatorsPaginatorOptions)) *ListRouteCalculatorsPaginator

NewListRouteCalculatorsPaginator returns a new ListRouteCalculatorsPaginator

func (*ListRouteCalculatorsPaginator) HasMorePages added in v1.2.0 

func (p *ListRouteCalculatorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRouteCalculatorsPaginator) NextPage added in v1.2.0 

func (p *ListRouteCalculatorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRouteCalculatorsOutput, error)

NextPage retrieves the next ListRouteCalculators page.

type ListRouteCalculatorsPaginatorOptions added in v1.2.0 

type ListRouteCalculatorsPaginatorOptions struct {
	// An optional maximum number of results returned in a single call.
	//
	// Default Value: 100
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRouteCalculatorsPaginatorOptions is the paginator options for ListRouteCalculators

type ListTagsForResourceInput added in v1.2.0 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
	//
	//   - Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput added in v1.2.0 

type ListTagsForResourceOutput struct {

	// Tags that have been applied to the specified resource. Tags are mapped from the
	// tag key to the tag value: "TagKey" : "TagValue" .
	//
	//   - Format example: {"tag1" : "value1", "tag2" : "value2"}
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTrackerConsumersAPIClient 

type ListTrackerConsumersAPIClient interface {
	ListTrackerConsumers(context.Context, *ListTrackerConsumersInput, ...func(*Options)) (*ListTrackerConsumersOutput, error)
}

ListTrackerConsumersAPIClient is a client that implements the ListTrackerConsumers operation.

type ListTrackerConsumersInput 

type ListTrackerConsumersInput struct {

	// The tracker resource whose associated geofence collections you want to list.
	//
	// This member is required.
	TrackerName *string

	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 100
	MaxResults *int32

	// The pagination token specifying which page of results to return in the
	// response. If no token is provided, the default page is the first page.
	//
	// Default value: null
	NextToken *string
	// contains filtered or unexported fields
}

type ListTrackerConsumersOutput 

type ListTrackerConsumersOutput struct {

	// Contains the list of geofence collection ARNs associated to the tracker
	// resource.
	//
	// This member is required.
	ConsumerArns []string

	// A pagination token indicating there are additional pages available. You can use
	// the token in a following request to fetch the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTrackerConsumersPaginator 

type ListTrackerConsumersPaginator struct {
	// contains filtered or unexported fields
}

ListTrackerConsumersPaginator is a paginator for ListTrackerConsumers

func NewListTrackerConsumersPaginator 

func NewListTrackerConsumersPaginator(client ListTrackerConsumersAPIClient, params *ListTrackerConsumersInput, optFns ...func(*ListTrackerConsumersPaginatorOptions)) *ListTrackerConsumersPaginator

NewListTrackerConsumersPaginator returns a new ListTrackerConsumersPaginator

func (*ListTrackerConsumersPaginator) HasMorePages 

func (p *ListTrackerConsumersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTrackerConsumersPaginator) NextPage 

func (p *ListTrackerConsumersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTrackerConsumersOutput, error)

NextPage retrieves the next ListTrackerConsumers page.

type ListTrackerConsumersPaginatorOptions 

type ListTrackerConsumersPaginatorOptions struct {
	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 100
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTrackerConsumersPaginatorOptions is the paginator options for ListTrackerConsumers

type ListTrackersAPIClient 

type ListTrackersAPIClient interface {
	ListTrackers(context.Context, *ListTrackersInput, ...func(*Options)) (*ListTrackersOutput, error)
}

ListTrackersAPIClient is a client that implements the ListTrackers operation.

type ListTrackersInput 

type ListTrackersInput struct {

	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 100
	MaxResults *int32

	// The pagination token specifying which page of results to return in the
	// response. If no token is provided, the default page is the first page.
	//
	// Default value: null
	NextToken *string
	// contains filtered or unexported fields
}

type ListTrackersOutput 

type ListTrackersOutput struct {

	// Contains tracker resources in your Amazon Web Services account. Details include
	// tracker name, description and timestamps for when the tracker was created and
	// last updated.
	//
	// This member is required.
	Entries []types.ListTrackersResponseEntry

	// A pagination token indicating there are additional pages available. You can use
	// the token in a following request to fetch the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTrackersPaginator 

type ListTrackersPaginator struct {
	// contains filtered or unexported fields
}

ListTrackersPaginator is a paginator for ListTrackers

func NewListTrackersPaginator 

func NewListTrackersPaginator(client ListTrackersAPIClient, params *ListTrackersInput, optFns ...func(*ListTrackersPaginatorOptions)) *ListTrackersPaginator

NewListTrackersPaginator returns a new ListTrackersPaginator

func (*ListTrackersPaginator) HasMorePages 

func (p *ListTrackersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTrackersPaginator) NextPage 

func (p *ListTrackersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTrackersOutput, error)

NextPage retrieves the next ListTrackers page.

type ListTrackersPaginatorOptions 

type ListTrackersPaginatorOptions struct {
	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 100
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTrackersPaginatorOptions is the paginator options for ListTrackers

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.30.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutGeofenceInput 

type PutGeofenceInput struct {

	// The geofence collection to store the geofence in.
	//
	// This member is required.
	CollectionName *string

	// An identifier for the geofence. For example, ExampleGeofence-1 .
	//
	// This member is required.
	GeofenceId *string

	// Contains the details to specify the position of the geofence. Can be a polygon,
	// a circle or a polygon encoded in Geobuf format. Including multiple selections
	// will return a validation error.
	//
	// The [geofence polygon] format supports a maximum of 1,000 vertices. The [Geofence Geobuf] format supports a
	// maximum of 100,000 vertices.
	//
	// [Geofence Geobuf]: https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html
	// [geofence polygon]: https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html
	//
	// This member is required.
	Geometry *types.GeofenceGeometry

	// Associates one of more properties with the geofence. A property is a key-value
	// pair stored with the geofence and added to any geofence event triggered with
	// that geofence.
	//
	// Format: "key" : "value"
	GeofenceProperties map[string]string
	// contains filtered or unexported fields
}

type PutGeofenceOutput 

type PutGeofenceOutput struct {

	// The timestamp for when the geofence was created in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	CreateTime *time.Time

	// The geofence identifier entered in the request.
	//
	// This member is required.
	GeofenceId *string

	// The timestamp for when the geofence was last updated in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	UpdateTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SearchPlaceIndexForPositionInput 

type SearchPlaceIndexForPositionInput struct {

	// The name of the place index resource you want to use for the search.
	//
	// This member is required.
	IndexName *string

	// Specifies the longitude and latitude of the position to query.
	//
	// This parameter must contain a pair of numbers. The first number represents the
	// X coordinate, or longitude; the second number represents the Y coordinate, or
	// latitude.
	//
	// For example, [-123.1174, 49.2847] represents a position with longitude -123.1174
	// and latitude 49.2847 .
	//
	// This member is required.
	Position []float64

	// The optional [API key] to authorize the request.
	//
	// [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
	Key *string

	// The preferred language used to return results. The value must be a valid [BCP 47]
	// language tag, for example, en for English.
	//
	// This setting affects the languages used in the results, but not the results
	// themselves. If no language is specified, or not supported for a particular
	// result, the partner automatically chooses a language for the result.
	//
	// For an example, we'll use the Greek language. You search for a location around
	// Athens, Greece, with the language parameter set to en . The city in the results
	// will most likely be returned as Athens .
	//
	// If you set the language parameter to el , for Greek, then the city in the
	// results will more likely be returned as Αθήνα .
	//
	// If the data provider does not have a value for Greek, the result will be in a
	// language that the provider does support.
	//
	// [BCP 47]: https://tools.ietf.org/search/bcp47
	Language *string

	// An optional parameter. The maximum number of results returned per request.
	//
	// Default value: 50
	MaxResults *int32
	// contains filtered or unexported fields
}

type SearchPlaceIndexForPositionOutput 

type SearchPlaceIndexForPositionOutput struct {

	// Returns a list of Places closest to the specified position. Each result
	// contains additional information about the Places returned.
	//
	// This member is required.
	Results []types.SearchForPositionResult

	// Contains a summary of the request. Echoes the input values for Position ,
	// Language , MaxResults , and the DataSource of the place index.
	//
	// This member is required.
	Summary *types.SearchPlaceIndexForPositionSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchPlaceIndexForSuggestionsInput added in v1.10.0 

type SearchPlaceIndexForSuggestionsInput struct {

	// The name of the place index resource you want to use for the search.
	//
	// This member is required.
	IndexName *string

	// The free-form partial text to use to generate place suggestions. For example,
	// eiffel tow .
	//
	// This member is required.
	Text *string

	// An optional parameter that indicates a preference for place suggestions that
	// are closer to a specified position.
	//
	// If provided, this parameter must contain a pair of numbers. The first number
	// represents the X coordinate, or longitude; the second number represents the Y
	// coordinate, or latitude.
	//
	// For example, [-123.1174, 49.2847] represents the position with longitude
	// -123.1174 and latitude 49.2847 .
	//
	// BiasPosition and FilterBBox are mutually exclusive. Specifying both options
	// results in an error.
	BiasPosition []float64

	// An optional parameter that limits the search results by returning only
	// suggestions within a specified bounding box.
	//
	// If provided, this parameter must contain a total of four consecutive numbers in
	// two pairs. The first pair of numbers represents the X and Y coordinates
	// (longitude and latitude, respectively) of the southwest corner of the bounding
	// box; the second pair of numbers represents the X and Y coordinates (longitude
	// and latitude, respectively) of the northeast corner of the bounding box.
	//
	// For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box
	// where the southwest corner has longitude -12.7935 and latitude -37.4835 , and
	// the northeast corner has longitude -12.0684 and latitude -36.9542 .
	//
	// FilterBBox and BiasPosition are mutually exclusive. Specifying both options
	// results in an error.
	FilterBBox []float64

	// A list of one or more Amazon Location categories to filter the returned places.
	// If you include more than one category, the results will include results that
	// match any of the categories listed.
	//
	// For more information about using categories, including a list of Amazon
	// Location categories, see [Categories and filtering], in the Amazon Location Service Developer Guide.
	//
	// [Categories and filtering]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html
	FilterCategories []string

	// An optional parameter that limits the search results by returning only
	// suggestions within the provided list of countries.
	//
	//   - Use the [ISO 3166]3-digit country code. For example, Australia uses three upper-case
	//   characters: AUS .
	//
	// [ISO 3166]: https://www.iso.org/iso-3166-country-codes.html
	FilterCountries []string

	// The optional [API key] to authorize the request.
	//
	// [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
	Key *string

	// The preferred language used to return results. The value must be a valid [BCP 47]
	// language tag, for example, en for English.
	//
	// This setting affects the languages used in the results. If no language is
	// specified, or not supported for a particular result, the partner automatically
	// chooses a language for the result.
	//
	// For an example, we'll use the Greek language. You search for Athens, Gr to get
	// suggestions with the language parameter set to en . The results found will most
	// likely be returned as Athens, Greece .
	//
	// If you set the language parameter to el , for Greek, then the result found will
	// more likely be returned as Αθήνα, Ελλάδα .
	//
	// If the data provider does not have a value for Greek, the result will be in a
	// language that the provider does support.
	//
	// [BCP 47]: https://tools.ietf.org/search/bcp47
	Language *string

	// An optional parameter. The maximum number of results returned per request.
	//
	// The default: 5
	MaxResults *int32
	// contains filtered or unexported fields
}

type SearchPlaceIndexForSuggestionsOutput added in v1.10.0 

type SearchPlaceIndexForSuggestionsOutput struct {

	// A list of place suggestions that best match the search text.
	//
	// This member is required.
	Results []types.SearchForSuggestionsResult

	// Contains a summary of the request. Echoes the input values for BiasPosition ,
	// FilterBBox , FilterCountries , Language , MaxResults , and Text . Also includes
	// the DataSource of the place index.
	//
	// This member is required.
	Summary *types.SearchPlaceIndexForSuggestionsSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchPlaceIndexForTextInput 

type SearchPlaceIndexForTextInput struct {

	// The name of the place index resource you want to use for the search.
	//
	// This member is required.
	IndexName *string

	// The address, name, city, or region to be used in the search in free-form text
	// format. For example, 123 Any Street .
	//
	// This member is required.
	Text *string

	// An optional parameter that indicates a preference for places that are closer to
	// a specified position.
	//
	// If provided, this parameter must contain a pair of numbers. The first number
	// represents the X coordinate, or longitude; the second number represents the Y
	// coordinate, or latitude.
	//
	// For example, [-123.1174, 49.2847] represents the position with longitude
	// -123.1174 and latitude 49.2847 .
	//
	// BiasPosition and FilterBBox are mutually exclusive. Specifying both options
	// results in an error.
	BiasPosition []float64

	// An optional parameter that limits the search results by returning only places
	// that are within the provided bounding box.
	//
	// If provided, this parameter must contain a total of four consecutive numbers in
	// two pairs. The first pair of numbers represents the X and Y coordinates
	// (longitude and latitude, respectively) of the southwest corner of the bounding
	// box; the second pair of numbers represents the X and Y coordinates (longitude
	// and latitude, respectively) of the northeast corner of the bounding box.
	//
	// For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box
	// where the southwest corner has longitude -12.7935 and latitude -37.4835 , and
	// the northeast corner has longitude -12.0684 and latitude -36.9542 .
	//
	// FilterBBox and BiasPosition are mutually exclusive. Specifying both options
	// results in an error.
	FilterBBox []float64

	// A list of one or more Amazon Location categories to filter the returned places.
	// If you include more than one category, the results will include results that
	// match any of the categories listed.
	//
	// For more information about using categories, including a list of Amazon
	// Location categories, see [Categories and filtering], in the Amazon Location Service Developer Guide.
	//
	// [Categories and filtering]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html
	FilterCategories []string

	// An optional parameter that limits the search results by returning only places
	// that are in a specified list of countries.
	//
	//   - Valid values include [ISO 3166]3-digit country codes. For example, Australia uses
	//   three upper-case characters: AUS .
	//
	// [ISO 3166]: https://www.iso.org/iso-3166-country-codes.html
	FilterCountries []string

	// The optional [API key] to authorize the request.
	//
	// [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
	Key *string

	// The preferred language used to return results. The value must be a valid [BCP 47]
	// language tag, for example, en for English.
	//
	// This setting affects the languages used in the results, but not the results
	// themselves. If no language is specified, or not supported for a particular
	// result, the partner automatically chooses a language for the result.
	//
	// For an example, we'll use the Greek language. You search for Athens, Greece ,
	// with the language parameter set to en . The result found will most likely be
	// returned as Athens .
	//
	// If you set the language parameter to el , for Greek, then the result found will
	// more likely be returned as Αθήνα .
	//
	// If the data provider does not have a value for Greek, the result will be in a
	// language that the provider does support.
	//
	// [BCP 47]: https://tools.ietf.org/search/bcp47
	Language *string

	// An optional parameter. The maximum number of results returned per request.
	//
	// The default: 50
	MaxResults *int32
	// contains filtered or unexported fields
}

type SearchPlaceIndexForTextOutput 

type SearchPlaceIndexForTextOutput struct {

	// A list of Places matching the input text. Each result contains additional
	// information about the specific point of interest.
	//
	// Not all response properties are included with all responses. Some properties
	// may only be returned by specific data partners.
	//
	// This member is required.
	Results []types.SearchForTextResult

	// Contains a summary of the request. Echoes the input values for BiasPosition ,
	// FilterBBox , FilterCountries , Language , MaxResults , and Text . Also includes
	// the DataSource of the place index and the bounding box, ResultBBox , which
	// surrounds the search results.
	//
	// This member is required.
	Summary *types.SearchPlaceIndexForTextSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput added in v1.2.0 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource whose tags you want to update.
	//
	//   - Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource
	//
	// This member is required.
	ResourceArn *string

	// Applies one or more tags to specific 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.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput added in v1.2.0 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput added in v1.2.0 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource from which you want to remove
	// tags.
	//
	//   - Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource
	//
	// This member is required.
	ResourceArn *string

	// The list of tag keys to remove from the specified resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput added in v1.2.0 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateGeofenceCollectionInput added in v1.4.0 

type UpdateGeofenceCollectionInput struct {

	// The name of the geofence collection to update.
	//
	// This member is required.
	CollectionName *string

	// Updates the description for the geofence collection.
	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

	// This parameter is no longer used.
	//
	// Deprecated: Deprecated. No longer allowed.
	PricingPlanDataSource *string
	// contains filtered or unexported fields
}

type UpdateGeofenceCollectionOutput added in v1.4.0 

type UpdateGeofenceCollectionOutput struct {

	// The Amazon Resource Name (ARN) of the updated geofence collection. Used to
	// specify a resource across Amazon Web Services.
	//
	//   - Format example:
	//   arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
	//
	// This member is required.
	CollectionArn *string

	// The name of the updated geofence collection.
	//
	// This member is required.
	CollectionName *string

	// The time when the geofence collection was last updated in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	UpdateTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateKeyInput added in v1.22.0 

type UpdateKeyInput struct {

	// The name of the API key resource to update.
	//
	// This member is required.
	KeyName *string

	// Updates the description for the API key resource.
	Description *string

	// Updates the timestamp for when the API key resource will expire in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	ExpireTime *time.Time

	// The boolean flag to be included for updating ExpireTime or Restrictions details.
	//
	// Must be set to true to update an API key resource that has been used in the
	// past 7 days.
	//
	// False if force update is not preferred
	//
	// Default value: False
	ForceUpdate *bool

	// Whether the API key should expire. Set to true to set the API key to have no
	// expiration time.
	NoExpiry *bool

	// Updates the API key restrictions for the API key resource.
	Restrictions *types.ApiKeyRestrictions
	// contains filtered or unexported fields
}

type UpdateKeyOutput added in v1.22.0 

type UpdateKeyOutput struct {

	// The Amazon Resource Name (ARN) for the API key resource. Used when you need to
	// specify a resource across all Amazon Web Services.
	//
	//   - Format example: arn:aws:geo:region:account-id:key/ExampleKey
	//
	// This member is required.
	KeyArn *string

	// The name of the API key resource.
	//
	// This member is required.
	KeyName *string

	// The timestamp for when the API key resource was last updated in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	UpdateTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateMapInput added in v1.4.0 

type UpdateMapInput struct {

	// The name of the map resource to update.
	//
	// This member is required.
	MapName *string

	// Updates the parts of the map configuration that can be updated, including the
	// political view.
	ConfigurationUpdate *types.MapConfigurationUpdate

	// Updates the description for the map 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
	// contains filtered or unexported fields
}

type UpdateMapOutput added in v1.4.0 

type UpdateMapOutput struct {

	// The Amazon Resource Name (ARN) of the updated map resource. Used to specify a
	// resource across AWS.
	//
	//   - Format example: arn:aws:geo:region:account-id:map/ExampleMap
	//
	// This member is required.
	MapArn *string

	// The name of the updated map resource.
	//
	// This member is required.
	MapName *string

	// The timestamp for when the map resource was last updated in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	UpdateTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePlaceIndexInput added in v1.4.0 

type UpdatePlaceIndexInput struct {

	// The name of the place index resource to update.
	//
	// This member is required.
	IndexName *string

	// Updates the data storage option for the place index resource.
	DataSourceConfiguration *types.DataSourceConfiguration

	// Updates the 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
	// contains filtered or unexported fields
}

type UpdatePlaceIndexOutput added in v1.4.0 

type UpdatePlaceIndexOutput struct {

	// The Amazon Resource Name (ARN) of the upated 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 of the updated place index resource.
	//
	// This member is required.
	IndexName *string

	// The timestamp for when the place index resource was last updated in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	UpdateTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateRouteCalculatorInput added in v1.4.0 

type UpdateRouteCalculatorInput struct {

	// The name of the route calculator resource to update.
	//
	// This member is required.
	CalculatorName *string

	// Updates the 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
	// contains filtered or unexported fields
}

type UpdateRouteCalculatorOutput added in v1.4.0 

type UpdateRouteCalculatorOutput struct {

	// The Amazon Resource Name (ARN) of the updated route calculator resource. Used
	// to specify a resource across AWS.
	//
	//   - Format example: arn:aws:geo:region:account-id:route-
	//   calculator/ExampleCalculator
	//
	// This member is required.
	CalculatorArn *string

	// The name of the updated route calculator resource.
	//
	// This member is required.
	CalculatorName *string

	// The timestamp for when the route calculator was last updated in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	UpdateTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateTrackerInput added in v1.4.0 

type UpdateTrackerInput struct {

	// The name of the tracker resource to update.
	//
	// This member is required.
	TrackerName *string

	// Updates the description for the tracker resource.
	Description *string

	// Whether to enable position UPDATE events from this tracker to be sent to
	// EventBridge.
	//
	// You do not need enable this feature to get ENTER and EXIT events for geofences
	// with this tracker. Those events are always sent to EventBridge.
	EventBridgeEnabled *bool

	// Enables GeospatialQueries for a tracker that uses a [Amazon Web Services KMS customer managed key].
	//
	// This parameter is only used if you are using a KMS customer managed key.
	//
	// [Amazon Web Services KMS customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
	KmsKeyEnableGeospatialQueries *bool

	// Updates the position filtering for the tracker resource.
	//
	// Valid values:
	//
	//   - TimeBased - Location updates are evaluated against linked geofence
	//   collections, but not every location update is stored. If your update frequency
	//   is more often than 30 seconds, only one update per 30 seconds is stored for each
	//   unique device ID.
	//
	//   - DistanceBased - If the device has moved less than 30 m (98.4 ft), location
	//   updates are ignored. Location updates within this distance are neither evaluated
	//   against linked geofence collections, nor stored. This helps control costs by
	//   reducing the number of geofence evaluations and historical device positions to
	//   paginate through. Distance-based filtering can also reduce the effects of GPS
	//   noise when displaying device trajectories on a map.
	//
	//   - AccuracyBased - If the device has moved less than the measured accuracy,
	//   location updates are ignored. For example, if two consecutive updates from a
	//   device have a horizontal accuracy of 5 m and 10 m, the second update is ignored
	//   if the device has moved less than 15 m. Ignored location updates are neither
	//   evaluated against linked geofence collections, nor stored. This helps educe the
	//   effects of GPS noise when displaying device trajectories on a map, and can help
	//   control costs by reducing the number of geofence evaluations.
	PositionFiltering types.PositionFiltering

	// No longer used. If included, the only allowed value is RequestBasedUsage .
	//
	// Deprecated: Deprecated. If included, the only allowed value is
	// RequestBasedUsage.
	PricingPlan types.PricingPlan

	// This parameter is no longer used.
	//
	// Deprecated: Deprecated. No longer allowed.
	PricingPlanDataSource *string
	// contains filtered or unexported fields
}

type UpdateTrackerOutput added in v1.4.0 

type UpdateTrackerOutput struct {

	// The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify
	// a resource across AWS.
	//
	//   - Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker
	//
	// This member is required.
	TrackerArn *string

	// The name of the updated tracker resource.
	//
	// This member is required.
	TrackerName *string

	// The timestamp for when the tracker resource was last updated in [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	UpdateTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type VerifyDevicePositionInput added in v1.38.0 

type VerifyDevicePositionInput struct {

	// The device's state, including position, IP address, cell signals and Wi-Fi
	// access points.
	//
	// This member is required.
	DeviceState *types.DeviceState

	// The name of the tracker resource to be associated with verification request.
	//
	// This member is required.
	TrackerName *string

	// The distance unit for the verification request.
	//
	// Default Value: Kilometers
	DistanceUnit types.DistanceUnit
	// contains filtered or unexported fields
}

type VerifyDevicePositionOutput added in v1.38.0 

type VerifyDevicePositionOutput struct {

	// The device identifier.
	//
	// This member is required.
	DeviceId *string

	// The distance unit for the verification response.
	//
	// This member is required.
	DistanceUnit types.DistanceUnit

	// The inferred state of the device, given the provided position, IP address,
	// cellular signals, and Wi-Fi- access points.
	//
	// This member is required.
	InferredState *types.InferredState

	// The timestamp for when the tracker resource received the device position in [ISO 8601]
	// format: YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	ReceivedTime *time.Time

	// The timestamp at which the device's position was determined. Uses [ISO 8601] format:
	// YYYY-MM-DDThh:mm:ss.sssZ .
	//
	// [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html
	//
	// This member is required.
	SampleTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.