location

package module
v1.1.0 Latest Latest
Warning

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

 Go to latest Published: May 14, 2021 License: Apache-2.0 Imports: 28 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, 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 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

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 AWS.
	//
	// *
	// Format example:
	// arn:partition:service:region:account-id:resource-type:resource-id
	//
	// 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
}

type AssociateTrackerConsumerOutput 

type AssociateTrackerConsumerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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.
	//
	// This member is required.
	Updates []types.DevicePositionUpdate
}

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
}

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. 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) 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 action deletes the resource permanently. You can't undo this action.

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. The evaluation determines if the device has entered or exited a geofenced area, which publishes ENTER or EXIT geofence events to Amazon EventBridge. The last geofence that a device was observed within, if any, is tracked for 30 days after the most recent device position update

func (*Client) BatchGetDevicePosition 

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

A batch request to retrieve all device positions.

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.

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. Amazon Location uses the data when reporting the last known device position and position history. Only one position update is stored per sample time. Location data is sampled at a fixed rate of one position per 30-second interval, and retained for one year before it is deleted.

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) CreateMap 

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

Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers. By using Maps, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. For more information, see the AWS Service Terms (https://aws.amazon.com/service-terms/) for Amazon Location Service.

func (*Client) CreatePlaceIndex 

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

Creates a Place index resource in your AWS account, which supports Places functions with geospatial data sourced from your chosen data provider. By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the AWS Service Terms (https://aws.amazon.com/service-terms/) for Amazon Location Service.

func (*Client) CreateTracker 

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

Creates a tracker resource in your AWS 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 AWS account. This action deletes the resource permanently. You can't undo this action. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.

func (*Client) DeleteMap 

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

Deletes a map resource from your AWS account. This action deletes the resource permanently. You cannot undo this action. 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 AWS account. This action deletes the resource permanently. You cannot undo this action.

func (*Client) DeleteTracker 

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

Deletes a tracker resource from your AWS account. This action deletes the resource permanently. You can't undo this action. If the tracker resource is in use, you may encounter an error. Make sure that the target resource is not 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) 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) 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) 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 one year.

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 1 year.

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.

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 are 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) ListGeofenceCollections 

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

Lists geofence collections in your AWS 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) ListMaps 

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

Lists map resources in your AWS account.

func (*Client) ListPlaceIndexes 

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

Lists Place index resources in your AWS account.

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 AWS account.

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. By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the AWS Service Terms (https://aws.amazon.com/service-terms/) for Amazon Location Service.

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. Includes the option to apply additional parameters to narrow your list of results. 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. By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. Also, when using HERE as your data provider, you may not (a) use HERE Places for Asset Management, or (b) select the Storage option for the IntendedUse parameter when requesting Places in Japan. For more information, see the AWS Service Terms (https://aws.amazon.com/service-terms/) for Amazon Location Service.

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

	// Specifies the pricing plan for your geofence collection. For additional details
	// and restrictions on each pricing plan option, see the Amazon Location Service
	// pricing page (https://aws.amazon.com/location/pricing/).
	//
	// This member is required.
	PricingPlan types.PricingPlan

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

	// Specifies the plan data source. Required if the Mobile Asset Tracking (MAT) or
	// the Mobile Asset Management (MAM) pricing plan is selected. Billing is
	// determined by the resource usage, the associated pricing plan, and the data
	// source that was specified. For more information about each pricing plan option
	// and restrictions, see the Amazon Location Service pricing page
	// (https://aws.amazon.com/location/pricing/). Valid Values: Esri | Here
	PricingPlanDataSource *string
}

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 AWS.
	//
	// 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
	// (https://www.iso.org/iso-8601-date-and-time-format.html) format:
	// YYYY-MM-DDThh:mm:ss.sssZ
	//
	// This member is required.
	CreateTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateMapInput 

type CreateMapInput struct {

	// Specifies the map style selected from an available data provider.
	//
	// 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

	// Specifies the pricing plan for your map resource. For additional details and
	// restrictions on each pricing plan option, see the Amazon Location Service
	// pricing page (https://aws.amazon.com/location/pricing/).
	//
	// This member is required.
	PricingPlan types.PricingPlan

	// An optional description for the map resource.
	Description *string
}

type CreateMapOutput 

type CreateMapOutput struct {

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

	// The Amazon Resource Name (ARN) for the map resource. Used when you need to
	// specify a resource across all AWS.
	//
	// * Format example:
	// arn:partition:service:region:account-id:resource-type:resource-id
	//
	// 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
}

type CreatePlaceIndexInput 

type CreatePlaceIndexInput struct {

	// Specifies the data provider of geospatial data. This field is case-sensitive.
	// Enter the valid values as shown. For example, entering HERE will return an
	// error. Valid values include:
	//
	// * Esri
	//
	// * Here
	//
	// For additional details on data
	// providers, see the Amazon Location Service data providers page
	// (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.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 pricing plan for your Place index resource. For additional details
	// and restrictions on each pricing plan option, see the Amazon Location Service
	// pricing page (https://aws.amazon.com/location/pricing/).
	//
	// This member is required.
	PricingPlan types.PricingPlan

	// Specifies the data storage option for requesting Places.
	DataSourceConfiguration *types.DataSourceConfiguration

	// The optional description for the Place index resource.
	Description *string
}

type CreatePlaceIndexOutput 

type CreatePlaceIndexOutput struct {

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

	// The Amazon Resource Name (ARN) for the Place index resource. Used when you need
	// to specify a resource across all AWS.
	//
	// 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
}

type CreateTrackerInput 

type CreateTrackerInput struct {

	// Specifies the pricing plan for your tracker resource. For additional details and
	// restrictions on each pricing plan option, see the Amazon Location Service
	// pricing page (https://aws.amazon.com/location/pricing/).
	//
	// This member is required.
	PricingPlan types.PricingPlan

	// 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

	// Specifies the plan data source. Required if the Mobile Asset Tracking (MAT) or
	// the Mobile Asset Management (MAM) pricing plan is selected. Billing is
	// determined by the resource usage, the associated pricing plan, and data source
	// that was specified. For more information about each pricing plan option and
	// restrictions, see the Amazon Location Service pricing page
	// (https://aws.amazon.com/location/pricing/). Valid Values: Esri | Here
	PricingPlanDataSource *string
}

type CreateTrackerOutput 

type CreateTrackerOutput struct {

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

	// The Amazon Resource Name (ARN) for the tracker resource. Used when you need to
	// specify a resource across all AWS.
	//
	// 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
}

type DeleteGeofenceCollectionInput 

type DeleteGeofenceCollectionInput struct {

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

type DeleteGeofenceCollectionOutput 

type DeleteGeofenceCollectionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteMapInput 

type DeleteMapInput struct {

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

type DeleteMapOutput 

type DeleteMapOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeletePlaceIndexInput 

type DeletePlaceIndexInput struct {

	// The name of the Place index resource to be deleted.
	//
	// This member is required.
	IndexName *string
}

type DeletePlaceIndexOutput 

type DeletePlaceIndexOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteTrackerInput 

type DeleteTrackerInput struct {

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

type DeleteTrackerOutput 

type DeleteTrackerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeGeofenceCollectionInput 

type DescribeGeofenceCollectionInput struct {

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

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 AWS.
	//
	// 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
	// (https://www.iso.org/iso-8601-date-and-time-format.html) format:
	// YYYY-MM-DDThh:mm:ss.sssZ
	//
	// This member is required.
	CreateTime *time.Time

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

	// The pricing plan selected for the specified geofence collection. For additional
	// details and restrictions on each pricing plan option, see the Amazon Location
	// Service pricing page (https://aws.amazon.com/location/pricing/).
	//
	// This member is required.
	PricingPlan types.PricingPlan

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

	// The data source selected for the geofence collection and associated pricing
	// plan.
	PricingPlanDataSource *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeMapInput 

type DescribeMapInput struct {

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

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
	// (https://www.iso.org/iso-8601-date-and-time-format.html) format:
	// YYYY-MM-DDThh:mm:ss.sssZ.
	//
	// This member is required.
	CreateTime *time.Time

	// 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 when you need to
	// specify a resource across all AWS.
	//
	// This member is required.
	MapArn *string

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

	// The pricing plan selected for the specified map resource. For additional details
	// and restrictions on each pricing plan option, see the Amazon Location Service
	// pricing page (https://aws.amazon.com/location/pricing/).
	//
	// This member is required.
	PricingPlan types.PricingPlan

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribePlaceIndexInput 

type DescribePlaceIndexInput struct {

	// The name of the Place index resource.
	//
	// This member is required.
	IndexName *string
}

type DescribePlaceIndexOutput 

type DescribePlaceIndexOutput struct {

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

	// The data provider of geospatial data. Indicates one of the available
	// providers:
	//
	// * Esri
	//
	// * Here
	//
	// For additional details on data providers, see the
	// Amazon Location Service data providers page
	// (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 when you need
	// to specify a resource across all AWS.
	//
	// This member is required.
	IndexArn *string

	// The name of the Place index resource being described.
	//
	// This member is required.
	IndexName *string

	// The pricing plan selected for the specified Place index resource. For additional
	// details and restrictions on each pricing plan option, see the Amazon Location
	// Service pricing page (https://aws.amazon.com/location/pricing/).
	//
	// This member is required.
	PricingPlan types.PricingPlan

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeTrackerInput 

type DescribeTrackerInput struct {

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

type DescribeTrackerOutput 

type DescribeTrackerOutput struct {

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

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

	// The pricing plan selected for the specified tracker resource. For additional
	// details and restrictions on each pricing plan option, see the Amazon Location
	// Service pricing page (https://aws.amazon.com/location/pricing/).
	//
	// This member is required.
	PricingPlan types.PricingPlan

	// The Amazon Resource Name (ARN) for the tracker resource. Used when you need to
	// specify a resource across all AWS.
	//
	// 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
	// (https://www.iso.org/iso-8601-date-and-time-format.html) format:
	// YYYY-MM-DDThh:mm:ss.sssZ.
	//
	// This member is required.
	UpdateTime *time.Time

	// The data source selected for the tracker resource and associated pricing plan.
	PricingPlanDataSource *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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
	// AWS.
	//
	// * Format example:
	// arn:partition:service:region:account-id:resource-type:resource-id
	//
	// This member is required.
	ConsumerArn *string

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

type DisassociateTrackerConsumerOutput 

type DisassociateTrackerConsumerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 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
	// (https://www.iso.org/iso-8601-date-and-time-format.html) 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.
	EndTimeExclusive *time.Time

	// 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
	// (https://www.iso.org/iso-8601-date-and-time-format.html) 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.
	StartTimeInclusive *time.Time
}

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
}

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 {
	// 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
}

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 in  ISO
	// 8601  (https://www.iso.org/iso-8601-date-and-time-format.html) format:
	// YYYY-MM-DDThh:mm:ss.sssZ.
	//
	// This member is required.
	ReceivedTime *time.Time

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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
}

type GetGeofenceOutput 

type GetGeofenceOutput struct {

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

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

	// Contains the geofence geometry details describing a polygon.
	//
	// 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
	// (https://www.iso.org/iso-8601-date-and-time-format.html) format:
	// YYYY-MM-DDThh:mm:ss.sssZ
	//
	// This member is required.
	UpdateTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetMapGlyphsInput 

type GetMapGlyphsInput struct {

	// A comma-separated list of fonts to load glyphs from in order of preference.. For
	// example, Noto Sans, Arial Unicode.
	//
	// 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
}

type GetMapGlyphsOutput 

type GetMapGlyphsOutput struct {

	// The blob's content type.
	Blob []byte

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 contain 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
}

type GetMapSpritesOutput 

type GetMapSpritesOutput struct {

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

	// 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
}

type GetMapStyleDescriptorInput 

type GetMapStyleDescriptorInput struct {

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

type GetMapStyleDescriptorOutput 

type GetMapStyleDescriptorOutput struct {

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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
}

type GetMapTileOutput 

type GetMapTileOutput struct {

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

	// 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
}

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 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
}

type ListGeofenceCollectionsOutput 

type ListGeofenceCollectionsOutput struct {

	// Lists the geofence collections that exist in your AWS 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
}

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

	// 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
}

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
}

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 {
	// 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 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
}

type ListMapsOutput 

type ListMapsOutput struct {

	// Contains a list of maps in your AWS 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
}

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
}

type ListPlaceIndexesOutput 

type ListPlaceIndexesOutput struct {

	// Lists the Place index resources that exist in your AWS account
	//
	// This member is required.
	Entries []types.ListPlaceIndexesResponseEntry

	// 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
}

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 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
}

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
}

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
}

type ListTrackersOutput 

type ListTrackersOutput struct {

	// Contains tracker resources in your AWS 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
}

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

	// 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 endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

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

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

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

func (Options) Copy 

func (o Options) Copy() Options

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

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 polygon details to specify the position of the geofence. Each
	// geofence polygon
	// (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html)
	// can have a maximum of 1,000 vertices.
	//
	// This member is required.
	Geometry *types.GeofenceGeometry
}

type PutGeofenceOutput 

type PutGeofenceOutput struct {

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

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 a coordinate for the query defined by a longitude, and latitude.
	//
	// *
	// The first position is the X coordinate, or longitude.
	//
	// * The second position is
	// the Y coordinate, or latitude.
	//
	// For example,
	// position=xLongitude&position=yLatitude .
	//
	// This member is required.
	Position []float64

	// An optional paramer. The maximum number of results returned per request. Default
	// value: 50
	MaxResults int32
}

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.
	//
	// This member is required.
	Summary *types.SearchPlaceIndexForPositionSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

	// Searches for results closest to the given position. An optional parameter
	// defined by longitude, and latitude.
	//
	// * The first bias position is the X
	// coordinate, or longitude.
	//
	// * The second bias position is the Y coordinate, or
	// latitude.
	//
	// For example, bias=xLongitude&bias=yLatitude.
	BiasPosition []float64

	// Filters the results by returning only Places within the provided bounding box.
	// An optional parameter. The first 2 bbox parameters describe the lower southwest
	// corner:
	//
	// * The first bbox position is the X coordinate or longitude of the lower
	// southwest corner.
	//
	// * The second bbox position is the Y coordinate or latitude of
	// the lower southwest corner.
	//
	// For example, bbox=xLongitudeSW&bbox=yLatitudeSW.
	// The next bbox parameters describe the upper northeast corner:
	//
	// * The third bbox
	// position is the X coordinate, or longitude of the upper northeast corner.
	//
	// * The
	// fourth bbox position is the Y coordinate, or longitude of the upper northeast
	// corner.
	//
	// For example, bbox=xLongitudeNE&bbox=yLatitudeNE
	FilterBBox []float64

	// Limits the search to the given a list of countries/regions. An optional
	// parameter.
	//
	// * Use the ISO 3166 (https://www.iso.org/iso-3166-country-codes.html)
	// 3-digit country code. For example, Australia uses three upper-case characters:
	// AUS.
	FilterCountries []string

	// An optional parameter. The maximum number of results returned per request. The
	// default: 50
	MaxResults int32
}

type SearchPlaceIndexForTextOutput 

type SearchPlaceIndexForTextOutput struct {

	// A list of Places closest to the specified position. Each result contains
	// additional information about the specific point of interest.
	//
	// This member is required.
	Results []types.SearchForTextResult

	// Contains a summary of the request. Contains the BiasPosition, DataSource,
	// FilterBBox, FilterCountries, MaxResults, ResultBBox, and Text.
	//
	// This member is required.
	Summary *types.SearchPlaceIndexForTextSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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.