locationservice

package
v1.55.5 Latest Latest
Warning

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

 Go to latest Published: Jul 30, 2024 License: Apache-2.0 Imports: 10 Imported by: 16

Documentation

Overview

Package locationservice provides the client and types for making API requests to Amazon Location Service.

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

See https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19 for more information on this service.

See locationservice package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/locationservice/

Using the Client

To contact Amazon Location Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Location Service client LocationService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/locationservice/#New

Index

Constants

View Source 
const (
	// BatchItemErrorCodeAccessDeniedError is a BatchItemErrorCode enum value
	BatchItemErrorCodeAccessDeniedError = "AccessDeniedError"

	// BatchItemErrorCodeConflictError is a BatchItemErrorCode enum value
	BatchItemErrorCodeConflictError = "ConflictError"

	// BatchItemErrorCodeInternalServerError is a BatchItemErrorCode enum value
	BatchItemErrorCodeInternalServerError = "InternalServerError"

	// BatchItemErrorCodeResourceNotFoundError is a BatchItemErrorCode enum value
	BatchItemErrorCodeResourceNotFoundError = "ResourceNotFoundError"

	// BatchItemErrorCodeThrottlingError is a BatchItemErrorCode enum value
	BatchItemErrorCodeThrottlingError = "ThrottlingError"

	// BatchItemErrorCodeValidationError is a BatchItemErrorCode enum value
	BatchItemErrorCodeValidationError = "ValidationError"
)
View Source 
const (
	// DimensionUnitMeters is a DimensionUnit enum value
	DimensionUnitMeters = "Meters"

	// DimensionUnitFeet is a DimensionUnit enum value
	DimensionUnitFeet = "Feet"
)
View Source 
const (
	// DistanceUnitKilometers is a DistanceUnit enum value
	DistanceUnitKilometers = "Kilometers"

	// DistanceUnitMiles is a DistanceUnit enum value
	DistanceUnitMiles = "Miles"
)
View Source 
const (
	// ForecastedGeofenceEventTypeEnter is a ForecastedGeofenceEventType enum value
	ForecastedGeofenceEventTypeEnter = "ENTER"

	// ForecastedGeofenceEventTypeExit is a ForecastedGeofenceEventType enum value
	ForecastedGeofenceEventTypeExit = "EXIT"

	// ForecastedGeofenceEventTypeIdle is a ForecastedGeofenceEventType enum value
	ForecastedGeofenceEventTypeIdle = "IDLE"
)
View Source 
const (
	// IntendedUseSingleUse is a IntendedUse enum value
	IntendedUseSingleUse = "SingleUse"

	// IntendedUseStorage is a IntendedUse enum value
	IntendedUseStorage = "Storage"
)
View Source 
const (
	// OptimizationModeFastestRoute is a OptimizationMode enum value
	OptimizationModeFastestRoute = "FastestRoute"

	// OptimizationModeShortestRoute is a OptimizationMode enum value
	OptimizationModeShortestRoute = "ShortestRoute"
)
View Source 
const (
	// PositionFilteringTimeBased is a PositionFiltering enum value
	PositionFilteringTimeBased = "TimeBased"

	// PositionFilteringDistanceBased is a PositionFiltering enum value
	PositionFilteringDistanceBased = "DistanceBased"

	// PositionFilteringAccuracyBased is a PositionFiltering enum value
	PositionFilteringAccuracyBased = "AccuracyBased"
)
View Source 
const (
	// PricingPlanRequestBasedUsage is a PricingPlan enum value
	PricingPlanRequestBasedUsage = "RequestBasedUsage"

	// PricingPlanMobileAssetTracking is a PricingPlan enum value
	PricingPlanMobileAssetTracking = "MobileAssetTracking"

	// PricingPlanMobileAssetManagement is a PricingPlan enum value
	PricingPlanMobileAssetManagement = "MobileAssetManagement"
)
View Source 
const (
	// RouteMatrixErrorCodeRouteNotFound is a RouteMatrixErrorCode enum value
	RouteMatrixErrorCodeRouteNotFound = "RouteNotFound"

	// RouteMatrixErrorCodeRouteTooLong is a RouteMatrixErrorCode enum value
	RouteMatrixErrorCodeRouteTooLong = "RouteTooLong"

	// RouteMatrixErrorCodePositionsNotFound is a RouteMatrixErrorCode enum value
	RouteMatrixErrorCodePositionsNotFound = "PositionsNotFound"

	// RouteMatrixErrorCodeDestinationPositionNotFound is a RouteMatrixErrorCode enum value
	RouteMatrixErrorCodeDestinationPositionNotFound = "DestinationPositionNotFound"

	// RouteMatrixErrorCodeDeparturePositionNotFound is a RouteMatrixErrorCode enum value
	RouteMatrixErrorCodeDeparturePositionNotFound = "DeparturePositionNotFound"

	// RouteMatrixErrorCodeOtherValidationError is a RouteMatrixErrorCode enum value
	RouteMatrixErrorCodeOtherValidationError = "OtherValidationError"
)
View Source 
const (
	// SpeedUnitKilometersPerHour is a SpeedUnit enum value
	SpeedUnitKilometersPerHour = "KilometersPerHour"

	// SpeedUnitMilesPerHour is a SpeedUnit enum value
	SpeedUnitMilesPerHour = "MilesPerHour"
)
View Source 
const (
	// StatusActive is a Status enum value
	StatusActive = "Active"

	// StatusExpired is a Status enum value
	StatusExpired = "Expired"
)
View Source 
const (
	// TravelModeCar is a TravelMode enum value
	TravelModeCar = "Car"

	// TravelModeTruck is a TravelMode enum value
	TravelModeTruck = "Truck"

	// TravelModeWalking is a TravelMode enum value
	TravelModeWalking = "Walking"

	// TravelModeBicycle is a TravelMode enum value
	TravelModeBicycle = "Bicycle"

	// TravelModeMotorcycle is a TravelMode enum value
	TravelModeMotorcycle = "Motorcycle"
)
View Source 
const (
	// ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value
	ValidationExceptionReasonUnknownOperation = "UnknownOperation"

	// ValidationExceptionReasonMissing is a ValidationExceptionReason enum value
	ValidationExceptionReasonMissing = "Missing"

	// ValidationExceptionReasonCannotParse is a ValidationExceptionReason enum value
	ValidationExceptionReasonCannotParse = "CannotParse"

	// ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value
	ValidationExceptionReasonFieldValidationFailed = "FieldValidationFailed"

	// ValidationExceptionReasonOther is a ValidationExceptionReason enum value
	ValidationExceptionReasonOther = "Other"
)
View Source 
const (
	// VehicleWeightUnitKilograms is a VehicleWeightUnit enum value
	VehicleWeightUnitKilograms = "Kilograms"

	// VehicleWeightUnitPounds is a VehicleWeightUnit enum value
	VehicleWeightUnitPounds = "Pounds"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// The request was denied because of insufficient access or permissions. Check
	// with an administrator to verify your permissions.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The request was unsuccessful because of a conflict.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// The request has failed to process because of an unknown server error, exception,
	// or failure.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The resource that you've entered was not found in your AWS account.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The operation was denied because the request would exceed the maximum quota
	// (https://docs.aws.amazon.com/location/latest/developerguide/location-quotas.html)
	// set for Amazon Location Service.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied because of request throttling.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input failed to meet the constraints specified by the AWS service.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "Location" // Name of service.
	EndpointsID = "geo"      // ID to lookup a service endpoint with.
	ServiceID   = "Location" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func BatchItemErrorCode_Values 

func BatchItemErrorCode_Values() []string

BatchItemErrorCode_Values returns all elements of the BatchItemErrorCode enum

func DimensionUnit_Values added in v1.38.51 

func DimensionUnit_Values() []string

DimensionUnit_Values returns all elements of the DimensionUnit enum

func DistanceUnit_Values added in v1.38.51 

func DistanceUnit_Values() []string

DistanceUnit_Values returns all elements of the DistanceUnit enum

func ForecastedGeofenceEventType_Values added in v1.53.18 

func ForecastedGeofenceEventType_Values() []string

ForecastedGeofenceEventType_Values returns all elements of the ForecastedGeofenceEventType enum

func IntendedUse_Values 

func IntendedUse_Values() []string

IntendedUse_Values returns all elements of the IntendedUse enum

func OptimizationMode_Values added in v1.49.1 

func OptimizationMode_Values() []string

OptimizationMode_Values returns all elements of the OptimizationMode enum

func PositionFiltering_Values added in v1.40.56 

func PositionFiltering_Values() []string

PositionFiltering_Values returns all elements of the PositionFiltering enum

func PricingPlan_Values 

func PricingPlan_Values() []string

PricingPlan_Values returns all elements of the PricingPlan enum

func RouteMatrixErrorCode_Values added in v1.42.36 

func RouteMatrixErrorCode_Values() []string

RouteMatrixErrorCode_Values returns all elements of the RouteMatrixErrorCode enum

func SpeedUnit_Values added in v1.53.18 

func SpeedUnit_Values() []string

SpeedUnit_Values returns all elements of the SpeedUnit enum

func Status_Values added in v1.44.208 

func Status_Values() []string

Status_Values returns all elements of the Status enum

func TravelMode_Values added in v1.38.51 

func TravelMode_Values() []string

TravelMode_Values returns all elements of the TravelMode enum

func ValidationExceptionReason_Values 

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

func VehicleWeightUnit_Values added in v1.38.51 

func VehicleWeightUnit_Values() []string

VehicleWeightUnit_Values returns all elements of the VehicleWeightUnit enum

Types

type AccessDeniedException 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ApiKeyFilter added in v1.44.208 

type ApiKeyFilter struct {

	// Filter on Active or Expired API keys.
	KeyStatus *string `type:"string" enum:"Status"`
	// contains filtered or unexported fields
}

Options for filtering API keys.

func (ApiKeyFilter) GoString added in v1.44.208 

func (s ApiKeyFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApiKeyFilter) SetKeyStatus added in v1.44.208 

func (s *ApiKeyFilter) SetKeyStatus(v string) *ApiKeyFilter

SetKeyStatus sets the KeyStatus field's value.

func (ApiKeyFilter) String added in v1.44.208 

func (s ApiKeyFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ApiKeyRestrictions added in v1.44.208 

type ApiKeyRestrictions struct {

	// A list of allowed actions that an API key resource grants permissions to
	// perform. You must have at least one action for each type of resource. For
	// example, if you have a place resource, you must include at least one place
	// action.
	//
	// The following are valid values for the actions.
	//
	//    * Map actions geo:GetMap* - Allows all actions needed for map rendering.
	//
	//    * Place actions geo:SearchPlaceIndexForText - Allows geocoding. geo:SearchPlaceIndexForPosition
	//    - Allows reverse geocoding. geo:SearchPlaceIndexForSuggestions - Allows
	//    generating suggestions from text. GetPlace - Allows finding a place by
	//    place ID.
	//
	//    * Route actions geo:CalculateRoute - Allows point to point routing. geo:CalculateRouteMatrix
	//    - Allows calculating a matrix of routes.
	//
	// You must use these strings exactly. For example, to provide access to map
	// rendering, the only valid action is geo:GetMap* as an input to the list.
	// ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not. Similarly, you cannot
	// use ["geo:SearchPlaceIndexFor*"] - you must list each of the Place actions
	// separately.
	//
	// AllowActions is a required field
	AllowActions []*string `min:"1" type:"list" required:"true"`

	// An optional list of allowed HTTP referers for which requests must originate
	// from. Requests using this API key from other domains will not be allowed.
	//
	// Requirements:
	//
	//    * Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols
	//    in this list $\-._+!*`(),;/?:@=&
	//
	//    * May contain a percent (%) if followed by 2 hexadecimal digits (A-F,
	//    a-f, 0-9); this is used for URL encoding purposes.
	//
	//    * May contain wildcard characters question mark (?) and asterisk (*).
	//    Question mark (?) will replace any single character (including hexadecimal
	//    digits). Asterisk (*) will replace any multiple characters (including
	//    multiple hexadecimal digits).
	//
	//    * No spaces allowed. For example, https://example.com.
	AllowReferers []*string `min:"1" type:"list"`

	// A list of allowed resource ARNs that a API key bearer can perform actions
	// on.
	//
	//    * The ARN must be the correct ARN for a map, place, or route ARN. You
	//    may include wildcards in the resource-id to match multiple resources of
	//    the same type.
	//
	//    * The resources must be in the same partition, region, and account-id
	//    as the key that is being created.
	//
	//    * Other than wildcards, you must include the full ARN, including the arn,
	//    partition, service, region, account-id and resource-id delimited by colons
	//    (:).
	//
	//    * No spaces allowed, even with wildcards. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
	//
	// For more information about ARN format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
	//
	// AllowResources is a required field
	AllowResources []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

API Restrictions on the allowed actions, resources, and referers for an API key resource.

func (ApiKeyRestrictions) GoString added in v1.44.208 

func (s ApiKeyRestrictions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApiKeyRestrictions) SetAllowActions added in v1.44.208 

func (s *ApiKeyRestrictions) SetAllowActions(v []*string) *ApiKeyRestrictions

SetAllowActions sets the AllowActions field's value.

func (*ApiKeyRestrictions) SetAllowReferers added in v1.44.208 

func (s *ApiKeyRestrictions) SetAllowReferers(v []*string) *ApiKeyRestrictions

SetAllowReferers sets the AllowReferers field's value.

func (*ApiKeyRestrictions) SetAllowResources added in v1.44.208 

func (s *ApiKeyRestrictions) SetAllowResources(v []*string) *ApiKeyRestrictions

SetAllowResources sets the AllowResources field's value.

func (ApiKeyRestrictions) String added in v1.44.208 

func (s ApiKeyRestrictions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApiKeyRestrictions) Validate added in v1.44.208 

func (s *ApiKeyRestrictions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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
	//
	// ConsumerArn is a required field
	ConsumerArn *string `type:"string" required:"true"`

	// The name of the tracker resource to be associated with a geofence collection.
	//
	// TrackerName is a required field
	TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateTrackerConsumerInput) GoString 

func (s AssociateTrackerConsumerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateTrackerConsumerInput) SetConsumerArn 

func (s *AssociateTrackerConsumerInput) SetConsumerArn(v string) *AssociateTrackerConsumerInput

SetConsumerArn sets the ConsumerArn field's value.

func (*AssociateTrackerConsumerInput) SetTrackerName 

func (s *AssociateTrackerConsumerInput) SetTrackerName(v string) *AssociateTrackerConsumerInput

SetTrackerName sets the TrackerName field's value.

func (AssociateTrackerConsumerInput) String 

func (s AssociateTrackerConsumerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateTrackerConsumerInput) Validate 

func (s *AssociateTrackerConsumerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateTrackerConsumerOutput 

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

func (AssociateTrackerConsumerOutput) GoString 

func (s AssociateTrackerConsumerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AssociateTrackerConsumerOutput) String 

func (s AssociateTrackerConsumerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDeleteDevicePositionHistoryError added in v1.38.51 

type BatchDeleteDevicePositionHistoryError struct {

	// The ID of the device for this position.
	//
	// DeviceId is a required field
	DeviceId *string `min:"1" type:"string" required:"true"`

	// Contains the batch request error details associated with the request.
	//
	// Error is a required field
	Error *BatchItemError `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains the tracker resource details.

func (BatchDeleteDevicePositionHistoryError) GoString added in v1.38.51 

func (s BatchDeleteDevicePositionHistoryError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteDevicePositionHistoryError) SetDeviceId added in v1.38.51 

func (s *BatchDeleteDevicePositionHistoryError) SetDeviceId(v string) *BatchDeleteDevicePositionHistoryError

SetDeviceId sets the DeviceId field's value.

func (*BatchDeleteDevicePositionHistoryError) SetError added in v1.38.51 

func (s *BatchDeleteDevicePositionHistoryError) SetError(v *BatchItemError) *BatchDeleteDevicePositionHistoryError

SetError sets the Error field's value.

func (BatchDeleteDevicePositionHistoryError) String added in v1.38.51 

func (s BatchDeleteDevicePositionHistoryError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDeleteDevicePositionHistoryInput added in v1.38.51 

type BatchDeleteDevicePositionHistoryInput struct {

	// Devices whose position history you want to delete.
	//
	//    * For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]
	//
	// DeviceIds is a required field
	DeviceIds []*string `min:"1" type:"list" required:"true"`

	// The name of the tracker resource to delete the device position history from.
	//
	// TrackerName is a required field
	TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDeleteDevicePositionHistoryInput) GoString added in v1.38.51 

func (s BatchDeleteDevicePositionHistoryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteDevicePositionHistoryInput) SetDeviceIds added in v1.38.51 

func (s *BatchDeleteDevicePositionHistoryInput) SetDeviceIds(v []*string) *BatchDeleteDevicePositionHistoryInput

SetDeviceIds sets the DeviceIds field's value.

func (*BatchDeleteDevicePositionHistoryInput) SetTrackerName added in v1.38.51 

func (s *BatchDeleteDevicePositionHistoryInput) SetTrackerName(v string) *BatchDeleteDevicePositionHistoryInput

SetTrackerName sets the TrackerName field's value.

func (BatchDeleteDevicePositionHistoryInput) String added in v1.38.51 

func (s BatchDeleteDevicePositionHistoryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteDevicePositionHistoryInput) Validate added in v1.38.51 

func (s *BatchDeleteDevicePositionHistoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDeleteDevicePositionHistoryOutput added in v1.38.51 

type BatchDeleteDevicePositionHistoryOutput struct {

	// Contains error details for each device history that failed to delete.
	//
	// Errors is a required field
	Errors []*BatchDeleteDevicePositionHistoryError `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDeleteDevicePositionHistoryOutput) GoString added in v1.38.51 

func (s BatchDeleteDevicePositionHistoryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteDevicePositionHistoryOutput) SetErrors added in v1.38.51 

func (s *BatchDeleteDevicePositionHistoryOutput) SetErrors(v []*BatchDeleteDevicePositionHistoryError) *BatchDeleteDevicePositionHistoryOutput

SetErrors sets the Errors field's value.

func (BatchDeleteDevicePositionHistoryOutput) String added in v1.38.51 

func (s BatchDeleteDevicePositionHistoryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDeleteGeofenceError 

type BatchDeleteGeofenceError struct {

	// Contains details associated to the batch error.
	//
	// Error is a required field
	Error *BatchItemError `type:"structure" required:"true"`

	// The geofence associated with the error message.
	//
	// GeofenceId is a required field
	GeofenceId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains error details for each geofence that failed to delete from the geofence collection.

func (BatchDeleteGeofenceError) GoString 

func (s BatchDeleteGeofenceError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteGeofenceError) SetError 

func (s *BatchDeleteGeofenceError) SetError(v *BatchItemError) *BatchDeleteGeofenceError

SetError sets the Error field's value.

func (*BatchDeleteGeofenceError) SetGeofenceId 

func (s *BatchDeleteGeofenceError) SetGeofenceId(v string) *BatchDeleteGeofenceError

SetGeofenceId sets the GeofenceId field's value.

func (BatchDeleteGeofenceError) String 

func (s BatchDeleteGeofenceError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDeleteGeofenceInput 

type BatchDeleteGeofenceInput struct {

	// The geofence collection storing the geofences to be deleted.
	//
	// CollectionName is a required field
	CollectionName *string `location:"uri" locationName:"CollectionName" min:"1" type:"string" required:"true"`

	// The batch of geofences to be deleted.
	//
	// GeofenceIds is a required field
	GeofenceIds []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDeleteGeofenceInput) GoString 

func (s BatchDeleteGeofenceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteGeofenceInput) SetCollectionName 

func (s *BatchDeleteGeofenceInput) SetCollectionName(v string) *BatchDeleteGeofenceInput

SetCollectionName sets the CollectionName field's value.

func (*BatchDeleteGeofenceInput) SetGeofenceIds 

func (s *BatchDeleteGeofenceInput) SetGeofenceIds(v []*string) *BatchDeleteGeofenceInput

SetGeofenceIds sets the GeofenceIds field's value.

func (BatchDeleteGeofenceInput) String 

func (s BatchDeleteGeofenceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteGeofenceInput) Validate 

func (s *BatchDeleteGeofenceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDeleteGeofenceOutput 

type BatchDeleteGeofenceOutput struct {

	// Contains error details for each geofence that failed to delete.
	//
	// Errors is a required field
	Errors []*BatchDeleteGeofenceError `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDeleteGeofenceOutput) GoString 

func (s BatchDeleteGeofenceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteGeofenceOutput) SetErrors 

func (s *BatchDeleteGeofenceOutput) SetErrors(v []*BatchDeleteGeofenceError) *BatchDeleteGeofenceOutput

SetErrors sets the Errors field's value.

func (BatchDeleteGeofenceOutput) String 

func (s BatchDeleteGeofenceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchEvaluateGeofencesError 

type BatchEvaluateGeofencesError struct {

	// The device associated with the position evaluation error.
	//
	// DeviceId is a required field
	DeviceId *string `min:"1" type:"string" required:"true"`

	// Contains details associated to the batch error.
	//
	// Error is a required field
	Error *BatchItemError `type:"structure" required:"true"`

	// Specifies a timestamp for when the error occurred in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html)
	// format: YYYY-MM-DDThh:mm:ss.sssZ
	//
	// SampleTime is a required field
	SampleTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains error details for each device that failed to evaluate its position against the geofences in a given geofence collection.

func (BatchEvaluateGeofencesError) GoString 

func (s BatchEvaluateGeofencesError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchEvaluateGeofencesError) SetDeviceId 

func (s *BatchEvaluateGeofencesError) SetDeviceId(v string) *BatchEvaluateGeofencesError

SetDeviceId sets the DeviceId field's value.

func (*BatchEvaluateGeofencesError) SetError 

func (s *BatchEvaluateGeofencesError) SetError(v *BatchItemError) *BatchEvaluateGeofencesError

SetError sets the Error field's value.

func (*BatchEvaluateGeofencesError) SetSampleTime 

func (s *BatchEvaluateGeofencesError) SetSampleTime(v time.Time) *BatchEvaluateGeofencesError

SetSampleTime sets the SampleTime field's value.

func (BatchEvaluateGeofencesError) String 

func (s BatchEvaluateGeofencesError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchEvaluateGeofencesInput 

type BatchEvaluateGeofencesInput struct {

	// The geofence collection used in evaluating the position of devices against
	// its geofences.
	//
	// CollectionName is a required field
	CollectionName *string `location:"uri" locationName:"CollectionName" min:"1" type:"string" required:"true"`

	// Contains device details for each device to be evaluated against the given
	// geofence collection.
	//
	// DevicePositionUpdates is a required field
	DevicePositionUpdates []*DevicePositionUpdate `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchEvaluateGeofencesInput) GoString 

func (s BatchEvaluateGeofencesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchEvaluateGeofencesInput) SetCollectionName 

func (s *BatchEvaluateGeofencesInput) SetCollectionName(v string) *BatchEvaluateGeofencesInput

SetCollectionName sets the CollectionName field's value.

func (*BatchEvaluateGeofencesInput) SetDevicePositionUpdates 

func (s *BatchEvaluateGeofencesInput) SetDevicePositionUpdates(v []*DevicePositionUpdate) *BatchEvaluateGeofencesInput

SetDevicePositionUpdates sets the DevicePositionUpdates field's value.

func (BatchEvaluateGeofencesInput) String 

func (s BatchEvaluateGeofencesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchEvaluateGeofencesInput) Validate 

func (s *BatchEvaluateGeofencesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchEvaluateGeofencesOutput 

type BatchEvaluateGeofencesOutput struct {

	// Contains error details for each device that failed to evaluate its position
	// against the given geofence collection.
	//
	// Errors is a required field
	Errors []*BatchEvaluateGeofencesError `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchEvaluateGeofencesOutput) GoString 

func (s BatchEvaluateGeofencesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchEvaluateGeofencesOutput) SetErrors 

func (s *BatchEvaluateGeofencesOutput) SetErrors(v []*BatchEvaluateGeofencesError) *BatchEvaluateGeofencesOutput

SetErrors sets the Errors field's value.

func (BatchEvaluateGeofencesOutput) String 

func (s BatchEvaluateGeofencesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetDevicePositionError 

type BatchGetDevicePositionError struct {

	// The ID of the device that didn't return a position.
	//
	// DeviceId is a required field
	DeviceId *string `min:"1" type:"string" required:"true"`

	// Contains details related to the error code.
	//
	// Error is a required field
	Error *BatchItemError `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains error details for each device that didn't return a position.

func (BatchGetDevicePositionError) GoString 

func (s BatchGetDevicePositionError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetDevicePositionError) SetDeviceId 

func (s *BatchGetDevicePositionError) SetDeviceId(v string) *BatchGetDevicePositionError

SetDeviceId sets the DeviceId field's value.

func (*BatchGetDevicePositionError) SetError 

func (s *BatchGetDevicePositionError) SetError(v *BatchItemError) *BatchGetDevicePositionError

SetError sets the Error field's value.

func (BatchGetDevicePositionError) String 

func (s BatchGetDevicePositionError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetDevicePositionInput 

type BatchGetDevicePositionInput struct {

	// Devices whose position you want to retrieve.
	//
	//    * For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2
	//
	// DeviceIds is a required field
	DeviceIds []*string `min:"1" type:"list" required:"true"`

	// The tracker resource retrieving the device position.
	//
	// TrackerName is a required field
	TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetDevicePositionInput) GoString 

func (s BatchGetDevicePositionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetDevicePositionInput) SetDeviceIds 

func (s *BatchGetDevicePositionInput) SetDeviceIds(v []*string) *BatchGetDevicePositionInput

SetDeviceIds sets the DeviceIds field's value.

func (*BatchGetDevicePositionInput) SetTrackerName 

func (s *BatchGetDevicePositionInput) SetTrackerName(v string) *BatchGetDevicePositionInput

SetTrackerName sets the TrackerName field's value.

func (BatchGetDevicePositionInput) String 

func (s BatchGetDevicePositionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetDevicePositionInput) Validate 

func (s *BatchGetDevicePositionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.
	//
	// DevicePositions is a required field
	DevicePositions []*DevicePosition `type:"list" required:"true"`

	// Contains error details for each device that failed to send its position to
	// the tracker resource.
	//
	// Errors is a required field
	Errors []*BatchGetDevicePositionError `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetDevicePositionOutput) GoString 

func (s BatchGetDevicePositionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetDevicePositionOutput) SetDevicePositions 

func (s *BatchGetDevicePositionOutput) SetDevicePositions(v []*DevicePosition) *BatchGetDevicePositionOutput

SetDevicePositions sets the DevicePositions field's value.

func (*BatchGetDevicePositionOutput) SetErrors 

func (s *BatchGetDevicePositionOutput) SetErrors(v []*BatchGetDevicePositionError) *BatchGetDevicePositionOutput

SetErrors sets the Errors field's value.

func (BatchGetDevicePositionOutput) String 

func (s BatchGetDevicePositionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchItemError 

type BatchItemError struct {

	// The error code associated with the batch request error.
	Code *string `type:"string" enum:"BatchItemErrorCode"`

	// A message with the reason for the batch request error.
	Message *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the batch request error details associated with the request.

func (BatchItemError) GoString 

func (s BatchItemError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchItemError) SetCode 

func (s *BatchItemError) SetCode(v string) *BatchItemError

SetCode sets the Code field's value.

func (*BatchItemError) SetMessage 

func (s *BatchItemError) SetMessage(v string) *BatchItemError

SetMessage sets the Message field's value.

func (BatchItemError) String 

func (s BatchItemError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchPutGeofenceError 

type BatchPutGeofenceError struct {

	// Contains details associated to the batch error.
	//
	// Error is a required field
	Error *BatchItemError `type:"structure" required:"true"`

	// The geofence associated with the error message.
	//
	// GeofenceId is a required field
	GeofenceId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains error details for each geofence that failed to be stored in a given geofence collection.

func (BatchPutGeofenceError) GoString 

func (s BatchPutGeofenceError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutGeofenceError) SetError 

func (s *BatchPutGeofenceError) SetError(v *BatchItemError) *BatchPutGeofenceError

SetError sets the Error field's value.

func (*BatchPutGeofenceError) SetGeofenceId 

func (s *BatchPutGeofenceError) SetGeofenceId(v string) *BatchPutGeofenceError

SetGeofenceId sets the GeofenceId field's value.

func (BatchPutGeofenceError) String 

func (s BatchPutGeofenceError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchPutGeofenceInput 

type BatchPutGeofenceInput struct {

	// The geofence collection storing the geofences.
	//
	// CollectionName is a required field
	CollectionName *string `location:"uri" locationName:"CollectionName" min:"1" type:"string" required:"true"`

	// The batch of geofences to be stored in a geofence collection.
	//
	// Entries is a required field
	Entries []*BatchPutGeofenceRequestEntry `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchPutGeofenceInput) GoString 

func (s BatchPutGeofenceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutGeofenceInput) SetCollectionName 

func (s *BatchPutGeofenceInput) SetCollectionName(v string) *BatchPutGeofenceInput

SetCollectionName sets the CollectionName field's value.

func (*BatchPutGeofenceInput) SetEntries 

func (s *BatchPutGeofenceInput) SetEntries(v []*BatchPutGeofenceRequestEntry) *BatchPutGeofenceInput

SetEntries sets the Entries field's value.

func (BatchPutGeofenceInput) String 

func (s BatchPutGeofenceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutGeofenceInput) Validate 

func (s *BatchPutGeofenceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchPutGeofenceOutput 

type BatchPutGeofenceOutput struct {

	// Contains additional error details for each geofence that failed to be stored
	// in a geofence collection.
	//
	// Errors is a required field
	Errors []*BatchPutGeofenceError `type:"list" required:"true"`

	// Contains each geofence that was successfully stored in a geofence collection.
	//
	// Successes is a required field
	Successes []*BatchPutGeofenceSuccess `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchPutGeofenceOutput) GoString 

func (s BatchPutGeofenceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutGeofenceOutput) SetErrors 

func (s *BatchPutGeofenceOutput) SetErrors(v []*BatchPutGeofenceError) *BatchPutGeofenceOutput

SetErrors sets the Errors field's value.

func (*BatchPutGeofenceOutput) SetSuccesses 

func (s *BatchPutGeofenceOutput) SetSuccesses(v []*BatchPutGeofenceSuccess) *BatchPutGeofenceOutput

SetSuccesses sets the Successes field's value.

func (BatchPutGeofenceOutput) String 

func (s BatchPutGeofenceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchPutGeofenceRequestEntry 

type BatchPutGeofenceRequestEntry struct {

	// The identifier for the geofence to be stored in a given geofence collection.
	//
	// GeofenceId is a required field
	GeofenceId *string `min:"1" type:"string" required:"true"`

	// 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by BatchPutGeofenceRequestEntry's
	// String and GoString methods.
	GeofenceProperties map[string]*string `type:"map" sensitive:"true"`

	// 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 (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html)
	// format supports a maximum of 1,000 vertices. The Geofence geobuf (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html)
	// format supports a maximum of 100,000 vertices.
	//
	// Geometry is a required field
	Geometry *GeofenceGeometry `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains geofence geometry details.

func (BatchPutGeofenceRequestEntry) GoString 

func (s BatchPutGeofenceRequestEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutGeofenceRequestEntry) SetGeofenceId 

func (s *BatchPutGeofenceRequestEntry) SetGeofenceId(v string) *BatchPutGeofenceRequestEntry

SetGeofenceId sets the GeofenceId field's value.

func (*BatchPutGeofenceRequestEntry) SetGeofenceProperties added in v1.44.283 

func (s *BatchPutGeofenceRequestEntry) SetGeofenceProperties(v map[string]*string) *BatchPutGeofenceRequestEntry

SetGeofenceProperties sets the GeofenceProperties field's value.

func (*BatchPutGeofenceRequestEntry) SetGeometry 

func (s *BatchPutGeofenceRequestEntry) SetGeometry(v *GeofenceGeometry) *BatchPutGeofenceRequestEntry

SetGeometry sets the Geometry field's value.

func (BatchPutGeofenceRequestEntry) String 

func (s BatchPutGeofenceRequestEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutGeofenceRequestEntry) Validate 

func (s *BatchPutGeofenceRequestEntry) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchPutGeofenceSuccess 

type BatchPutGeofenceSuccess struct {

	// The timestamp for when the geofence was stored in a geofence collection in
	// ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format:
	// YYYY-MM-DDThh:mm:ss.sssZ
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The geofence successfully stored in a geofence collection.
	//
	// GeofenceId is a required field
	GeofenceId *string `min:"1" type:"string" required:"true"`

	// 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
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains a summary of each geofence that was successfully stored in a given geofence collection.

func (BatchPutGeofenceSuccess) GoString 

func (s BatchPutGeofenceSuccess) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutGeofenceSuccess) SetCreateTime 

func (s *BatchPutGeofenceSuccess) SetCreateTime(v time.Time) *BatchPutGeofenceSuccess

SetCreateTime sets the CreateTime field's value.

func (*BatchPutGeofenceSuccess) SetGeofenceId 

func (s *BatchPutGeofenceSuccess) SetGeofenceId(v string) *BatchPutGeofenceSuccess

SetGeofenceId sets the GeofenceId field's value.

func (*BatchPutGeofenceSuccess) SetUpdateTime 

func (s *BatchPutGeofenceSuccess) SetUpdateTime(v time.Time) *BatchPutGeofenceSuccess

SetUpdateTime sets the UpdateTime field's value.

func (BatchPutGeofenceSuccess) String 

func (s BatchPutGeofenceSuccess) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchUpdateDevicePositionError 

type BatchUpdateDevicePositionError struct {

	// The device associated with the failed location update.
	//
	// DeviceId is a required field
	DeviceId *string `min:"1" type:"string" required:"true"`

	// Contains details related to the error code such as the error code and error
	// message.
	//
	// Error is a required field
	Error *BatchItemError `type:"structure" required:"true"`

	// The timestamp at which the device position was determined. Uses ISO 8601
	// (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ.
	//
	// SampleTime is a required field
	SampleTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains error details for each device that failed to update its position.

func (BatchUpdateDevicePositionError) GoString 

func (s BatchUpdateDevicePositionError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchUpdateDevicePositionError) SetDeviceId 

func (s *BatchUpdateDevicePositionError) SetDeviceId(v string) *BatchUpdateDevicePositionError

SetDeviceId sets the DeviceId field's value.

func (*BatchUpdateDevicePositionError) SetError 

func (s *BatchUpdateDevicePositionError) SetError(v *BatchItemError) *BatchUpdateDevicePositionError

SetError sets the Error field's value.

func (*BatchUpdateDevicePositionError) SetSampleTime 

func (s *BatchUpdateDevicePositionError) SetSampleTime(v time.Time) *BatchUpdateDevicePositionError

SetSampleTime sets the SampleTime field's value.

func (BatchUpdateDevicePositionError) String 

func (s BatchUpdateDevicePositionError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchUpdateDevicePositionInput 

type BatchUpdateDevicePositionInput struct {

	// The name of the tracker resource to update.
	//
	// TrackerName is a required field
	TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"`

	// Contains the position update details for each device, up to 10 devices.
	//
	// Updates is a required field
	Updates []*DevicePositionUpdate `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchUpdateDevicePositionInput) GoString 

func (s BatchUpdateDevicePositionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchUpdateDevicePositionInput) SetTrackerName 

func (s *BatchUpdateDevicePositionInput) SetTrackerName(v string) *BatchUpdateDevicePositionInput

SetTrackerName sets the TrackerName field's value.

func (*BatchUpdateDevicePositionInput) SetUpdates 

func (s *BatchUpdateDevicePositionInput) SetUpdates(v []*DevicePositionUpdate) *BatchUpdateDevicePositionInput

SetUpdates sets the Updates field's value.

func (BatchUpdateDevicePositionInput) String 

func (s BatchUpdateDevicePositionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchUpdateDevicePositionInput) Validate 

func (s *BatchUpdateDevicePositionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchUpdateDevicePositionOutput 

type BatchUpdateDevicePositionOutput struct {

	// Contains error details for each device that failed to update its position.
	//
	// Errors is a required field
	Errors []*BatchUpdateDevicePositionError `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchUpdateDevicePositionOutput) GoString 

func (s BatchUpdateDevicePositionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchUpdateDevicePositionOutput) SetErrors 

func (s *BatchUpdateDevicePositionOutput) SetErrors(v []*BatchUpdateDevicePositionError) *BatchUpdateDevicePositionOutput

SetErrors sets the Errors field's value.

func (BatchUpdateDevicePositionOutput) String 

func (s BatchUpdateDevicePositionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CalculateRouteCarModeOptions added in v1.38.51 

type CalculateRouteCarModeOptions struct {

	// Avoids ferries when calculating routes.
	//
	// Default Value: false
	//
	// Valid Values: false | true
	AvoidFerries *bool `type:"boolean"`

	// Avoids tolls when calculating routes.
	//
	// Default Value: false
	//
	// Valid Values: false | true
	AvoidTolls *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Contains details about additional route preferences for requests that specify TravelMode as Car.

func (CalculateRouteCarModeOptions) GoString added in v1.38.51 

func (s CalculateRouteCarModeOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculateRouteCarModeOptions) SetAvoidFerries added in v1.38.51 

func (s *CalculateRouteCarModeOptions) SetAvoidFerries(v bool) *CalculateRouteCarModeOptions

SetAvoidFerries sets the AvoidFerries field's value.

func (*CalculateRouteCarModeOptions) SetAvoidTolls added in v1.38.51 

func (s *CalculateRouteCarModeOptions) SetAvoidTolls(v bool) *CalculateRouteCarModeOptions

SetAvoidTolls sets the AvoidTolls field's value.

func (CalculateRouteCarModeOptions) String added in v1.38.51 

func (s CalculateRouteCarModeOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CalculateRouteInput added in v1.38.51 

type CalculateRouteInput struct {

	// 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 `type:"timestamp" timestampFormat:"iso8601"`

	// The name of the route calculator resource that you want to use to calculate
	// the route.
	//
	// CalculatorName is a required field
	CalculatorName *string `location:"uri" locationName:"CalculatorName" min:"1" type:"string" required:"true"`

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

	// 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 `type:"boolean"`

	// The start position for the route. Defined in World Geodetic System (WGS 84)
	// (https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84) 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 (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html).
	// 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]
	//
	// DeparturePosition is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CalculateRouteInput's
	// String and GoString methods.
	//
	// DeparturePosition is a required field
	DeparturePosition []*float64 `min:"2" type:"list" required:"true" sensitive:"true"`

	// 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 (https://www.iso.org/iso-8601-date-and-time-format.html)
	//    format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
	DepartureTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The finish position for the route. Defined in World Geodetic System (WGS
	// 84) (https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84) 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 (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html).
	//
	// Valid Values: [-180 to 180,-90 to 90]
	//
	// DestinationPosition is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CalculateRouteInput's
	// String and GoString methods.
	//
	// DestinationPosition is a required field
	DestinationPosition []*float64 `min:"2" type:"list" required:"true" sensitive:"true"`

	// Set the unit system to specify the distance.
	//
	// Default Value: Kilometers
	DistanceUnit *string `type:"string" enum:"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 `type:"boolean"`

	// The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html)
	// to authorize the request.
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CalculateRouteInput's
	// String and GoString methods.
	Key *string `location:"querystring" locationName:"key" type:"string" sensitive:"true"`

	// Specifies the distance to optimize for when calculating a route.
	OptimizeFor *string `type:"string" enum:"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 (https://docs.aws.amazon.com/location/latest/developerguide/grab.html)
	// 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
	TravelMode *string `type:"string" enum:"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 *CalculateRouteTruckModeOptions `type:"structure"`

	// 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 (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html).
	//
	// 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]
	WaypointPositions [][]*float64 `type:"list" sensitive:"true"`
	// contains filtered or unexported fields
}

func (CalculateRouteInput) GoString added in v1.38.51 

func (s CalculateRouteInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculateRouteInput) SetArrivalTime added in v1.49.1 

func (s *CalculateRouteInput) SetArrivalTime(v time.Time) *CalculateRouteInput

SetArrivalTime sets the ArrivalTime field's value.

func (*CalculateRouteInput) SetCalculatorName added in v1.38.51 

func (s *CalculateRouteInput) SetCalculatorName(v string) *CalculateRouteInput

SetCalculatorName sets the CalculatorName field's value.

func (*CalculateRouteInput) SetCarModeOptions added in v1.38.51 

func (s *CalculateRouteInput) SetCarModeOptions(v *CalculateRouteCarModeOptions) *CalculateRouteInput

SetCarModeOptions sets the CarModeOptions field's value.

func (*CalculateRouteInput) SetDepartNow added in v1.38.51 

func (s *CalculateRouteInput) SetDepartNow(v bool) *CalculateRouteInput

SetDepartNow sets the DepartNow field's value.

func (*CalculateRouteInput) SetDeparturePosition added in v1.38.51 

func (s *CalculateRouteInput) SetDeparturePosition(v []*float64) *CalculateRouteInput

SetDeparturePosition sets the DeparturePosition field's value.

func (*CalculateRouteInput) SetDepartureTime added in v1.38.51 

func (s *CalculateRouteInput) SetDepartureTime(v time.Time) *CalculateRouteInput

SetDepartureTime sets the DepartureTime field's value.

func (*CalculateRouteInput) SetDestinationPosition added in v1.38.51 

func (s *CalculateRouteInput) SetDestinationPosition(v []*float64) *CalculateRouteInput

SetDestinationPosition sets the DestinationPosition field's value.

func (*CalculateRouteInput) SetDistanceUnit added in v1.38.51 

func (s *CalculateRouteInput) SetDistanceUnit(v string) *CalculateRouteInput

SetDistanceUnit sets the DistanceUnit field's value.

func (*CalculateRouteInput) SetIncludeLegGeometry added in v1.38.51 

func (s *CalculateRouteInput) SetIncludeLegGeometry(v bool) *CalculateRouteInput

SetIncludeLegGeometry sets the IncludeLegGeometry field's value.

func (*CalculateRouteInput) SetKey added in v1.44.297 

func (s *CalculateRouteInput) SetKey(v string) *CalculateRouteInput

SetKey sets the Key field's value.

func (*CalculateRouteInput) SetOptimizeFor added in v1.49.1 

func (s *CalculateRouteInput) SetOptimizeFor(v string) *CalculateRouteInput

SetOptimizeFor sets the OptimizeFor field's value.

func (*CalculateRouteInput) SetTravelMode added in v1.38.51 

func (s *CalculateRouteInput) SetTravelMode(v string) *CalculateRouteInput

SetTravelMode sets the TravelMode field's value.

func (*CalculateRouteInput) SetTruckModeOptions added in v1.38.51 

func (s *CalculateRouteInput) SetTruckModeOptions(v *CalculateRouteTruckModeOptions) *CalculateRouteInput

SetTruckModeOptions sets the TruckModeOptions field's value.

func (*CalculateRouteInput) SetWaypointPositions added in v1.38.51 

func (s *CalculateRouteInput) SetWaypointPositions(v [][]*float64) *CalculateRouteInput

SetWaypointPositions sets the WaypointPositions field's value.

func (CalculateRouteInput) String added in v1.38.51 

func (s CalculateRouteInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculateRouteInput) Validate added in v1.38.51 

func (s *CalculateRouteInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CalculateRouteMatrixInput added in v1.42.36 

type CalculateRouteMatrixInput struct {

	// The name of the route calculator resource that you want to use to calculate
	// the route matrix.
	//
	// CalculatorName is a required field
	CalculatorName *string `location:"uri" locationName:"CalculatorName" min:"1" type:"string" required:"true"`

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

	// 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 `type:"boolean"`

	// 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 (https://earth-info.nga.mil/GandG/wgs84/index.html)
	// 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 (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits)
	// 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 (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html).
	// The snapped value is available in the result in SnappedDeparturePositions.
	//
	// Valid Values: [-180 to 180,-90 to 90]
	//
	// DeparturePositions is a required field
	DeparturePositions [][]*float64 `min:"1" type:"list" required:"true" sensitive:"true"`

	// 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 (https://www.iso.org/iso-8601-date-and-time-format.html)
	//    format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
	DepartureTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// 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 (https://earth-info.nga.mil/GandG/wgs84/index.html)
	// 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 (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits)
	// 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 (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html).
	// The snapped value is available in the result in SnappedDestinationPositions.
	//
	// Valid Values: [-180 to 180,-90 to 90]
	//
	// DestinationPositions is a required field
	DestinationPositions [][]*float64 `min:"1" type:"list" required:"true" sensitive:"true"`

	// Set the unit system to specify the distance.
	//
	// Default Value: Kilometers
	DistanceUnit *string `type:"string" enum:"DistanceUnit"`

	// The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html)
	// to authorize the request.
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CalculateRouteMatrixInput's
	// String and GoString methods.
	Key *string `location:"querystring" locationName:"key" type:"string" sensitive:"true"`

	// 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 (https://docs.aws.amazon.com/location/latest/developerguide/grab.html)
	// in the Amazon Location Service Developer Guide.
	//
	// Default Value: Car
	TravelMode *string `type:"string" enum:"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 *CalculateRouteTruckModeOptions `type:"structure"`
	// contains filtered or unexported fields
}

func (CalculateRouteMatrixInput) GoString added in v1.42.36 

func (s CalculateRouteMatrixInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculateRouteMatrixInput) SetCalculatorName added in v1.42.36 

func (s *CalculateRouteMatrixInput) SetCalculatorName(v string) *CalculateRouteMatrixInput

SetCalculatorName sets the CalculatorName field's value.

func (*CalculateRouteMatrixInput) SetCarModeOptions added in v1.42.36 

func (s *CalculateRouteMatrixInput) SetCarModeOptions(v *CalculateRouteCarModeOptions) *CalculateRouteMatrixInput

SetCarModeOptions sets the CarModeOptions field's value.

func (*CalculateRouteMatrixInput) SetDepartNow added in v1.42.36 

func (s *CalculateRouteMatrixInput) SetDepartNow(v bool) *CalculateRouteMatrixInput

SetDepartNow sets the DepartNow field's value.

func (*CalculateRouteMatrixInput) SetDeparturePositions added in v1.42.36 

func (s *CalculateRouteMatrixInput) SetDeparturePositions(v [][]*float64) *CalculateRouteMatrixInput

SetDeparturePositions sets the DeparturePositions field's value.

func (*CalculateRouteMatrixInput) SetDepartureTime added in v1.42.36 

func (s *CalculateRouteMatrixInput) SetDepartureTime(v time.Time) *CalculateRouteMatrixInput

SetDepartureTime sets the DepartureTime field's value.

func (*CalculateRouteMatrixInput) SetDestinationPositions added in v1.42.36 

func (s *CalculateRouteMatrixInput) SetDestinationPositions(v [][]*float64) *CalculateRouteMatrixInput

SetDestinationPositions sets the DestinationPositions field's value.

func (*CalculateRouteMatrixInput) SetDistanceUnit added in v1.42.36 

func (s *CalculateRouteMatrixInput) SetDistanceUnit(v string) *CalculateRouteMatrixInput

SetDistanceUnit sets the DistanceUnit field's value.

func (*CalculateRouteMatrixInput) SetKey added in v1.44.297 

func (s *CalculateRouteMatrixInput) SetKey(v string) *CalculateRouteMatrixInput

SetKey sets the Key field's value.

func (*CalculateRouteMatrixInput) SetTravelMode added in v1.42.36 

func (s *CalculateRouteMatrixInput) SetTravelMode(v string) *CalculateRouteMatrixInput

SetTravelMode sets the TravelMode field's value.

func (*CalculateRouteMatrixInput) SetTruckModeOptions added in v1.42.36 

func (s *CalculateRouteMatrixInput) SetTruckModeOptions(v *CalculateRouteTruckModeOptions) *CalculateRouteMatrixInput

SetTruckModeOptions sets the TruckModeOptions field's value.

func (CalculateRouteMatrixInput) String added in v1.42.36 

func (s CalculateRouteMatrixInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculateRouteMatrixInput) Validate added in v1.42.36 

func (s *CalculateRouteMatrixInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CalculateRouteMatrixOutput added in v1.42.36 

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.
	//
	// RouteMatrix is a required field
	RouteMatrix [][]*RouteMatrixEntry `type:"list" required:"true"`

	// 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 `min:"1" type:"list" sensitive:"true"`

	// The list of destination positions for the route matrix used for calculation
	// of the RouteMatrix.
	SnappedDestinationPositions [][]*float64 `min:"1" type:"list" sensitive:"true"`

	// Contains information about the route matrix, DataSource, DistanceUnit, RouteCount
	// and ErrorCount.
	//
	// Summary is a required field
	Summary *CalculateRouteMatrixSummary `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Returns the result of the route matrix calculation.

func (CalculateRouteMatrixOutput) GoString added in v1.42.36 

func (s CalculateRouteMatrixOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculateRouteMatrixOutput) SetRouteMatrix added in v1.42.36 

func (s *CalculateRouteMatrixOutput) SetRouteMatrix(v [][]*RouteMatrixEntry) *CalculateRouteMatrixOutput

SetRouteMatrix sets the RouteMatrix field's value.

func (*CalculateRouteMatrixOutput) SetSnappedDeparturePositions added in v1.42.36 

func (s *CalculateRouteMatrixOutput) SetSnappedDeparturePositions(v [][]*float64) *CalculateRouteMatrixOutput

SetSnappedDeparturePositions sets the SnappedDeparturePositions field's value.

func (*CalculateRouteMatrixOutput) SetSnappedDestinationPositions added in v1.42.36 

func (s *CalculateRouteMatrixOutput) SetSnappedDestinationPositions(v [][]*float64) *CalculateRouteMatrixOutput

SetSnappedDestinationPositions sets the SnappedDestinationPositions field's value.

func (*CalculateRouteMatrixOutput) SetSummary added in v1.42.36 

func (s *CalculateRouteMatrixOutput) SetSummary(v *CalculateRouteMatrixSummary) *CalculateRouteMatrixOutput

SetSummary sets the Summary field's value.

func (CalculateRouteMatrixOutput) String added in v1.42.36 

func (s CalculateRouteMatrixOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CalculateRouteMatrixSummary added in v1.42.36 

type CalculateRouteMatrixSummary struct {

	// The data provider of traffic and road network data used to calculate the
	// routes. Indicates one of the available providers:
	//
	//    * Esri
	//
	//    * Grab
	//
	//    * Here
	//
	// For more information about data providers, see Amazon Location Service data
	// providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html).
	//
	// DataSource is a required field
	DataSource *string `type:"string" required:"true"`

	// The unit of measurement for route distances.
	//
	// DistanceUnit is a required field
	DistanceUnit *string `type:"string" required:"true" enum:"DistanceUnit"`

	// The count of error results in the route matrix. If this number is 0, all
	// routes were calculated successfully.
	//
	// ErrorCount is a required field
	ErrorCount *int64 `min:"1" type:"integer" required:"true"`

	// The count of cells in the route matrix. Equal to the number of DeparturePositions
	// multiplied by the number of DestinationPositions.
	//
	// RouteCount is a required field
	RouteCount *int64 `min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

A summary of the calculated route matrix.

func (CalculateRouteMatrixSummary) GoString added in v1.42.36 

func (s CalculateRouteMatrixSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculateRouteMatrixSummary) SetDataSource added in v1.42.36 

func (s *CalculateRouteMatrixSummary) SetDataSource(v string) *CalculateRouteMatrixSummary

SetDataSource sets the DataSource field's value.

func (*CalculateRouteMatrixSummary) SetDistanceUnit added in v1.42.36 

func (s *CalculateRouteMatrixSummary) SetDistanceUnit(v string) *CalculateRouteMatrixSummary

SetDistanceUnit sets the DistanceUnit field's value.

func (*CalculateRouteMatrixSummary) SetErrorCount added in v1.42.36 

func (s *CalculateRouteMatrixSummary) SetErrorCount(v int64) *CalculateRouteMatrixSummary

SetErrorCount sets the ErrorCount field's value.

func (*CalculateRouteMatrixSummary) SetRouteCount added in v1.42.36 

func (s *CalculateRouteMatrixSummary) SetRouteCount(v int64) *CalculateRouteMatrixSummary

SetRouteCount sets the RouteCount field's value.

func (CalculateRouteMatrixSummary) String added in v1.42.36 

func (s CalculateRouteMatrixSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CalculateRouteOutput added in v1.38.51 

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 (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html):
	//
	//    * 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.
	//
	// Legs is a required field
	Legs []*Leg `type:"list" required:"true"`

	// Contains information about the whole route, such as: RouteBBox, DataSource,
	// Distance, DistanceUnit, and DurationSeconds.
	//
	// Summary is a required field
	Summary *CalculateRouteSummary `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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

func (CalculateRouteOutput) GoString added in v1.38.51 

func (s CalculateRouteOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculateRouteOutput) SetLegs added in v1.38.51 

func (s *CalculateRouteOutput) SetLegs(v []*Leg) *CalculateRouteOutput

SetLegs sets the Legs field's value.

func (*CalculateRouteOutput) SetSummary added in v1.38.51 

func (s *CalculateRouteOutput) SetSummary(v *CalculateRouteSummary) *CalculateRouteOutput

SetSummary sets the Summary field's value.

func (CalculateRouteOutput) String added in v1.38.51 

func (s CalculateRouteOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CalculateRouteSummary added in v1.38.51 

type CalculateRouteSummary struct {

	// The data provider of traffic and road network data used to calculate the
	// route. Indicates one of the available providers:
	//
	//    * Esri
	//
	//    * Grab
	//
	//    * Here
	//
	// For more information about data providers, see Amazon Location Service data
	// providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html).
	//
	// DataSource is a required field
	DataSource *string `type:"string" required:"true"`

	// The total distance covered by the route. The sum of the distance travelled
	// between every stop on the route.
	//
	// If Esri is the data source for the route calculator, the route distance can’t
	// be greater than 400 km. If the route exceeds 400 km, the response is a 400
	// RoutesValidationException error.
	//
	// Distance is a required field
	Distance *float64 `type:"double" required:"true"`

	// The unit of measurement for route distances.
	//
	// DistanceUnit is a required field
	DistanceUnit *string `type:"string" required:"true" enum:"DistanceUnit"`

	// The total travel time for the route measured in seconds. The sum of the travel
	// time between every stop on the route.
	//
	// DurationSeconds is a required field
	DurationSeconds *float64 `type:"double" required:"true"`

	// Specifies a geographical box surrounding a route. Used to zoom into a route
	// when displaying it in a map. For example, [min x, min y, max x, max y].
	//
	// 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.
	//
	// The next 2 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 latitude of the upper
	//    northeast corner.
	//
	// RouteBBox is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CalculateRouteSummary's
	// String and GoString methods.
	//
	// RouteBBox is a required field
	RouteBBox []*float64 `min:"4" type:"list" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

A summary of the calculated route.

func (CalculateRouteSummary) GoString added in v1.38.51 

func (s CalculateRouteSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculateRouteSummary) SetDataSource added in v1.38.51 

func (s *CalculateRouteSummary) SetDataSource(v string) *CalculateRouteSummary

SetDataSource sets the DataSource field's value.

func (*CalculateRouteSummary) SetDistance added in v1.38.51 

func (s *CalculateRouteSummary) SetDistance(v float64) *CalculateRouteSummary

SetDistance sets the Distance field's value.

func (*CalculateRouteSummary) SetDistanceUnit added in v1.38.51 

func (s *CalculateRouteSummary) SetDistanceUnit(v string) *CalculateRouteSummary

SetDistanceUnit sets the DistanceUnit field's value.

func (*CalculateRouteSummary) SetDurationSeconds added in v1.38.51 

func (s *CalculateRouteSummary) SetDurationSeconds(v float64) *CalculateRouteSummary

SetDurationSeconds sets the DurationSeconds field's value.

func (*CalculateRouteSummary) SetRouteBBox added in v1.38.51 

func (s *CalculateRouteSummary) SetRouteBBox(v []*float64) *CalculateRouteSummary

SetRouteBBox sets the RouteBBox field's value.

func (CalculateRouteSummary) String added in v1.38.51 

func (s CalculateRouteSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CalculateRouteTruckModeOptions added in v1.38.51 

type CalculateRouteTruckModeOptions struct {

	// Avoids ferries when calculating routes.
	//
	// Default Value: false
	//
	// Valid Values: false | true
	AvoidFerries *bool `type:"boolean"`

	// Avoids tolls when calculating routes.
	//
	// Default Value: false
	//
	// Valid Values: false | true
	AvoidTolls *bool `type:"boolean"`

	// Specifies the truck's dimension specifications including length, height,
	// width, and unit of measurement. Used to avoid roads that can't support the
	// truck's dimensions.
	Dimensions *TruckDimensions `type:"structure"`

	// Specifies the truck's weight specifications including total weight and unit
	// of measurement. Used to avoid roads that can't support the truck's weight.
	Weight *TruckWeight `type:"structure"`
	// contains filtered or unexported fields
}

Contains details about additional route preferences for requests that specify TravelMode as Truck.

func (CalculateRouteTruckModeOptions) GoString added in v1.38.51 

func (s CalculateRouteTruckModeOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculateRouteTruckModeOptions) SetAvoidFerries added in v1.38.51 

func (s *CalculateRouteTruckModeOptions) SetAvoidFerries(v bool) *CalculateRouteTruckModeOptions

SetAvoidFerries sets the AvoidFerries field's value.

func (*CalculateRouteTruckModeOptions) SetAvoidTolls added in v1.38.51 

func (s *CalculateRouteTruckModeOptions) SetAvoidTolls(v bool) *CalculateRouteTruckModeOptions

SetAvoidTolls sets the AvoidTolls field's value.

func (*CalculateRouteTruckModeOptions) SetDimensions added in v1.38.51 

func (s *CalculateRouteTruckModeOptions) SetDimensions(v *TruckDimensions) *CalculateRouteTruckModeOptions

SetDimensions sets the Dimensions field's value.

func (*CalculateRouteTruckModeOptions) SetWeight added in v1.38.51 

func (s *CalculateRouteTruckModeOptions) SetWeight(v *TruckWeight) *CalculateRouteTruckModeOptions

SetWeight sets the Weight field's value.

func (CalculateRouteTruckModeOptions) String added in v1.38.51 

func (s CalculateRouteTruckModeOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CellSignals added in v1.53.18 

type CellSignals struct {

	// Information about the Long-Term Evolution (LTE) network the device is connected
	// to.
	//
	// LteCellDetails is a required field
	LteCellDetails []*LteCellDetails `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The cellular network communication infrastructure that the device uses.

func (CellSignals) GoString added in v1.53.18 

func (s CellSignals) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CellSignals) SetLteCellDetails added in v1.53.18 

func (s *CellSignals) SetLteCellDetails(v []*LteCellDetails) *CellSignals

SetLteCellDetails sets the LteCellDetails field's value.

func (CellSignals) String added in v1.53.18 

func (s CellSignals) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CellSignals) Validate added in v1.53.18 

func (s *CellSignals) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Circle added in v1.44.72 

type Circle struct {

	// A single point geometry, specifying the center of the circle, using WGS 84
	// (https://gisgeography.com/wgs84-world-geodetic-system/) coordinates, in the
	// form [longitude, latitude].
	//
	// Center is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Circle's
	// String and GoString methods.
	//
	// Center is a required field
	Center []*float64 `min:"2" type:"list" required:"true" sensitive:"true"`

	// The radius of the circle in meters. Must be greater than zero and no larger
	// than 100,000 (100 kilometers).
	//
	// Radius is a required field
	Radius *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

A circle on the earth, as defined by a center point and a radius.

func (Circle) GoString added in v1.44.72 

func (s Circle) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Circle) SetCenter added in v1.44.72 

func (s *Circle) SetCenter(v []*float64) *Circle

SetCenter sets the Center field's value.

func (*Circle) SetRadius added in v1.44.72 

func (s *Circle) SetRadius(v float64) *Circle

SetRadius sets the Radius field's value.

func (Circle) String added in v1.44.72 

func (s Circle) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Circle) Validate added in v1.44.72 

func (s *Circle) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConflictException 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request was unsuccessful because of a conflict.

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// CollectionName is a required field
	CollectionName *string `min:"1" type:"string" required:"true"`

	// An optional description for the geofence collection.
	Description *string `type:"string"`

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

	// No longer used. If included, the only allowed value is RequestBasedUsage.
	//
	// Deprecated: Deprecated. If included, the only allowed value is RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"`

	// This parameter is no longer used.
	//
	// Deprecated: Deprecated. No longer allowed.
	PricingPlanDataSource *string `deprecated:"true" type:"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 `type:"map"`
	// contains filtered or unexported fields
}

func (CreateGeofenceCollectionInput) GoString 

func (s CreateGeofenceCollectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGeofenceCollectionInput) SetCollectionName 

func (s *CreateGeofenceCollectionInput) SetCollectionName(v string) *CreateGeofenceCollectionInput

SetCollectionName sets the CollectionName field's value.

func (*CreateGeofenceCollectionInput) SetDescription 

func (s *CreateGeofenceCollectionInput) SetDescription(v string) *CreateGeofenceCollectionInput

SetDescription sets the Description field's value.

func (*CreateGeofenceCollectionInput) SetKmsKeyId added in v1.38.51 

func (s *CreateGeofenceCollectionInput) SetKmsKeyId(v string) *CreateGeofenceCollectionInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateGeofenceCollectionInput) SetPricingPlan 

func (s *CreateGeofenceCollectionInput) SetPricingPlan(v string) *CreateGeofenceCollectionInput

SetPricingPlan sets the PricingPlan field's value.

func (*CreateGeofenceCollectionInput) SetPricingPlanDataSource added in v1.38.8 

func (s *CreateGeofenceCollectionInput) SetPricingPlanDataSource(v string) *CreateGeofenceCollectionInput

SetPricingPlanDataSource sets the PricingPlanDataSource field's value.

func (*CreateGeofenceCollectionInput) SetTags added in v1.38.51 

func (s *CreateGeofenceCollectionInput) SetTags(v map[string]*string) *CreateGeofenceCollectionInput

SetTags sets the Tags field's value.

func (CreateGeofenceCollectionInput) String 

func (s CreateGeofenceCollectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGeofenceCollectionInput) Validate 

func (s *CreateGeofenceCollectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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
	//
	// CollectionArn is a required field
	CollectionArn *string `type:"string" required:"true"`

	// The name for the geofence collection.
	//
	// CollectionName is a required field
	CollectionName *string `min:"1" type:"string" required:"true"`

	// 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
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (CreateGeofenceCollectionOutput) GoString 

func (s CreateGeofenceCollectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGeofenceCollectionOutput) SetCollectionArn 

func (s *CreateGeofenceCollectionOutput) SetCollectionArn(v string) *CreateGeofenceCollectionOutput

SetCollectionArn sets the CollectionArn field's value.

func (*CreateGeofenceCollectionOutput) SetCollectionName 

func (s *CreateGeofenceCollectionOutput) SetCollectionName(v string) *CreateGeofenceCollectionOutput

SetCollectionName sets the CollectionName field's value.

func (*CreateGeofenceCollectionOutput) SetCreateTime 

func (s *CreateGeofenceCollectionOutput) SetCreateTime(v time.Time) *CreateGeofenceCollectionOutput

SetCreateTime sets the CreateTime field's value.

func (CreateGeofenceCollectionOutput) String 

func (s CreateGeofenceCollectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateKeyInput added in v1.44.208 

type CreateKeyInput struct {

	// An optional description for the API key resource.
	Description *string `type:"string"`

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

	// 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.
	//
	// KeyName is a required field
	KeyName *string `min:"1" type:"string" required:"true"`

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

	// The API key restrictions for the API key resource.
	//
	// Restrictions is a required field
	Restrictions *ApiKeyRestrictions `type:"structure" required:"true"`

	// 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 `type:"map"`
	// contains filtered or unexported fields
}

func (CreateKeyInput) GoString added in v1.44.208 

func (s CreateKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateKeyInput) SetDescription added in v1.44.208 

func (s *CreateKeyInput) SetDescription(v string) *CreateKeyInput

SetDescription sets the Description field's value.

func (*CreateKeyInput) SetExpireTime added in v1.44.208 

func (s *CreateKeyInput) SetExpireTime(v time.Time) *CreateKeyInput

SetExpireTime sets the ExpireTime field's value.

func (*CreateKeyInput) SetKeyName added in v1.44.208 

func (s *CreateKeyInput) SetKeyName(v string) *CreateKeyInput

SetKeyName sets the KeyName field's value.

func (*CreateKeyInput) SetNoExpiry added in v1.44.208 

func (s *CreateKeyInput) SetNoExpiry(v bool) *CreateKeyInput

SetNoExpiry sets the NoExpiry field's value.

func (*CreateKeyInput) SetRestrictions added in v1.44.208 

func (s *CreateKeyInput) SetRestrictions(v *ApiKeyRestrictions) *CreateKeyInput

SetRestrictions sets the Restrictions field's value.

func (*CreateKeyInput) SetTags added in v1.44.208 

func (s *CreateKeyInput) SetTags(v map[string]*string) *CreateKeyInput

SetTags sets the Tags field's value.

func (CreateKeyInput) String added in v1.44.208 

func (s CreateKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateKeyInput) Validate added in v1.44.208 

func (s *CreateKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateKeyOutput added in v1.44.208 

type CreateKeyOutput struct {

	// The timestamp for when the API key resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html)
	// format: YYYY-MM-DDThh:mm:ss.sssZ.
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The key value/string of an API key. This value is used when making API calls
	// to authorize the call. For example, see GetMapGlyphs (https://docs.aws.amazon.com/location/latest/APIReference/API_GetMapGlyphs.html).
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateKeyOutput's
	// String and GoString methods.
	//
	// Key is a required field
	Key *string `type:"string" required:"true" sensitive:"true"`

	// 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
	//
	// KeyArn is a required field
	KeyArn *string `type:"string" required:"true"`

	// The name of the API key resource.
	//
	// KeyName is a required field
	KeyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateKeyOutput) GoString added in v1.44.208 

func (s CreateKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateKeyOutput) SetCreateTime added in v1.44.208 

func (s *CreateKeyOutput) SetCreateTime(v time.Time) *CreateKeyOutput

SetCreateTime sets the CreateTime field's value.

func (*CreateKeyOutput) SetKey added in v1.44.208 

func (s *CreateKeyOutput) SetKey(v string) *CreateKeyOutput

SetKey sets the Key field's value.

func (*CreateKeyOutput) SetKeyArn added in v1.44.208 

func (s *CreateKeyOutput) SetKeyArn(v string) *CreateKeyOutput

SetKeyArn sets the KeyArn field's value.

func (*CreateKeyOutput) SetKeyName added in v1.44.208 

func (s *CreateKeyOutput) SetKeyName(v string) *CreateKeyOutput

SetKeyName sets the KeyName field's value.

func (CreateKeyOutput) String added in v1.44.208 

func (s CreateKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// Configuration is a required field
	Configuration *MapConfiguration `type:"structure" required:"true"`

	// An optional description for the map resource.
	Description *string `type:"string"`

	// 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.
	//
	// MapName is a required field
	MapName *string `min:"1" type:"string" required:"true"`

	// No longer used. If included, the only allowed value is RequestBasedUsage.
	//
	// Deprecated: Deprecated. If included, the only allowed value is RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"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 `type:"map"`
	// contains filtered or unexported fields
}

func (CreateMapInput) GoString 

func (s CreateMapInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMapInput) SetConfiguration 

func (s *CreateMapInput) SetConfiguration(v *MapConfiguration) *CreateMapInput

SetConfiguration sets the Configuration field's value.

func (*CreateMapInput) SetDescription 

func (s *CreateMapInput) SetDescription(v string) *CreateMapInput

SetDescription sets the Description field's value.

func (*CreateMapInput) SetMapName 

func (s *CreateMapInput) SetMapName(v string) *CreateMapInput

SetMapName sets the MapName field's value.

func (*CreateMapInput) SetPricingPlan 

func (s *CreateMapInput) SetPricingPlan(v string) *CreateMapInput

SetPricingPlan sets the PricingPlan field's value.

func (*CreateMapInput) SetTags added in v1.38.51 

func (s *CreateMapInput) SetTags(v map[string]*string) *CreateMapInput

SetTags sets the Tags field's value.

func (CreateMapInput) String 

func (s CreateMapInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMapInput) Validate 

func (s *CreateMapInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// 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
	//
	// MapArn is a required field
	MapArn *string `type:"string" required:"true"`

	// The name of the map resource.
	//
	// MapName is a required field
	MapName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateMapOutput) GoString 

func (s CreateMapOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMapOutput) SetCreateTime 

func (s *CreateMapOutput) SetCreateTime(v time.Time) *CreateMapOutput

SetCreateTime sets the CreateTime field's value.

func (*CreateMapOutput) SetMapArn 

func (s *CreateMapOutput) SetMapArn(v string) *CreateMapOutput

SetMapArn sets the MapArn field's value.

func (*CreateMapOutput) SetMapName 

func (s *CreateMapOutput) SetMapName(v string) *CreateMapOutput

SetMapName sets the MapName field's value.

func (CreateMapOutput) String 

func (s CreateMapOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// Specifies the data storage option requesting Places.
	DataSourceConfiguration *DataSourceConfiguration `type:"structure"`

	// The optional description for the place index resource.
	Description *string `type:"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.
	//
	// IndexName is a required field
	IndexName *string `min:"1" type:"string" required:"true"`

	// No longer used. If included, the only allowed value is RequestBasedUsage.
	//
	// Deprecated: Deprecated. If included, the only allowed value is RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"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 `type:"map"`
	// contains filtered or unexported fields
}

func (CreatePlaceIndexInput) GoString 

func (s CreatePlaceIndexInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePlaceIndexInput) SetDataSource 

func (s *CreatePlaceIndexInput) SetDataSource(v string) *CreatePlaceIndexInput

SetDataSource sets the DataSource field's value.

func (*CreatePlaceIndexInput) SetDataSourceConfiguration 

func (s *CreatePlaceIndexInput) SetDataSourceConfiguration(v *DataSourceConfiguration) *CreatePlaceIndexInput

SetDataSourceConfiguration sets the DataSourceConfiguration field's value.

func (*CreatePlaceIndexInput) SetDescription 

func (s *CreatePlaceIndexInput) SetDescription(v string) *CreatePlaceIndexInput

SetDescription sets the Description field's value.

func (*CreatePlaceIndexInput) SetIndexName 

func (s *CreatePlaceIndexInput) SetIndexName(v string) *CreatePlaceIndexInput

SetIndexName sets the IndexName field's value.

func (*CreatePlaceIndexInput) SetPricingPlan 

func (s *CreatePlaceIndexInput) SetPricingPlan(v string) *CreatePlaceIndexInput

SetPricingPlan sets the PricingPlan field's value.

func (*CreatePlaceIndexInput) SetTags added in v1.38.51 

func (s *CreatePlaceIndexInput) SetTags(v map[string]*string) *CreatePlaceIndexInput

SetTags sets the Tags field's value.

func (CreatePlaceIndexInput) String 

func (s CreatePlaceIndexInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePlaceIndexInput) Validate 

func (s *CreatePlaceIndexInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// 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
	//
	// IndexArn is a required field
	IndexArn *string `type:"string" required:"true"`

	// The name for the place index resource.
	//
	// IndexName is a required field
	IndexName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreatePlaceIndexOutput) GoString 

func (s CreatePlaceIndexOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePlaceIndexOutput) SetCreateTime 

func (s *CreatePlaceIndexOutput) SetCreateTime(v time.Time) *CreatePlaceIndexOutput

SetCreateTime sets the CreateTime field's value.

func (*CreatePlaceIndexOutput) SetIndexArn 

func (s *CreatePlaceIndexOutput) SetIndexArn(v string) *CreatePlaceIndexOutput

SetIndexArn sets the IndexArn field's value.

func (*CreatePlaceIndexOutput) SetIndexName 

func (s *CreatePlaceIndexOutput) SetIndexName(v string) *CreatePlaceIndexOutput

SetIndexName sets the IndexName field's value.

func (CreatePlaceIndexOutput) String 

func (s CreatePlaceIndexOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateRouteCalculatorInput added in v1.38.51 

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.
	//
	// CalculatorName is a required field
	CalculatorName *string `min:"1" type:"string" required:"true"`

	// Specifies the data provider of traffic and road network data.
	//
	// This field is case-sensitive. Enter the valid values as shown. For example,
	// entering HERE returns an error.
	//
	// Valid values include:
	//
	//    * Esri – For additional information about Esri (https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s
	//    coverage in your region of interest, see Esri details on street networks
	//    and traffic coverage (https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm).
	//    Route calculators that use Esri as a data source only calculate routes
	//    that are shorter than 400 km.
	//
	//    * Grab – Grab provides routing functionality for Southeast Asia. For
	//    additional information about GrabMaps (https://docs.aws.amazon.com/location/latest/developerguide/grab.html)'
	//    coverage, see GrabMaps countries and areas covered (https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area).
	//
	//    * Here – For additional information about HERE Technologies (https://docs.aws.amazon.com/location/latest/developerguide/HERE.html)'
	//    coverage in your region of interest, see HERE car routing coverage (https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html)
	//    and HERE truck routing coverage (https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html).
	//
	// For additional information , see Data providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html)
	// on the Amazon Location Service Developer Guide.
	//
	// DataSource is a required field
	DataSource *string `type:"string" required:"true"`

	// The optional description for the route calculator resource.
	Description *string `type:"string"`

	// No longer used. If included, the only allowed value is RequestBasedUsage.
	//
	// Deprecated: Deprecated. If included, the only allowed value is RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"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 `type:"map"`
	// contains filtered or unexported fields
}

func (CreateRouteCalculatorInput) GoString added in v1.38.51 

func (s CreateRouteCalculatorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRouteCalculatorInput) SetCalculatorName added in v1.38.51 

func (s *CreateRouteCalculatorInput) SetCalculatorName(v string) *CreateRouteCalculatorInput

SetCalculatorName sets the CalculatorName field's value.

func (*CreateRouteCalculatorInput) SetDataSource added in v1.38.51 

func (s *CreateRouteCalculatorInput) SetDataSource(v string) *CreateRouteCalculatorInput

SetDataSource sets the DataSource field's value.

func (*CreateRouteCalculatorInput) SetDescription added in v1.38.51 

func (s *CreateRouteCalculatorInput) SetDescription(v string) *CreateRouteCalculatorInput

SetDescription sets the Description field's value.

func (*CreateRouteCalculatorInput) SetPricingPlan added in v1.38.51 

func (s *CreateRouteCalculatorInput) SetPricingPlan(v string) *CreateRouteCalculatorInput

SetPricingPlan sets the PricingPlan field's value.

func (*CreateRouteCalculatorInput) SetTags added in v1.38.51 

func (s *CreateRouteCalculatorInput) SetTags(v map[string]*string) *CreateRouteCalculatorInput

SetTags sets the Tags field's value.

func (CreateRouteCalculatorInput) String added in v1.38.51 

func (s CreateRouteCalculatorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRouteCalculatorInput) Validate added in v1.38.51 

func (s *CreateRouteCalculatorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateRouteCalculatorOutput added in v1.38.51 

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
	//
	// CalculatorArn is a required field
	CalculatorArn *string `type:"string" required:"true"`

	// The name of the route calculator resource.
	//
	//    * For example, ExampleRouteCalculator.
	//
	// CalculatorName is a required field
	CalculatorName *string `min:"1" type:"string" required:"true"`

	// The timestamp when the route calculator resource was created in ISO 8601
	// (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ.
	//
	//    * For example, 2020–07-2T12:15:20.000Z+01:00
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (CreateRouteCalculatorOutput) GoString added in v1.38.51 

func (s CreateRouteCalculatorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRouteCalculatorOutput) SetCalculatorArn added in v1.38.51 

func (s *CreateRouteCalculatorOutput) SetCalculatorArn(v string) *CreateRouteCalculatorOutput

SetCalculatorArn sets the CalculatorArn field's value.

func (*CreateRouteCalculatorOutput) SetCalculatorName added in v1.38.51 

func (s *CreateRouteCalculatorOutput) SetCalculatorName(v string) *CreateRouteCalculatorOutput

SetCalculatorName sets the CalculatorName field's value.

func (*CreateRouteCalculatorOutput) SetCreateTime added in v1.38.51 

func (s *CreateRouteCalculatorOutput) SetCreateTime(v time.Time) *CreateRouteCalculatorOutput

SetCreateTime sets the CreateTime field's value.

func (CreateRouteCalculatorOutput) String added in v1.38.51 

func (s CreateRouteCalculatorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateTrackerInput 

type CreateTrackerInput struct {

	// An optional description for the tracker resource.
	Description *string `type:"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 `type:"boolean"`

	// Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS
	// customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html).
	//
	// 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.
	KmsKeyEnableGeospatialQueries *bool `type:"boolean"`

	// A key identifier for an Amazon Web Services KMS customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html).
	// Enter a key ID, key ARN, alias name, or alias ARN.
	KmsKeyId *string `min:"1" type:"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 *string `type:"string" enum:"PositionFiltering"`

	// No longer used. If included, the only allowed value is RequestBasedUsage.
	//
	// Deprecated: Deprecated. If included, the only allowed value is RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"`

	// This parameter is no longer used.
	//
	// Deprecated: Deprecated. No longer allowed.
	PricingPlanDataSource *string `deprecated:"true" type:"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 `type:"map"`

	// 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.
	//
	// TrackerName is a required field
	TrackerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateTrackerInput) GoString 

func (s CreateTrackerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTrackerInput) SetDescription 

func (s *CreateTrackerInput) SetDescription(v string) *CreateTrackerInput

SetDescription sets the Description field's value.

func (*CreateTrackerInput) SetEventBridgeEnabled added in v1.44.297 

func (s *CreateTrackerInput) SetEventBridgeEnabled(v bool) *CreateTrackerInput

SetEventBridgeEnabled sets the EventBridgeEnabled field's value.

func (*CreateTrackerInput) SetKmsKeyEnableGeospatialQueries added in v1.45.21 

func (s *CreateTrackerInput) SetKmsKeyEnableGeospatialQueries(v bool) *CreateTrackerInput

SetKmsKeyEnableGeospatialQueries sets the KmsKeyEnableGeospatialQueries field's value.

func (*CreateTrackerInput) SetKmsKeyId added in v1.38.51 

func (s *CreateTrackerInput) SetKmsKeyId(v string) *CreateTrackerInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateTrackerInput) SetPositionFiltering added in v1.40.56 

func (s *CreateTrackerInput) SetPositionFiltering(v string) *CreateTrackerInput

SetPositionFiltering sets the PositionFiltering field's value.

func (*CreateTrackerInput) SetPricingPlan 

func (s *CreateTrackerInput) SetPricingPlan(v string) *CreateTrackerInput

SetPricingPlan sets the PricingPlan field's value.

func (*CreateTrackerInput) SetPricingPlanDataSource added in v1.38.8 

func (s *CreateTrackerInput) SetPricingPlanDataSource(v string) *CreateTrackerInput

SetPricingPlanDataSource sets the PricingPlanDataSource field's value.

func (*CreateTrackerInput) SetTags added in v1.38.51 

func (s *CreateTrackerInput) SetTags(v map[string]*string) *CreateTrackerInput

SetTags sets the Tags field's value.

func (*CreateTrackerInput) SetTrackerName 

func (s *CreateTrackerInput) SetTrackerName(v string) *CreateTrackerInput

SetTrackerName sets the TrackerName field's value.

func (CreateTrackerInput) String 

func (s CreateTrackerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTrackerInput) Validate 

func (s *CreateTrackerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// 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
	//
	// TrackerArn is a required field
	TrackerArn *string `type:"string" required:"true"`

	// The name of the tracker resource.
	//
	// TrackerName is a required field
	TrackerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateTrackerOutput) GoString 

func (s CreateTrackerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTrackerOutput) SetCreateTime 

func (s *CreateTrackerOutput) SetCreateTime(v time.Time) *CreateTrackerOutput

SetCreateTime sets the CreateTime field's value.

func (*CreateTrackerOutput) SetTrackerArn 

func (s *CreateTrackerOutput) SetTrackerArn(v string) *CreateTrackerOutput

SetTrackerArn sets the TrackerArn field's value.

func (*CreateTrackerOutput) SetTrackerName 

func (s *CreateTrackerOutput) SetTrackerName(v string) *CreateTrackerOutput

SetTrackerName sets the TrackerName field's value.

func (CreateTrackerOutput) String 

func (s CreateTrackerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataSourceConfiguration 

type DataSourceConfiguration struct {

	// Specifies how the results of an operation will be stored by the caller.
	//
	// Valid values include:
	//
	//    * SingleUse specifies that the results won't be stored.
	//
	//    * Storage specifies that the result can be cached or stored in a database.
	//
	// Default value: SingleUse
	IntendedUse *string `type:"string" enum:"IntendedUse"`
	// contains filtered or unexported fields
}

Specifies the data storage option chosen for requesting Places.

When using Amazon Location Places:

  • If using HERE Technologies as a data provider, you can't store results for locations in Japan by setting IntendedUse to Storage. parameter.

  • Under the MobileAssetTracking or MobilAssetManagement pricing plan, you can't store results from your place index resources by setting IntendedUse to Storage. This returns a validation exception error.

For more information, see the AWS Service Terms (https://aws.amazon.com/service-terms/) for Amazon Location Service.

func (DataSourceConfiguration) GoString 

func (s DataSourceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceConfiguration) SetIntendedUse 

func (s *DataSourceConfiguration) SetIntendedUse(v string) *DataSourceConfiguration

SetIntendedUse sets the IntendedUse field's value.

func (DataSourceConfiguration) String 

func (s DataSourceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteGeofenceCollectionInput 

type DeleteGeofenceCollectionInput struct {

	// The name of the geofence collection to be deleted.
	//
	// CollectionName is a required field
	CollectionName *string `location:"uri" locationName:"CollectionName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteGeofenceCollectionInput) GoString 

func (s DeleteGeofenceCollectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGeofenceCollectionInput) SetCollectionName 

func (s *DeleteGeofenceCollectionInput) SetCollectionName(v string) *DeleteGeofenceCollectionInput

SetCollectionName sets the CollectionName field's value.

func (DeleteGeofenceCollectionInput) String 

func (s DeleteGeofenceCollectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGeofenceCollectionInput) Validate 

func (s *DeleteGeofenceCollectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteGeofenceCollectionOutput 

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

func (DeleteGeofenceCollectionOutput) GoString 

func (s DeleteGeofenceCollectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteGeofenceCollectionOutput) String 

func (s DeleteGeofenceCollectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteKeyInput added in v1.44.208 

type DeleteKeyInput struct {

	// 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 `location:"querystring" locationName:"forceDelete" type:"boolean"`

	// The name of the API key to delete.
	//
	// KeyName is a required field
	KeyName *string `location:"uri" locationName:"KeyName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteKeyInput) GoString added in v1.44.208 

func (s DeleteKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteKeyInput) SetForceDelete added in v1.49.13 

func (s *DeleteKeyInput) SetForceDelete(v bool) *DeleteKeyInput

SetForceDelete sets the ForceDelete field's value.

func (*DeleteKeyInput) SetKeyName added in v1.44.208 

func (s *DeleteKeyInput) SetKeyName(v string) *DeleteKeyInput

SetKeyName sets the KeyName field's value.

func (DeleteKeyInput) String added in v1.44.208 

func (s DeleteKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteKeyInput) Validate added in v1.44.208 

func (s *DeleteKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteKeyOutput added in v1.44.208 

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

func (DeleteKeyOutput) GoString added in v1.44.208 

func (s DeleteKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteKeyOutput) String added in v1.44.208 

func (s DeleteKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteMapInput 

type DeleteMapInput struct {

	// The name of the map resource to be deleted.
	//
	// MapName is a required field
	MapName *string `location:"uri" locationName:"MapName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMapInput) GoString 

func (s DeleteMapInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMapInput) SetMapName 

func (s *DeleteMapInput) SetMapName(v string) *DeleteMapInput

SetMapName sets the MapName field's value.

func (DeleteMapInput) String 

func (s DeleteMapInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMapInput) Validate 

func (s *DeleteMapInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteMapOutput 

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

func (DeleteMapOutput) GoString 

func (s DeleteMapOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteMapOutput) String 

func (s DeleteMapOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeletePlaceIndexInput 

type DeletePlaceIndexInput struct {

	// The name of the place index resource to be deleted.
	//
	// IndexName is a required field
	IndexName *string `location:"uri" locationName:"IndexName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePlaceIndexInput) GoString 

func (s DeletePlaceIndexInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePlaceIndexInput) SetIndexName 

func (s *DeletePlaceIndexInput) SetIndexName(v string) *DeletePlaceIndexInput

SetIndexName sets the IndexName field's value.

func (DeletePlaceIndexInput) String 

func (s DeletePlaceIndexInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePlaceIndexInput) Validate 

func (s *DeletePlaceIndexInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeletePlaceIndexOutput 

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

func (DeletePlaceIndexOutput) GoString 

func (s DeletePlaceIndexOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeletePlaceIndexOutput) String 

func (s DeletePlaceIndexOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteRouteCalculatorInput added in v1.38.51 

type DeleteRouteCalculatorInput struct {

	// The name of the route calculator resource to be deleted.
	//
	// CalculatorName is a required field
	CalculatorName *string `location:"uri" locationName:"CalculatorName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteRouteCalculatorInput) GoString added in v1.38.51 

func (s DeleteRouteCalculatorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRouteCalculatorInput) SetCalculatorName added in v1.38.51 

func (s *DeleteRouteCalculatorInput) SetCalculatorName(v string) *DeleteRouteCalculatorInput

SetCalculatorName sets the CalculatorName field's value.

func (DeleteRouteCalculatorInput) String added in v1.38.51 

func (s DeleteRouteCalculatorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRouteCalculatorInput) Validate added in v1.38.51 

func (s *DeleteRouteCalculatorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteRouteCalculatorOutput added in v1.38.51 

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

func (DeleteRouteCalculatorOutput) GoString added in v1.38.51 

func (s DeleteRouteCalculatorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteRouteCalculatorOutput) String added in v1.38.51 

func (s DeleteRouteCalculatorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteTrackerInput 

type DeleteTrackerInput struct {

	// The name of the tracker resource to be deleted.
	//
	// TrackerName is a required field
	TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteTrackerInput) GoString 

func (s DeleteTrackerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTrackerInput) SetTrackerName 

func (s *DeleteTrackerInput) SetTrackerName(v string) *DeleteTrackerInput

SetTrackerName sets the TrackerName field's value.

func (DeleteTrackerInput) String 

func (s DeleteTrackerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTrackerInput) Validate 

func (s *DeleteTrackerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteTrackerOutput 

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

func (DeleteTrackerOutput) GoString 

func (s DeleteTrackerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteTrackerOutput) String 

func (s DeleteTrackerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeGeofenceCollectionInput 

type DescribeGeofenceCollectionInput struct {

	// The name of the geofence collection.
	//
	// CollectionName is a required field
	CollectionName *string `location:"uri" locationName:"CollectionName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeGeofenceCollectionInput) GoString 

func (s DescribeGeofenceCollectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGeofenceCollectionInput) SetCollectionName 

func (s *DescribeGeofenceCollectionInput) SetCollectionName(v string) *DescribeGeofenceCollectionInput

SetCollectionName sets the CollectionName field's value.

func (DescribeGeofenceCollectionInput) String 

func (s DescribeGeofenceCollectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGeofenceCollectionInput) Validate 

func (s *DescribeGeofenceCollectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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
	//
	// CollectionArn is a required field
	CollectionArn *string `type:"string" required:"true"`

	// The name of the geofence collection.
	//
	// CollectionName is a required field
	CollectionName *string `min:"1" type:"string" required:"true"`

	// 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
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The optional description for the geofence collection.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// The number of geofences in the geofence collection.
	GeofenceCount *int64 `type:"integer"`

	// A key identifier for an Amazon Web Services KMS customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html)
	// assigned to the Amazon Location resource
	KmsKeyId *string `min:"1" type:"string"`

	// No longer used. Always returns RequestBasedUsage.
	//
	// Deprecated: Deprecated. Always returns RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"`

	// No longer used. Always returns an empty string.
	//
	// Deprecated: Deprecated. Unused.
	PricingPlanDataSource *string `deprecated:"true" type:"string"`

	// Displays the key, value pairs of tags associated with this resource.
	Tags map[string]*string `type:"map"`

	// 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
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeGeofenceCollectionOutput) GoString 

func (s DescribeGeofenceCollectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGeofenceCollectionOutput) SetCollectionArn 

func (s *DescribeGeofenceCollectionOutput) SetCollectionArn(v string) *DescribeGeofenceCollectionOutput

SetCollectionArn sets the CollectionArn field's value.

func (*DescribeGeofenceCollectionOutput) SetCollectionName 

func (s *DescribeGeofenceCollectionOutput) SetCollectionName(v string) *DescribeGeofenceCollectionOutput

SetCollectionName sets the CollectionName field's value.

func (*DescribeGeofenceCollectionOutput) SetCreateTime 

func (s *DescribeGeofenceCollectionOutput) SetCreateTime(v time.Time) *DescribeGeofenceCollectionOutput

SetCreateTime sets the CreateTime field's value.

func (*DescribeGeofenceCollectionOutput) SetDescription 

func (s *DescribeGeofenceCollectionOutput) SetDescription(v string) *DescribeGeofenceCollectionOutput

SetDescription sets the Description field's value.

func (*DescribeGeofenceCollectionOutput) SetGeofenceCount added in v1.45.21 

func (s *DescribeGeofenceCollectionOutput) SetGeofenceCount(v int64) *DescribeGeofenceCollectionOutput

SetGeofenceCount sets the GeofenceCount field's value.

func (*DescribeGeofenceCollectionOutput) SetKmsKeyId added in v1.38.51 

func (s *DescribeGeofenceCollectionOutput) SetKmsKeyId(v string) *DescribeGeofenceCollectionOutput

SetKmsKeyId sets the KmsKeyId field's value.

func (*DescribeGeofenceCollectionOutput) SetPricingPlan added in v1.38.8 

func (s *DescribeGeofenceCollectionOutput) SetPricingPlan(v string) *DescribeGeofenceCollectionOutput

SetPricingPlan sets the PricingPlan field's value.

func (*DescribeGeofenceCollectionOutput) SetPricingPlanDataSource added in v1.38.8 

func (s *DescribeGeofenceCollectionOutput) SetPricingPlanDataSource(v string) *DescribeGeofenceCollectionOutput

SetPricingPlanDataSource sets the PricingPlanDataSource field's value.

func (*DescribeGeofenceCollectionOutput) SetTags added in v1.38.51 

func (s *DescribeGeofenceCollectionOutput) SetTags(v map[string]*string) *DescribeGeofenceCollectionOutput

SetTags sets the Tags field's value.

func (*DescribeGeofenceCollectionOutput) SetUpdateTime 

func (s *DescribeGeofenceCollectionOutput) SetUpdateTime(v time.Time) *DescribeGeofenceCollectionOutput

SetUpdateTime sets the UpdateTime field's value.

func (DescribeGeofenceCollectionOutput) String 

func (s DescribeGeofenceCollectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeKeyInput added in v1.44.208 

type DescribeKeyInput struct {

	// The name of the API key resource.
	//
	// KeyName is a required field
	KeyName *string `location:"uri" locationName:"KeyName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeKeyInput) GoString added in v1.44.208 

func (s DescribeKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeKeyInput) SetKeyName added in v1.44.208 

func (s *DescribeKeyInput) SetKeyName(v string) *DescribeKeyInput

SetKeyName sets the KeyName field's value.

func (DescribeKeyInput) String added in v1.44.208 

func (s DescribeKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeKeyInput) Validate added in v1.44.208 

func (s *DescribeKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeKeyOutput added in v1.44.208 

type DescribeKeyOutput struct {

	// The timestamp for when the API key resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html)
	// format: YYYY-MM-DDThh:mm:ss.sssZ.
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The optional description for the API key resource.
	Description *string `type:"string"`

	// The timestamp for when the API key resource will expire in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html)
	// format: YYYY-MM-DDThh:mm:ss.sssZ.
	//
	// ExpireTime is a required field
	ExpireTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The key value/string of an API key.
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeKeyOutput's
	// String and GoString methods.
	//
	// Key is a required field
	Key *string `type:"string" required:"true" sensitive:"true"`

	// 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
	//
	// KeyArn is a required field
	KeyArn *string `type:"string" required:"true"`

	// The name of the API key resource.
	//
	// KeyName is a required field
	KeyName *string `min:"1" type:"string" required:"true"`

	// API Restrictions on the allowed actions, resources, and referers for an API
	// key resource.
	//
	// Restrictions is a required field
	Restrictions *ApiKeyRestrictions `type:"structure" required:"true"`

	// Tags associated with the API key resource.
	Tags map[string]*string `type:"map"`

	// The timestamp for when the API key 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.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeKeyOutput) GoString added in v1.44.208 

func (s DescribeKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeKeyOutput) SetCreateTime added in v1.44.208 

func (s *DescribeKeyOutput) SetCreateTime(v time.Time) *DescribeKeyOutput

SetCreateTime sets the CreateTime field's value.

func (*DescribeKeyOutput) SetDescription added in v1.44.208 

func (s *DescribeKeyOutput) SetDescription(v string) *DescribeKeyOutput

SetDescription sets the Description field's value.

func (*DescribeKeyOutput) SetExpireTime added in v1.44.208 

func (s *DescribeKeyOutput) SetExpireTime(v time.Time) *DescribeKeyOutput

SetExpireTime sets the ExpireTime field's value.

func (*DescribeKeyOutput) SetKey added in v1.44.208 

func (s *DescribeKeyOutput) SetKey(v string) *DescribeKeyOutput

SetKey sets the Key field's value.

func (*DescribeKeyOutput) SetKeyArn added in v1.44.208 

func (s *DescribeKeyOutput) SetKeyArn(v string) *DescribeKeyOutput

SetKeyArn sets the KeyArn field's value.

func (*DescribeKeyOutput) SetKeyName added in v1.44.208 

func (s *DescribeKeyOutput) SetKeyName(v string) *DescribeKeyOutput

SetKeyName sets the KeyName field's value.

func (*DescribeKeyOutput) SetRestrictions added in v1.44.208 

func (s *DescribeKeyOutput) SetRestrictions(v *ApiKeyRestrictions) *DescribeKeyOutput

SetRestrictions sets the Restrictions field's value.

func (*DescribeKeyOutput) SetTags added in v1.44.208 

func (s *DescribeKeyOutput) SetTags(v map[string]*string) *DescribeKeyOutput

SetTags sets the Tags field's value.

func (*DescribeKeyOutput) SetUpdateTime added in v1.44.208 

func (s *DescribeKeyOutput) SetUpdateTime(v time.Time) *DescribeKeyOutput

SetUpdateTime sets the UpdateTime field's value.

func (DescribeKeyOutput) String added in v1.44.208 

func (s DescribeKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeMapInput 

type DescribeMapInput struct {

	// The name of the map resource.
	//
	// MapName is a required field
	MapName *string `location:"uri" locationName:"MapName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMapInput) GoString 

func (s DescribeMapInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMapInput) SetMapName 

func (s *DescribeMapInput) SetMapName(v string) *DescribeMapInput

SetMapName sets the MapName field's value.

func (DescribeMapInput) String 

func (s DescribeMapInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMapInput) Validate 

func (s *DescribeMapInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeMapOutput 

type DescribeMapOutput struct {

	// Specifies the map tile style selected from a partner data provider.
	//
	// Configuration is a required field
	Configuration *MapConfiguration `type:"structure" required:"true"`

	// 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.
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// Specifies the data provider for the associated map tiles.
	//
	// DataSource is a required field
	DataSource *string `type:"string" required:"true"`

	// The optional description for the map resource.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// 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
	//
	// MapArn is a required field
	MapArn *string `type:"string" required:"true"`

	// The map style selected from an available provider.
	//
	// MapName is a required field
	MapName *string `min:"1" type:"string" required:"true"`

	// No longer used. Always returns RequestBasedUsage.
	//
	// Deprecated: Deprecated. Always returns RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"`

	// Tags associated with the map resource.
	Tags map[string]*string `type:"map"`

	// 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.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMapOutput) GoString 

func (s DescribeMapOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMapOutput) SetConfiguration 

func (s *DescribeMapOutput) SetConfiguration(v *MapConfiguration) *DescribeMapOutput

SetConfiguration sets the Configuration field's value.

func (*DescribeMapOutput) SetCreateTime 

func (s *DescribeMapOutput) SetCreateTime(v time.Time) *DescribeMapOutput

SetCreateTime sets the CreateTime field's value.

func (*DescribeMapOutput) SetDataSource 

func (s *DescribeMapOutput) SetDataSource(v string) *DescribeMapOutput

SetDataSource sets the DataSource field's value.

func (*DescribeMapOutput) SetDescription 

func (s *DescribeMapOutput) SetDescription(v string) *DescribeMapOutput

SetDescription sets the Description field's value.

func (*DescribeMapOutput) SetMapArn 

func (s *DescribeMapOutput) SetMapArn(v string) *DescribeMapOutput

SetMapArn sets the MapArn field's value.

func (*DescribeMapOutput) SetMapName 

func (s *DescribeMapOutput) SetMapName(v string) *DescribeMapOutput

SetMapName sets the MapName field's value.

func (*DescribeMapOutput) SetPricingPlan added in v1.38.8 

func (s *DescribeMapOutput) SetPricingPlan(v string) *DescribeMapOutput

SetPricingPlan sets the PricingPlan field's value.

func (*DescribeMapOutput) SetTags added in v1.38.51 

func (s *DescribeMapOutput) SetTags(v map[string]*string) *DescribeMapOutput

SetTags sets the Tags field's value.

func (*DescribeMapOutput) SetUpdateTime 

func (s *DescribeMapOutput) SetUpdateTime(v time.Time) *DescribeMapOutput

SetUpdateTime sets the UpdateTime field's value.

func (DescribeMapOutput) String 

func (s DescribeMapOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribePlaceIndexInput 

type DescribePlaceIndexInput struct {

	// The name of the place index resource.
	//
	// IndexName is a required field
	IndexName *string `location:"uri" locationName:"IndexName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribePlaceIndexInput) GoString 

func (s DescribePlaceIndexInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePlaceIndexInput) SetIndexName 

func (s *DescribePlaceIndexInput) SetIndexName(v string) *DescribePlaceIndexInput

SetIndexName sets the IndexName field's value.

func (DescribePlaceIndexInput) String 

func (s DescribePlaceIndexInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePlaceIndexInput) Validate 

func (s *DescribePlaceIndexInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// 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 (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html).
	//
	// DataSource is a required field
	DataSource *string `type:"string" required:"true"`

	// The specified data storage option for requesting Places.
	//
	// DataSourceConfiguration is a required field
	DataSourceConfiguration *DataSourceConfiguration `type:"structure" required:"true"`

	// The optional description for the place index resource.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// 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
	//
	// IndexArn is a required field
	IndexArn *string `type:"string" required:"true"`

	// The name of the place index resource being described.
	//
	// IndexName is a required field
	IndexName *string `min:"1" type:"string" required:"true"`

	// No longer used. Always returns RequestBasedUsage.
	//
	// Deprecated: Deprecated. Always returns RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"`

	// Tags associated with place index resource.
	Tags map[string]*string `type:"map"`

	// 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.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (DescribePlaceIndexOutput) GoString 

func (s DescribePlaceIndexOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePlaceIndexOutput) SetCreateTime 

func (s *DescribePlaceIndexOutput) SetCreateTime(v time.Time) *DescribePlaceIndexOutput

SetCreateTime sets the CreateTime field's value.

func (*DescribePlaceIndexOutput) SetDataSource 

func (s *DescribePlaceIndexOutput) SetDataSource(v string) *DescribePlaceIndexOutput

SetDataSource sets the DataSource field's value.

func (*DescribePlaceIndexOutput) SetDataSourceConfiguration 

func (s *DescribePlaceIndexOutput) SetDataSourceConfiguration(v *DataSourceConfiguration) *DescribePlaceIndexOutput

SetDataSourceConfiguration sets the DataSourceConfiguration field's value.

func (*DescribePlaceIndexOutput) SetDescription 

func (s *DescribePlaceIndexOutput) SetDescription(v string) *DescribePlaceIndexOutput

SetDescription sets the Description field's value.

func (*DescribePlaceIndexOutput) SetIndexArn 

func (s *DescribePlaceIndexOutput) SetIndexArn(v string) *DescribePlaceIndexOutput

SetIndexArn sets the IndexArn field's value.

func (*DescribePlaceIndexOutput) SetIndexName 

func (s *DescribePlaceIndexOutput) SetIndexName(v string) *DescribePlaceIndexOutput

SetIndexName sets the IndexName field's value.

func (*DescribePlaceIndexOutput) SetPricingPlan added in v1.38.8 

func (s *DescribePlaceIndexOutput) SetPricingPlan(v string) *DescribePlaceIndexOutput

SetPricingPlan sets the PricingPlan field's value.

func (*DescribePlaceIndexOutput) SetTags added in v1.38.51 

func (s *DescribePlaceIndexOutput) SetTags(v map[string]*string) *DescribePlaceIndexOutput

SetTags sets the Tags field's value.

func (*DescribePlaceIndexOutput) SetUpdateTime 

func (s *DescribePlaceIndexOutput) SetUpdateTime(v time.Time) *DescribePlaceIndexOutput

SetUpdateTime sets the UpdateTime field's value.

func (DescribePlaceIndexOutput) String 

func (s DescribePlaceIndexOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeRouteCalculatorInput added in v1.38.51 

type DescribeRouteCalculatorInput struct {

	// The name of the route calculator resource.
	//
	// CalculatorName is a required field
	CalculatorName *string `location:"uri" locationName:"CalculatorName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeRouteCalculatorInput) GoString added in v1.38.51 

func (s DescribeRouteCalculatorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRouteCalculatorInput) SetCalculatorName added in v1.38.51 

func (s *DescribeRouteCalculatorInput) SetCalculatorName(v string) *DescribeRouteCalculatorInput

SetCalculatorName sets the CalculatorName field's value.

func (DescribeRouteCalculatorInput) String added in v1.38.51 

func (s DescribeRouteCalculatorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRouteCalculatorInput) Validate added in v1.38.51 

func (s *DescribeRouteCalculatorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeRouteCalculatorOutput added in v1.38.51 

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
	//
	// CalculatorArn is a required field
	CalculatorArn *string `type:"string" required:"true"`

	// The name of the route calculator resource being described.
	//
	// CalculatorName is a required field
	CalculatorName *string `min:"1" type:"string" required:"true"`

	// The timestamp when the route calculator resource was created in ISO 8601
	// (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ.
	//
	//    * For example, 2020–07-2T12:15:20.000Z+01:00
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// 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 (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html).
	//
	// DataSource is a required field
	DataSource *string `type:"string" required:"true"`

	// The optional description of the route calculator resource.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// Always returns RequestBasedUsage.
	//
	// Deprecated: Deprecated. Always returns RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"`

	// Tags associated with route calculator resource.
	Tags map[string]*string `type:"map"`

	// The timestamp when the route calculator 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.
	//
	//    * For example, 2020–07-2T12:15:20.000Z+01:00
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeRouteCalculatorOutput) GoString added in v1.38.51 

func (s DescribeRouteCalculatorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRouteCalculatorOutput) SetCalculatorArn added in v1.38.51 

func (s *DescribeRouteCalculatorOutput) SetCalculatorArn(v string) *DescribeRouteCalculatorOutput

SetCalculatorArn sets the CalculatorArn field's value.

func (*DescribeRouteCalculatorOutput) SetCalculatorName added in v1.38.51 

func (s *DescribeRouteCalculatorOutput) SetCalculatorName(v string) *DescribeRouteCalculatorOutput

SetCalculatorName sets the CalculatorName field's value.

func (*DescribeRouteCalculatorOutput) SetCreateTime added in v1.38.51 

func (s *DescribeRouteCalculatorOutput) SetCreateTime(v time.Time) *DescribeRouteCalculatorOutput

SetCreateTime sets the CreateTime field's value.

func (*DescribeRouteCalculatorOutput) SetDataSource added in v1.38.51 

func (s *DescribeRouteCalculatorOutput) SetDataSource(v string) *DescribeRouteCalculatorOutput

SetDataSource sets the DataSource field's value.

func (*DescribeRouteCalculatorOutput) SetDescription added in v1.38.51 

func (s *DescribeRouteCalculatorOutput) SetDescription(v string) *DescribeRouteCalculatorOutput

SetDescription sets the Description field's value.

func (*DescribeRouteCalculatorOutput) SetPricingPlan added in v1.38.51 

func (s *DescribeRouteCalculatorOutput) SetPricingPlan(v string) *DescribeRouteCalculatorOutput

SetPricingPlan sets the PricingPlan field's value.

func (*DescribeRouteCalculatorOutput) SetTags added in v1.38.51 

func (s *DescribeRouteCalculatorOutput) SetTags(v map[string]*string) *DescribeRouteCalculatorOutput

SetTags sets the Tags field's value.

func (*DescribeRouteCalculatorOutput) SetUpdateTime added in v1.38.51 

func (s *DescribeRouteCalculatorOutput) SetUpdateTime(v time.Time) *DescribeRouteCalculatorOutput

SetUpdateTime sets the UpdateTime field's value.

func (DescribeRouteCalculatorOutput) String added in v1.38.51 

func (s DescribeRouteCalculatorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTrackerInput 

type DescribeTrackerInput struct {

	// The name of the tracker resource.
	//
	// TrackerName is a required field
	TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTrackerInput) GoString 

func (s DescribeTrackerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrackerInput) SetTrackerName 

func (s *DescribeTrackerInput) SetTrackerName(v string) *DescribeTrackerInput

SetTrackerName sets the TrackerName field's value.

func (DescribeTrackerInput) String 

func (s DescribeTrackerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrackerInput) Validate 

func (s *DescribeTrackerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The optional description for the tracker resource.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

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

	// Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS
	// customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html).
	//
	// 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.
	KmsKeyEnableGeospatialQueries *bool `type:"boolean"`

	// A key identifier for an Amazon Web Services KMS customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html)
	// assigned to the Amazon Location resource.
	KmsKeyId *string `min:"1" type:"string"`

	// The position filtering method of the tracker resource.
	PositionFiltering *string `type:"string" enum:"PositionFiltering"`

	// Always returns RequestBasedUsage.
	//
	// Deprecated: Deprecated. Always returns RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"`

	// No longer used. Always returns an empty string.
	//
	// Deprecated: Deprecated. Unused.
	PricingPlanDataSource *string `deprecated:"true" type:"string"`

	// The tags associated with the tracker resource.
	Tags map[string]*string `type:"map"`

	// 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
	//
	// TrackerArn is a required field
	TrackerArn *string `type:"string" required:"true"`

	// The name of the tracker resource.
	//
	// TrackerName is a required field
	TrackerName *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTrackerOutput) GoString 

func (s DescribeTrackerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrackerOutput) SetCreateTime 

func (s *DescribeTrackerOutput) SetCreateTime(v time.Time) *DescribeTrackerOutput

SetCreateTime sets the CreateTime field's value.

func (*DescribeTrackerOutput) SetDescription 

func (s *DescribeTrackerOutput) SetDescription(v string) *DescribeTrackerOutput

SetDescription sets the Description field's value.

func (*DescribeTrackerOutput) SetEventBridgeEnabled added in v1.44.297 

func (s *DescribeTrackerOutput) SetEventBridgeEnabled(v bool) *DescribeTrackerOutput

SetEventBridgeEnabled sets the EventBridgeEnabled field's value.

func (*DescribeTrackerOutput) SetKmsKeyEnableGeospatialQueries added in v1.45.21 

func (s *DescribeTrackerOutput) SetKmsKeyEnableGeospatialQueries(v bool) *DescribeTrackerOutput

SetKmsKeyEnableGeospatialQueries sets the KmsKeyEnableGeospatialQueries field's value.

func (*DescribeTrackerOutput) SetKmsKeyId added in v1.38.51 

func (s *DescribeTrackerOutput) SetKmsKeyId(v string) *DescribeTrackerOutput

SetKmsKeyId sets the KmsKeyId field's value.

func (*DescribeTrackerOutput) SetPositionFiltering added in v1.40.56 

func (s *DescribeTrackerOutput) SetPositionFiltering(v string) *DescribeTrackerOutput

SetPositionFiltering sets the PositionFiltering field's value.

func (*DescribeTrackerOutput) SetPricingPlan added in v1.38.8 

func (s *DescribeTrackerOutput) SetPricingPlan(v string) *DescribeTrackerOutput

SetPricingPlan sets the PricingPlan field's value.

func (*DescribeTrackerOutput) SetPricingPlanDataSource added in v1.38.8 

func (s *DescribeTrackerOutput) SetPricingPlanDataSource(v string) *DescribeTrackerOutput

SetPricingPlanDataSource sets the PricingPlanDataSource field's value.

func (*DescribeTrackerOutput) SetTags added in v1.38.51 

func (s *DescribeTrackerOutput) SetTags(v map[string]*string) *DescribeTrackerOutput

SetTags sets the Tags field's value.

func (*DescribeTrackerOutput) SetTrackerArn 

func (s *DescribeTrackerOutput) SetTrackerArn(v string) *DescribeTrackerOutput

SetTrackerArn sets the TrackerArn field's value.

func (*DescribeTrackerOutput) SetTrackerName 

func (s *DescribeTrackerOutput) SetTrackerName(v string) *DescribeTrackerOutput

SetTrackerName sets the TrackerName field's value.

func (*DescribeTrackerOutput) SetUpdateTime 

func (s *DescribeTrackerOutput) SetUpdateTime(v time.Time) *DescribeTrackerOutput

SetUpdateTime sets the UpdateTime field's value.

func (DescribeTrackerOutput) String 

func (s DescribeTrackerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DevicePosition 

type DevicePosition struct {

	// The accuracy of the device position.
	Accuracy *PositionalAccuracy `type:"structure"`

	// The device whose position you retrieved.
	DeviceId *string `min:"1" type:"string"`

	// The last known device position.
	//
	// Position is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DevicePosition's
	// String and GoString methods.
	//
	// Position is a required field
	Position []*float64 `min:"2" type:"list" required:"true" sensitive:"true"`

	// The properties associated with the position.
	//
	// PositionProperties is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DevicePosition's
	// String and GoString methods.
	PositionProperties map[string]*string `type:"map" sensitive:"true"`

	// 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.
	//
	// ReceivedTime is a required field
	ReceivedTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// 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.
	//
	// SampleTime is a required field
	SampleTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains the device position details.

func (DevicePosition) GoString 

func (s DevicePosition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DevicePosition) SetAccuracy added in v1.42.20 

func (s *DevicePosition) SetAccuracy(v *PositionalAccuracy) *DevicePosition

SetAccuracy sets the Accuracy field's value.

func (*DevicePosition) SetDeviceId 

func (s *DevicePosition) SetDeviceId(v string) *DevicePosition

SetDeviceId sets the DeviceId field's value.

func (*DevicePosition) SetPosition 

func (s *DevicePosition) SetPosition(v []*float64) *DevicePosition

SetPosition sets the Position field's value.

func (*DevicePosition) SetPositionProperties added in v1.42.20 

func (s *DevicePosition) SetPositionProperties(v map[string]*string) *DevicePosition

SetPositionProperties sets the PositionProperties field's value.

func (*DevicePosition) SetReceivedTime 

func (s *DevicePosition) SetReceivedTime(v time.Time) *DevicePosition

SetReceivedTime sets the ReceivedTime field's value.

func (*DevicePosition) SetSampleTime 

func (s *DevicePosition) SetSampleTime(v time.Time) *DevicePosition

SetSampleTime sets the SampleTime field's value.

func (DevicePosition) String 

func (s DevicePosition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DevicePositionUpdate 

type DevicePositionUpdate struct {

	// The accuracy of the device position.
	Accuracy *PositionalAccuracy `type:"structure"`

	// The device associated to the position update.
	//
	// DeviceId is a required field
	DeviceId *string `min:"1" type:"string" required:"true"`

	// The latest device position defined in WGS 84 (https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84)
	// format: [X or longitude, Y or latitude].
	//
	// Position is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DevicePositionUpdate's
	// String and GoString methods.
	//
	// Position is a required field
	Position []*float64 `min:"2" type:"list" required:"true" sensitive:"true"`

	// Associates one of more properties with the position update. A property is
	// a key-value pair stored with the position update and added to any geofence
	// event the update may trigger.
	//
	// Format: "key" : "value"
	//
	// PositionProperties is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DevicePositionUpdate's
	// String and GoString methods.
	PositionProperties map[string]*string `type:"map" sensitive:"true"`

	// 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
	//
	// SampleTime is a required field
	SampleTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains the position update details for a device.

func (DevicePositionUpdate) GoString 

func (s DevicePositionUpdate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DevicePositionUpdate) SetAccuracy added in v1.42.20 

func (s *DevicePositionUpdate) SetAccuracy(v *PositionalAccuracy) *DevicePositionUpdate

SetAccuracy sets the Accuracy field's value.

func (*DevicePositionUpdate) SetDeviceId 

func (s *DevicePositionUpdate) SetDeviceId(v string) *DevicePositionUpdate

SetDeviceId sets the DeviceId field's value.

func (*DevicePositionUpdate) SetPosition 

func (s *DevicePositionUpdate) SetPosition(v []*float64) *DevicePositionUpdate

SetPosition sets the Position field's value.

func (*DevicePositionUpdate) SetPositionProperties added in v1.42.20 

func (s *DevicePositionUpdate) SetPositionProperties(v map[string]*string) *DevicePositionUpdate

SetPositionProperties sets the PositionProperties field's value.

func (*DevicePositionUpdate) SetSampleTime 

func (s *DevicePositionUpdate) SetSampleTime(v time.Time) *DevicePositionUpdate

SetSampleTime sets the SampleTime field's value.

func (DevicePositionUpdate) String 

func (s DevicePositionUpdate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DevicePositionUpdate) Validate 

func (s *DevicePositionUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeviceState added in v1.53.18 

type DeviceState struct {

	// Defines the level of certainty of the position.
	Accuracy *PositionalAccuracy `type:"structure"`

	// The cellular network infrastructure that the device is connected to.
	CellSignals *CellSignals `type:"structure"`

	// The device identifier.
	//
	// DeviceId is a required field
	DeviceId *string `min:"1" type:"string" required:"true"`

	// The device's Ipv4 address.
	Ipv4Address *string `type:"string"`

	// The last known device position.
	//
	// Position is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DeviceState's
	// String and GoString methods.
	//
	// Position is a required field
	Position []*float64 `min:"2" type:"list" required:"true" sensitive:"true"`

	// 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.
	//
	// SampleTime is a required field
	SampleTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The Wi-Fi access points the device is using.
	WiFiAccessPoints []*WiFiAccessPoint `type:"list"`
	// contains filtered or unexported fields
}

The device's position, IP address, and Wi-Fi access points.

func (DeviceState) GoString added in v1.53.18 

func (s DeviceState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeviceState) SetAccuracy added in v1.53.18 

func (s *DeviceState) SetAccuracy(v *PositionalAccuracy) *DeviceState

SetAccuracy sets the Accuracy field's value.

func (*DeviceState) SetCellSignals added in v1.53.18 

func (s *DeviceState) SetCellSignals(v *CellSignals) *DeviceState

SetCellSignals sets the CellSignals field's value.

func (*DeviceState) SetDeviceId added in v1.53.18 

func (s *DeviceState) SetDeviceId(v string) *DeviceState

SetDeviceId sets the DeviceId field's value.

func (*DeviceState) SetIpv4Address added in v1.53.18 

func (s *DeviceState) SetIpv4Address(v string) *DeviceState

SetIpv4Address sets the Ipv4Address field's value.

func (*DeviceState) SetPosition added in v1.53.18 

func (s *DeviceState) SetPosition(v []*float64) *DeviceState

SetPosition sets the Position field's value.

func (*DeviceState) SetSampleTime added in v1.53.18 

func (s *DeviceState) SetSampleTime(v time.Time) *DeviceState

SetSampleTime sets the SampleTime field's value.

func (*DeviceState) SetWiFiAccessPoints added in v1.53.18 

func (s *DeviceState) SetWiFiAccessPoints(v []*WiFiAccessPoint) *DeviceState

SetWiFiAccessPoints sets the WiFiAccessPoints field's value.

func (DeviceState) String added in v1.53.18 

func (s DeviceState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeviceState) Validate added in v1.53.18 

func (s *DeviceState) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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
	//
	// ConsumerArn is a required field
	ConsumerArn *string `location:"uri" locationName:"ConsumerArn" type:"string" required:"true"`

	// The name of the tracker resource to be dissociated from the consumer.
	//
	// TrackerName is a required field
	TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateTrackerConsumerInput) GoString 

func (s DisassociateTrackerConsumerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateTrackerConsumerInput) SetConsumerArn 

func (s *DisassociateTrackerConsumerInput) SetConsumerArn(v string) *DisassociateTrackerConsumerInput

SetConsumerArn sets the ConsumerArn field's value.

func (*DisassociateTrackerConsumerInput) SetTrackerName 

func (s *DisassociateTrackerConsumerInput) SetTrackerName(v string) *DisassociateTrackerConsumerInput

SetTrackerName sets the TrackerName field's value.

func (DisassociateTrackerConsumerInput) String 

func (s DisassociateTrackerConsumerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateTrackerConsumerInput) Validate 

func (s *DisassociateTrackerConsumerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateTrackerConsumerOutput 

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

func (DisassociateTrackerConsumerOutput) GoString 

func (s DisassociateTrackerConsumerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateTrackerConsumerOutput) String 

func (s DisassociateTrackerConsumerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ForecastGeofenceEventsDeviceState added in v1.53.18 

type ForecastGeofenceEventsDeviceState struct {

	// The device's position.
	//
	// Position is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ForecastGeofenceEventsDeviceState's
	// String and GoString methods.
	//
	// Position is a required field
	Position []*float64 `min:"2" type:"list" required:"true" sensitive:"true"`

	// The device's speed.
	Speed *float64 `type:"double"`
	// contains filtered or unexported fields
}

The device's position, IP address, and WiFi access points.

func (ForecastGeofenceEventsDeviceState) GoString added in v1.53.18 

func (s ForecastGeofenceEventsDeviceState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ForecastGeofenceEventsDeviceState) SetPosition added in v1.53.18 

func (s *ForecastGeofenceEventsDeviceState) SetPosition(v []*float64) *ForecastGeofenceEventsDeviceState

SetPosition sets the Position field's value.

func (*ForecastGeofenceEventsDeviceState) SetSpeed added in v1.53.18 

func (s *ForecastGeofenceEventsDeviceState) SetSpeed(v float64) *ForecastGeofenceEventsDeviceState

SetSpeed sets the Speed field's value.

func (ForecastGeofenceEventsDeviceState) String added in v1.53.18 

func (s ForecastGeofenceEventsDeviceState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ForecastGeofenceEventsDeviceState) Validate added in v1.53.18 

func (s *ForecastGeofenceEventsDeviceState) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ForecastGeofenceEventsInput added in v1.53.18 

type ForecastGeofenceEventsInput struct {

	// The name of the geofence collection.
	//
	// CollectionName is a required field
	CollectionName *string `location:"uri" locationName:"CollectionName" min:"1" type:"string" required:"true"`

	// The device's state, including current position and speed.
	//
	// DeviceState is a required field
	DeviceState *ForecastGeofenceEventsDeviceState `type:"structure" required:"true"`

	// 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 *string `type:"string" enum:"DistanceUnit"`

	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 20
	MaxResults *int64 `min:"1" type:"integer"`

	// 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 `min:"1" type:"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 *string `type:"string" enum:"SpeedUnit"`

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

func (ForecastGeofenceEventsInput) GoString added in v1.53.18 

func (s ForecastGeofenceEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ForecastGeofenceEventsInput) SetCollectionName added in v1.53.18 

func (s *ForecastGeofenceEventsInput) SetCollectionName(v string) *ForecastGeofenceEventsInput

SetCollectionName sets the CollectionName field's value.

func (*ForecastGeofenceEventsInput) SetDeviceState added in v1.53.18 

func (s *ForecastGeofenceEventsInput) SetDeviceState(v *ForecastGeofenceEventsDeviceState) *ForecastGeofenceEventsInput

SetDeviceState sets the DeviceState field's value.

func (*ForecastGeofenceEventsInput) SetDistanceUnit added in v1.53.18 

func (s *ForecastGeofenceEventsInput) SetDistanceUnit(v string) *ForecastGeofenceEventsInput

SetDistanceUnit sets the DistanceUnit field's value.

func (*ForecastGeofenceEventsInput) SetMaxResults added in v1.53.18 

func (s *ForecastGeofenceEventsInput) SetMaxResults(v int64) *ForecastGeofenceEventsInput

SetMaxResults sets the MaxResults field's value.

func (*ForecastGeofenceEventsInput) SetNextToken added in v1.53.18 

func (s *ForecastGeofenceEventsInput) SetNextToken(v string) *ForecastGeofenceEventsInput

SetNextToken sets the NextToken field's value.

func (*ForecastGeofenceEventsInput) SetSpeedUnit added in v1.53.18 

func (s *ForecastGeofenceEventsInput) SetSpeedUnit(v string) *ForecastGeofenceEventsInput

SetSpeedUnit sets the SpeedUnit field's value.

func (*ForecastGeofenceEventsInput) SetTimeHorizonMinutes added in v1.53.18 

func (s *ForecastGeofenceEventsInput) SetTimeHorizonMinutes(v float64) *ForecastGeofenceEventsInput

SetTimeHorizonMinutes sets the TimeHorizonMinutes field's value.

func (ForecastGeofenceEventsInput) String added in v1.53.18 

func (s ForecastGeofenceEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ForecastGeofenceEventsInput) Validate added in v1.53.18 

func (s *ForecastGeofenceEventsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ForecastGeofenceEventsOutput added in v1.53.18 

type ForecastGeofenceEventsOutput struct {

	// The distance unit for the forecasted events.
	//
	// DistanceUnit is a required field
	DistanceUnit *string `type:"string" required:"true" enum:"DistanceUnit"`

	// The list of forecasted events.
	//
	// ForecastedEvents is a required field
	ForecastedEvents []*ForecastedEvent `type:"list" required:"true"`

	// 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 `min:"1" type:"string"`

	// The speed unit for the forecasted events.
	//
	// SpeedUnit is a required field
	SpeedUnit *string `type:"string" required:"true" enum:"SpeedUnit"`
	// contains filtered or unexported fields
}

func (ForecastGeofenceEventsOutput) GoString added in v1.53.18 

func (s ForecastGeofenceEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ForecastGeofenceEventsOutput) SetDistanceUnit added in v1.53.18 

func (s *ForecastGeofenceEventsOutput) SetDistanceUnit(v string) *ForecastGeofenceEventsOutput

SetDistanceUnit sets the DistanceUnit field's value.

func (*ForecastGeofenceEventsOutput) SetForecastedEvents added in v1.53.18 

func (s *ForecastGeofenceEventsOutput) SetForecastedEvents(v []*ForecastedEvent) *ForecastGeofenceEventsOutput

SetForecastedEvents sets the ForecastedEvents field's value.

func (*ForecastGeofenceEventsOutput) SetNextToken added in v1.53.18 

func (s *ForecastGeofenceEventsOutput) SetNextToken(v string) *ForecastGeofenceEventsOutput

SetNextToken sets the NextToken field's value.

func (*ForecastGeofenceEventsOutput) SetSpeedUnit added in v1.53.18 

func (s *ForecastGeofenceEventsOutput) SetSpeedUnit(v string) *ForecastGeofenceEventsOutput

SetSpeedUnit sets the SpeedUnit field's value.

func (ForecastGeofenceEventsOutput) String added in v1.53.18 

func (s ForecastGeofenceEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ForecastedEvent added in v1.53.18 

type ForecastedEvent struct {

	// The forecasted event identifier.
	//
	// EventId is a required field
	EventId *string `type:"string" required:"true"`

	// The event type, forecasting 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.
	//
	// EventType is a required field
	EventType *string `type:"string" required:"true" enum:"ForecastedGeofenceEventType"`

	// The forecasted time the device will breach the geofence in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html)
	// format: YYYY-MM-DDThh:mm:ss.sssZ
	ForecastedBreachTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The geofence identifier pertaining to the forecasted event.
	//
	// GeofenceId is a required field
	GeofenceId *string `min:"1" type:"string" required:"true"`

	// The geofence properties.
	//
	// GeofenceProperties is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ForecastedEvent's
	// String and GoString methods.
	GeofenceProperties map[string]*string `type:"map" sensitive:"true"`

	// Indicates if the device is located within the geofence.
	//
	// IsDeviceInGeofence is a required field
	IsDeviceInGeofence *bool `type:"boolean" required:"true"`

	// The closest distance from the device's position to the geofence.
	//
	// NearestDistance is a required field
	NearestDistance *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

A forecasted event represents a geofence event in relation to the requested device state, that may occur given the provided device state and time horizon.

func (ForecastedEvent) GoString added in v1.53.18 

func (s ForecastedEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ForecastedEvent) SetEventId added in v1.53.18 

func (s *ForecastedEvent) SetEventId(v string) *ForecastedEvent

SetEventId sets the EventId field's value.

func (*ForecastedEvent) SetEventType added in v1.53.18 

func (s *ForecastedEvent) SetEventType(v string) *ForecastedEvent

SetEventType sets the EventType field's value.

func (*ForecastedEvent) SetForecastedBreachTime added in v1.53.18 

func (s *ForecastedEvent) SetForecastedBreachTime(v time.Time) *ForecastedEvent

SetForecastedBreachTime sets the ForecastedBreachTime field's value.

func (*ForecastedEvent) SetGeofenceId added in v1.53.18 

func (s *ForecastedEvent) SetGeofenceId(v string) *ForecastedEvent

SetGeofenceId sets the GeofenceId field's value.

func (*ForecastedEvent) SetGeofenceProperties added in v1.53.18 

func (s *ForecastedEvent) SetGeofenceProperties(v map[string]*string) *ForecastedEvent

SetGeofenceProperties sets the GeofenceProperties field's value.

func (*ForecastedEvent) SetIsDeviceInGeofence added in v1.53.18 

func (s *ForecastedEvent) SetIsDeviceInGeofence(v bool) *ForecastedEvent

SetIsDeviceInGeofence sets the IsDeviceInGeofence field's value.

func (*ForecastedEvent) SetNearestDistance added in v1.53.18 

func (s *ForecastedEvent) SetNearestDistance(v float64) *ForecastedEvent

SetNearestDistance sets the NearestDistance field's value.

func (ForecastedEvent) String added in v1.53.18 

func (s ForecastedEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GeofenceGeometry 

type GeofenceGeometry struct {

	// A circle on the earth, as defined by a center point and a radius.
	//
	// Circle is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GeofenceGeometry's
	// String and GoString methods.
	Circle *Circle `type:"structure" sensitive:"true"`

	// Geobuf is a compact binary encoding for geographic data that provides lossless
	// compression of GeoJSON polygons. The Geobuf must be Base64-encoded.
	//
	// A polygon in Geobuf format can have up to 100,000 vertices.
	//
	// Geobuf is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GeofenceGeometry's
	// String and GoString methods.
	//
	// Geobuf is automatically base64 encoded/decoded by the SDK.
	Geobuf []byte `type:"blob" sensitive:"true"`

	// A polygon is a list of linear rings which are each made up of a list of vertices.
	//
	// Each vertex is a 2-dimensional point of the form: [longitude, latitude].
	// This is represented as an array of doubles of length 2 (so [double, double]).
	//
	// An array of 4 or more vertices, where the first and last vertex are the same
	// (to form a closed boundary), is called a linear ring. The linear ring vertices
	// must be listed in counter-clockwise order around the ring’s interior. The
	// linear ring is represented as an array of vertices, or an array of arrays
	// of doubles ([[double, double], ...]).
	//
	// A geofence consists of a single linear ring. To allow for future expansion,
	// the Polygon parameter takes an array of linear rings, which is represented
	// as an array of arrays of arrays of doubles ([[[double, double], ...], ...]).
	//
	// A linear ring for use in geofences can consist of between 4 and 1,000 vertices.
	Polygon [][][]*float64 `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Contains the geofence geometry details.

A geofence geometry is made up of either a polygon or a circle. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

Amazon Location doesn't currently support polygons with holes, multipolygons, polygons that are wound clockwise, or that cross the antimeridian.

func (GeofenceGeometry) GoString 

func (s GeofenceGeometry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GeofenceGeometry) SetCircle added in v1.44.72 

func (s *GeofenceGeometry) SetCircle(v *Circle) *GeofenceGeometry

SetCircle sets the Circle field's value.

func (*GeofenceGeometry) SetGeobuf added in v1.53.18 

func (s *GeofenceGeometry) SetGeobuf(v []byte) *GeofenceGeometry

SetGeobuf sets the Geobuf field's value.

func (*GeofenceGeometry) SetPolygon 

func (s *GeofenceGeometry) SetPolygon(v [][][]*float64) *GeofenceGeometry

SetPolygon sets the Polygon field's value.

func (GeofenceGeometry) String 

func (s GeofenceGeometry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GeofenceGeometry) Validate 

func (s *GeofenceGeometry) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDevicePositionHistoryInput 

type GetDevicePositionHistoryInput struct {

	// The device whose position history you want to retrieve.
	//
	// DeviceId is a required field
	DeviceId *string `location:"uri" locationName:"DeviceId" min:"1" type:"string" required:"true"`

	// 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 `type:"timestamp" timestampFormat:"iso8601"`

	// An optional limit for the number of device positions returned in a single
	// call.
	//
	// Default value: 100
	MaxResults *int64 `min:"1" type:"integer"`

	// 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 `min:"1" type:"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:"timestamp" timestampFormat:"iso8601"`

	// The tracker resource receiving the request for the device position history.
	//
	// TrackerName is a required field
	TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDevicePositionHistoryInput) GoString 

func (s GetDevicePositionHistoryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDevicePositionHistoryInput) SetDeviceId 

func (s *GetDevicePositionHistoryInput) SetDeviceId(v string) *GetDevicePositionHistoryInput

SetDeviceId sets the DeviceId field's value.

func (*GetDevicePositionHistoryInput) SetEndTimeExclusive 

func (s *GetDevicePositionHistoryInput) SetEndTimeExclusive(v time.Time) *GetDevicePositionHistoryInput

SetEndTimeExclusive sets the EndTimeExclusive field's value.

func (*GetDevicePositionHistoryInput) SetMaxResults added in v1.43.23 

func (s *GetDevicePositionHistoryInput) SetMaxResults(v int64) *GetDevicePositionHistoryInput

SetMaxResults sets the MaxResults field's value.

func (*GetDevicePositionHistoryInput) SetNextToken 

func (s *GetDevicePositionHistoryInput) SetNextToken(v string) *GetDevicePositionHistoryInput

SetNextToken sets the NextToken field's value.

func (*GetDevicePositionHistoryInput) SetStartTimeInclusive 

func (s *GetDevicePositionHistoryInput) SetStartTimeInclusive(v time.Time) *GetDevicePositionHistoryInput

SetStartTimeInclusive sets the StartTimeInclusive field's value.

func (*GetDevicePositionHistoryInput) SetTrackerName 

func (s *GetDevicePositionHistoryInput) SetTrackerName(v string) *GetDevicePositionHistoryInput

SetTrackerName sets the TrackerName field's value.

func (GetDevicePositionHistoryInput) String 

func (s GetDevicePositionHistoryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDevicePositionHistoryInput) Validate 

func (s *GetDevicePositionHistoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDevicePositionHistoryOutput 

type GetDevicePositionHistoryOutput struct {

	// Contains the position history details for the requested device.
	//
	// DevicePositions is a required field
	DevicePositions []*DevicePosition `type:"list" required:"true"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetDevicePositionHistoryOutput) GoString 

func (s GetDevicePositionHistoryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDevicePositionHistoryOutput) SetDevicePositions 

func (s *GetDevicePositionHistoryOutput) SetDevicePositions(v []*DevicePosition) *GetDevicePositionHistoryOutput

SetDevicePositions sets the DevicePositions field's value.

func (*GetDevicePositionHistoryOutput) SetNextToken 

func (s *GetDevicePositionHistoryOutput) SetNextToken(v string) *GetDevicePositionHistoryOutput

SetNextToken sets the NextToken field's value.

func (GetDevicePositionHistoryOutput) String 

func (s GetDevicePositionHistoryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDevicePositionInput 

type GetDevicePositionInput struct {

	// The device whose position you want to retrieve.
	//
	// DeviceId is a required field
	DeviceId *string `location:"uri" locationName:"DeviceId" min:"1" type:"string" required:"true"`

	// The tracker resource receiving the position update.
	//
	// TrackerName is a required field
	TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDevicePositionInput) GoString 

func (s GetDevicePositionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDevicePositionInput) SetDeviceId 

func (s *GetDevicePositionInput) SetDeviceId(v string) *GetDevicePositionInput

SetDeviceId sets the DeviceId field's value.

func (*GetDevicePositionInput) SetTrackerName 

func (s *GetDevicePositionInput) SetTrackerName(v string) *GetDevicePositionInput

SetTrackerName sets the TrackerName field's value.

func (GetDevicePositionInput) String 

func (s GetDevicePositionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDevicePositionInput) Validate 

func (s *GetDevicePositionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDevicePositionOutput 

type GetDevicePositionOutput struct {

	// The accuracy of the device position.
	Accuracy *PositionalAccuracy `type:"structure"`

	// The device whose position you retrieved.
	DeviceId *string `min:"1" type:"string"`

	// The last known device position.
	//
	// Position is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetDevicePositionOutput's
	// String and GoString methods.
	//
	// Position is a required field
	Position []*float64 `min:"2" type:"list" required:"true" sensitive:"true"`

	// The properties associated with the position.
	//
	// PositionProperties is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetDevicePositionOutput's
	// String and GoString methods.
	PositionProperties map[string]*string `type:"map" sensitive:"true"`

	// The timestamp for when the tracker resource received the device position.
	// Uses ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format:
	// YYYY-MM-DDThh:mm:ss.sssZ.
	//
	// ReceivedTime is a required field
	ReceivedTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// 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.
	//
	// SampleTime is a required field
	SampleTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (GetDevicePositionOutput) GoString 

func (s GetDevicePositionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDevicePositionOutput) SetAccuracy added in v1.42.20 

func (s *GetDevicePositionOutput) SetAccuracy(v *PositionalAccuracy) *GetDevicePositionOutput

SetAccuracy sets the Accuracy field's value.

func (*GetDevicePositionOutput) SetDeviceId 

func (s *GetDevicePositionOutput) SetDeviceId(v string) *GetDevicePositionOutput

SetDeviceId sets the DeviceId field's value.

func (*GetDevicePositionOutput) SetPosition 

func (s *GetDevicePositionOutput) SetPosition(v []*float64) *GetDevicePositionOutput

SetPosition sets the Position field's value.

func (*GetDevicePositionOutput) SetPositionProperties added in v1.42.20 

func (s *GetDevicePositionOutput) SetPositionProperties(v map[string]*string) *GetDevicePositionOutput

SetPositionProperties sets the PositionProperties field's value.

func (*GetDevicePositionOutput) SetReceivedTime 

func (s *GetDevicePositionOutput) SetReceivedTime(v time.Time) *GetDevicePositionOutput

SetReceivedTime sets the ReceivedTime field's value.

func (*GetDevicePositionOutput) SetSampleTime 

func (s *GetDevicePositionOutput) SetSampleTime(v time.Time) *GetDevicePositionOutput

SetSampleTime sets the SampleTime field's value.

func (GetDevicePositionOutput) String 

func (s GetDevicePositionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetGeofenceInput 

type GetGeofenceInput struct {

	// The geofence collection storing the target geofence.
	//
	// CollectionName is a required field
	CollectionName *string `location:"uri" locationName:"CollectionName" min:"1" type:"string" required:"true"`

	// The geofence you're retrieving details for.
	//
	// GeofenceId is a required field
	GeofenceId *string `location:"uri" locationName:"GeofenceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetGeofenceInput) GoString 

func (s GetGeofenceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetGeofenceInput) SetCollectionName 

func (s *GetGeofenceInput) SetCollectionName(v string) *GetGeofenceInput

SetCollectionName sets the CollectionName field's value.

func (*GetGeofenceInput) SetGeofenceId 

func (s *GetGeofenceInput) SetGeofenceId(v string) *GetGeofenceInput

SetGeofenceId sets the GeofenceId field's value.

func (GetGeofenceInput) String 

func (s GetGeofenceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetGeofenceInput) Validate 

func (s *GetGeofenceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The geofence identifier.
	//
	// GeofenceId is a required field
	GeofenceId *string `min:"1" type:"string" required:"true"`

	// 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetGeofenceOutput's
	// String and GoString methods.
	GeofenceProperties map[string]*string `type:"map" sensitive:"true"`

	// Contains the geofence geometry details describing a polygon or a circle.
	//
	// Geometry is a required field
	Geometry *GeofenceGeometry `type:"structure" required:"true"`

	// 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.
	//
	// Status is a required field
	Status *string `type:"string" required:"true"`

	// 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
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (GetGeofenceOutput) GoString 

func (s GetGeofenceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetGeofenceOutput) SetCreateTime 

func (s *GetGeofenceOutput) SetCreateTime(v time.Time) *GetGeofenceOutput

SetCreateTime sets the CreateTime field's value.

func (*GetGeofenceOutput) SetGeofenceId 

func (s *GetGeofenceOutput) SetGeofenceId(v string) *GetGeofenceOutput

SetGeofenceId sets the GeofenceId field's value.

func (*GetGeofenceOutput) SetGeofenceProperties added in v1.44.283 

func (s *GetGeofenceOutput) SetGeofenceProperties(v map[string]*string) *GetGeofenceOutput

SetGeofenceProperties sets the GeofenceProperties field's value.

func (*GetGeofenceOutput) SetGeometry 

func (s *GetGeofenceOutput) SetGeometry(v *GeofenceGeometry) *GetGeofenceOutput

SetGeometry sets the Geometry field's value.

func (*GetGeofenceOutput) SetStatus 

func (s *GetGeofenceOutput) SetStatus(v string) *GetGeofenceOutput

SetStatus sets the Status field's value.

func (*GetGeofenceOutput) SetUpdateTime 

func (s *GetGeofenceOutput) SetUpdateTime(v time.Time) *GetGeofenceOutput

SetUpdateTime sets the UpdateTime field's value.

func (GetGeofenceOutput) String 

func (s GetGeofenceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 (https://docs.aws.amazon.com/location/latest/developerguide/esri.html)
	// 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 (https://docs.aws.amazon.com/location/latest/developerguide/HERE.html)
	// 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 (https://docs.aws.amazon.com/location/latest/developerguide/grab.html)
	// styles:
	//
	//    * VectorGrabStandardLight, VectorGrabStandardDark – Noto Sans Regular
	//    | Noto Sans Medium | Noto Sans Bold
	//
	// Valid font stacks for Open Data (https://docs.aws.amazon.com/location/latest/developerguide/open-data.html)
	// 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.
	//
	// FontStack is a required field
	FontStack *string `location:"uri" locationName:"FontStack" type:"string" required:"true"`

	// 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.
	//
	// FontUnicodeRange is a required field
	FontUnicodeRange *string `location:"uri" locationName:"FontUnicodeRange" type:"string" required:"true"`

	// The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html)
	// to authorize the request.
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetMapGlyphsInput's
	// String and GoString methods.
	Key *string `location:"querystring" locationName:"key" type:"string" sensitive:"true"`

	// The map resource associated with the glyph file.
	//
	// MapName is a required field
	MapName *string `location:"uri" locationName:"MapName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMapGlyphsInput) GoString 

func (s GetMapGlyphsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMapGlyphsInput) SetFontStack 

func (s *GetMapGlyphsInput) SetFontStack(v string) *GetMapGlyphsInput

SetFontStack sets the FontStack field's value.

func (*GetMapGlyphsInput) SetFontUnicodeRange 

func (s *GetMapGlyphsInput) SetFontUnicodeRange(v string) *GetMapGlyphsInput

SetFontUnicodeRange sets the FontUnicodeRange field's value.

func (*GetMapGlyphsInput) SetKey added in v1.44.208 

func (s *GetMapGlyphsInput) SetKey(v string) *GetMapGlyphsInput

SetKey sets the Key field's value.

func (*GetMapGlyphsInput) SetMapName 

func (s *GetMapGlyphsInput) SetMapName(v string) *GetMapGlyphsInput

SetMapName sets the MapName field's value.

func (GetMapGlyphsInput) String 

func (s GetMapGlyphsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMapGlyphsInput) Validate 

func (s *GetMapGlyphsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetMapGlyphsOutput 

type GetMapGlyphsOutput struct {

	// The glyph, as binary blob.
	Blob []byte `type:"blob"`

	// The HTTP Cache-Control directive for the value.
	CacheControl *string `location:"header" locationName:"Cache-Control" type:"string"`

	// The map glyph content type. For example, application/octet-stream.
	ContentType *string `location:"header" locationName:"Content-Type" type:"string"`
	// contains filtered or unexported fields
}

func (GetMapGlyphsOutput) GoString 

func (s GetMapGlyphsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMapGlyphsOutput) SetBlob 

func (s *GetMapGlyphsOutput) SetBlob(v []byte) *GetMapGlyphsOutput

SetBlob sets the Blob field's value.

func (*GetMapGlyphsOutput) SetCacheControl added in v1.44.208 

func (s *GetMapGlyphsOutput) SetCacheControl(v string) *GetMapGlyphsOutput

SetCacheControl sets the CacheControl field's value.

func (*GetMapGlyphsOutput) SetContentType 

func (s *GetMapGlyphsOutput) SetContentType(v string) *GetMapGlyphsOutput

SetContentType sets the ContentType field's value.

func (GetMapGlyphsOutput) String 

func (s GetMapGlyphsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
	//
	// FileName is a required field
	FileName *string `location:"uri" locationName:"FileName" type:"string" required:"true"`

	// The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html)
	// to authorize the request.
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetMapSpritesInput's
	// String and GoString methods.
	Key *string `location:"querystring" locationName:"key" type:"string" sensitive:"true"`

	// The map resource associated with the sprite file.
	//
	// MapName is a required field
	MapName *string `location:"uri" locationName:"MapName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMapSpritesInput) GoString 

func (s GetMapSpritesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMapSpritesInput) SetFileName 

func (s *GetMapSpritesInput) SetFileName(v string) *GetMapSpritesInput

SetFileName sets the FileName field's value.

func (*GetMapSpritesInput) SetKey added in v1.44.208 

func (s *GetMapSpritesInput) SetKey(v string) *GetMapSpritesInput

SetKey sets the Key field's value.

func (*GetMapSpritesInput) SetMapName 

func (s *GetMapSpritesInput) SetMapName(v string) *GetMapSpritesInput

SetMapName sets the MapName field's value.

func (GetMapSpritesInput) String 

func (s GetMapSpritesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMapSpritesInput) Validate 

func (s *GetMapSpritesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetMapSpritesOutput 

type GetMapSpritesOutput struct {

	// Contains the body of the sprite sheet or JSON offset file.
	Blob []byte `type:"blob"`

	// The HTTP Cache-Control directive for the value.
	CacheControl *string `location:"header" locationName:"Cache-Control" type:"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 `location:"header" locationName:"Content-Type" type:"string"`
	// contains filtered or unexported fields
}

func (GetMapSpritesOutput) GoString 

func (s GetMapSpritesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMapSpritesOutput) SetBlob 

func (s *GetMapSpritesOutput) SetBlob(v []byte) *GetMapSpritesOutput

SetBlob sets the Blob field's value.

func (*GetMapSpritesOutput) SetCacheControl added in v1.44.208 

func (s *GetMapSpritesOutput) SetCacheControl(v string) *GetMapSpritesOutput

SetCacheControl sets the CacheControl field's value.

func (*GetMapSpritesOutput) SetContentType 

func (s *GetMapSpritesOutput) SetContentType(v string) *GetMapSpritesOutput

SetContentType sets the ContentType field's value.

func (GetMapSpritesOutput) String 

func (s GetMapSpritesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetMapStyleDescriptorInput 

type GetMapStyleDescriptorInput struct {

	// The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html)
	// to authorize the request.
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetMapStyleDescriptorInput's
	// String and GoString methods.
	Key *string `location:"querystring" locationName:"key" type:"string" sensitive:"true"`

	// The map resource to retrieve the style descriptor from.
	//
	// MapName is a required field
	MapName *string `location:"uri" locationName:"MapName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMapStyleDescriptorInput) GoString 

func (s GetMapStyleDescriptorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMapStyleDescriptorInput) SetKey added in v1.44.208 

func (s *GetMapStyleDescriptorInput) SetKey(v string) *GetMapStyleDescriptorInput

SetKey sets the Key field's value.

func (*GetMapStyleDescriptorInput) SetMapName 

func (s *GetMapStyleDescriptorInput) SetMapName(v string) *GetMapStyleDescriptorInput

SetMapName sets the MapName field's value.

func (GetMapStyleDescriptorInput) String 

func (s GetMapStyleDescriptorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMapStyleDescriptorInput) Validate 

func (s *GetMapStyleDescriptorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetMapStyleDescriptorOutput 

type GetMapStyleDescriptorOutput struct {

	// Contains the body of the style descriptor.
	Blob []byte `type:"blob"`

	// The HTTP Cache-Control directive for the value.
	CacheControl *string `location:"header" locationName:"Cache-Control" type:"string"`

	// The style descriptor's content type. For example, application/json.
	ContentType *string `location:"header" locationName:"Content-Type" type:"string"`
	// contains filtered or unexported fields
}

func (GetMapStyleDescriptorOutput) GoString 

func (s GetMapStyleDescriptorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMapStyleDescriptorOutput) SetBlob 

func (s *GetMapStyleDescriptorOutput) SetBlob(v []byte) *GetMapStyleDescriptorOutput

SetBlob sets the Blob field's value.

func (*GetMapStyleDescriptorOutput) SetCacheControl added in v1.44.208 

func (s *GetMapStyleDescriptorOutput) SetCacheControl(v string) *GetMapStyleDescriptorOutput

SetCacheControl sets the CacheControl field's value.

func (*GetMapStyleDescriptorOutput) SetContentType 

func (s *GetMapStyleDescriptorOutput) SetContentType(v string) *GetMapStyleDescriptorOutput

SetContentType sets the ContentType field's value.

func (GetMapStyleDescriptorOutput) String 

func (s GetMapStyleDescriptorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetMapTileInput 

type GetMapTileInput struct {

	// The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html)
	// to authorize the request.
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetMapTileInput's
	// String and GoString methods.
	Key *string `location:"querystring" locationName:"key" type:"string" sensitive:"true"`

	// The map resource to retrieve the map tiles from.
	//
	// MapName is a required field
	MapName *string `location:"uri" locationName:"MapName" min:"1" type:"string" required:"true"`

	// The X axis value for the map tile.
	//
	// X is a required field
	X *string `location:"uri" locationName:"X" type:"string" required:"true"`

	// The Y axis value for the map tile.
	//
	// Y is a required field
	Y *string `location:"uri" locationName:"Y" type:"string" required:"true"`

	// The zoom value for the map tile.
	//
	// Z is a required field
	Z *string `location:"uri" locationName:"Z" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMapTileInput) GoString 

func (s GetMapTileInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMapTileInput) SetKey added in v1.44.208 

func (s *GetMapTileInput) SetKey(v string) *GetMapTileInput

SetKey sets the Key field's value.

func (*GetMapTileInput) SetMapName 

func (s *GetMapTileInput) SetMapName(v string) *GetMapTileInput

SetMapName sets the MapName field's value.

func (*GetMapTileInput) SetX 

func (s *GetMapTileInput) SetX(v string) *GetMapTileInput

SetX sets the X field's value.

func (*GetMapTileInput) SetY 

func (s *GetMapTileInput) SetY(v string) *GetMapTileInput

SetY sets the Y field's value.

func (*GetMapTileInput) SetZ 

func (s *GetMapTileInput) SetZ(v string) *GetMapTileInput

SetZ sets the Z field's value.

func (GetMapTileInput) String 

func (s GetMapTileInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMapTileInput) Validate 

func (s *GetMapTileInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetMapTileOutput 

type GetMapTileOutput struct {

	// Contains Mapbox Vector Tile (MVT) data.
	Blob []byte `type:"blob"`

	// The HTTP Cache-Control directive for the value.
	CacheControl *string `location:"header" locationName:"Cache-Control" type:"string"`

	// The map tile's content type. For example, application/vnd.mapbox-vector-tile.
	ContentType *string `location:"header" locationName:"Content-Type" type:"string"`
	// contains filtered or unexported fields
}

func (GetMapTileOutput) GoString 

func (s GetMapTileOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMapTileOutput) SetBlob 

func (s *GetMapTileOutput) SetBlob(v []byte) *GetMapTileOutput

SetBlob sets the Blob field's value.

func (*GetMapTileOutput) SetCacheControl added in v1.44.208 

func (s *GetMapTileOutput) SetCacheControl(v string) *GetMapTileOutput

SetCacheControl sets the CacheControl field's value.

func (*GetMapTileOutput) SetContentType 

func (s *GetMapTileOutput) SetContentType(v string) *GetMapTileOutput

SetContentType sets the ContentType field's value.

func (GetMapTileOutput) String 

func (s GetMapTileOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetPlaceInput added in v1.44.107 

type GetPlaceInput struct {

	// The name of the place index resource that you want to use for the search.
	//
	// IndexName is a required field
	IndexName *string `location:"uri" locationName:"IndexName" min:"1" type:"string" required:"true"`

	// The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html)
	// to authorize the request.
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetPlaceInput's
	// String and GoString methods.
	Key *string `location:"querystring" locationName:"key" type:"string" sensitive:"true"`

	// The preferred language used to return results. The value must be a valid
	// BCP 47 (https://tools.ietf.org/search/bcp47) 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.
	Language *string `location:"querystring" locationName:"language" min:"2" type:"string"`

	// The identifier of the place to find.
	//
	// PlaceId is a required field
	PlaceId *string `location:"uri" locationName:"PlaceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPlaceInput) GoString added in v1.44.107 

func (s GetPlaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPlaceInput) SetIndexName added in v1.44.107 

func (s *GetPlaceInput) SetIndexName(v string) *GetPlaceInput

SetIndexName sets the IndexName field's value.

func (*GetPlaceInput) SetKey added in v1.44.297 

func (s *GetPlaceInput) SetKey(v string) *GetPlaceInput

SetKey sets the Key field's value.

func (*GetPlaceInput) SetLanguage added in v1.44.107 

func (s *GetPlaceInput) SetLanguage(v string) *GetPlaceInput

SetLanguage sets the Language field's value.

func (*GetPlaceInput) SetPlaceId added in v1.44.107 

func (s *GetPlaceInput) SetPlaceId(v string) *GetPlaceInput

SetPlaceId sets the PlaceId field's value.

func (GetPlaceInput) String added in v1.44.107 

func (s GetPlaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPlaceInput) Validate added in v1.44.107 

func (s *GetPlaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetPlaceOutput added in v1.44.107 

type GetPlaceOutput struct {

	// Details about the result, such as its address and position.
	//
	// Place is a required field
	Place *Place `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetPlaceOutput) GoString added in v1.44.107 

func (s GetPlaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPlaceOutput) SetPlace added in v1.44.107 

func (s *GetPlaceOutput) SetPlace(v *Place) *GetPlaceOutput

SetPlace sets the Place field's value.

func (GetPlaceOutput) String added in v1.44.107 

func (s GetPlaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InferredState added in v1.53.18 

type InferredState struct {

	// The level of certainty of the inferred position.
	Accuracy *PositionalAccuracy `type:"structure"`

	// The distance between the inferred position and the device's self-reported
	// position.
	DeviationDistance *float64 `type:"double"`

	// The device position inferred by the provided position, IP address, cellular
	// signals, and Wi-Fi- access points.
	//
	// Position is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by InferredState's
	// String and GoString methods.
	Position []*float64 `min:"2" type:"list" sensitive:"true"`

	// Indicates if a proxy was used.
	//
	// ProxyDetected is a required field
	ProxyDetected *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

The inferred state of the device, given the provided position, IP address, cellular signals, and Wi-Fi- access points.

func (InferredState) GoString added in v1.53.18 

func (s InferredState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InferredState) SetAccuracy added in v1.53.18 

func (s *InferredState) SetAccuracy(v *PositionalAccuracy) *InferredState

SetAccuracy sets the Accuracy field's value.

func (*InferredState) SetDeviationDistance added in v1.53.18 

func (s *InferredState) SetDeviationDistance(v float64) *InferredState

SetDeviationDistance sets the DeviationDistance field's value.

func (*InferredState) SetPosition added in v1.53.18 

func (s *InferredState) SetPosition(v []*float64) *InferredState

SetPosition sets the Position field's value.

func (*InferredState) SetProxyDetected added in v1.53.18 

func (s *InferredState) SetProxyDetected(v bool) *InferredState

SetProxyDetected sets the ProxyDetected field's value.

func (InferredState) String added in v1.53.18 

func (s InferredState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request has failed to process because of an unknown server error, exception, or failure.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Leg added in v1.38.51 

type Leg struct {

	// The distance between the leg's StartPosition and EndPosition along a calculated
	// route.
	//
	//    * The default measurement is Kilometers unless the request specifies a
	//    DistanceUnit of Miles.
	//
	// Distance is a required field
	Distance *float64 `type:"double" required:"true"`

	// The estimated travel time between the leg's StartPosition and EndPosition.
	// The travel mode and departure time that you specify in the request determines
	// the calculated time.
	//
	// DurationSeconds is a required field
	DurationSeconds *float64 `type:"double" required:"true"`

	// The terminating position of the leg. Follows the format [longitude,latitude].
	//
	// If the EndPosition isn't located on a road, it's snapped to a nearby road
	// (https://docs.aws.amazon.com/location/latest/developerguide/nap-to-nearby-road.html).
	//
	// EndPosition is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Leg's
	// String and GoString methods.
	//
	// EndPosition is a required field
	EndPosition []*float64 `min:"2" type:"list" required:"true" sensitive:"true"`

	// Contains the calculated route's path as a linestring geometry.
	Geometry *LegGeometry `type:"structure"`

	// The starting position of the leg. Follows the format [longitude,latitude].
	//
	// If the StartPosition isn't located on a road, it's snapped to a nearby road
	// (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html).
	//
	// StartPosition is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Leg's
	// String and GoString methods.
	//
	// StartPosition is a required field
	StartPosition []*float64 `min:"2" type:"list" required:"true" sensitive:"true"`

	// Contains a list of steps, which represent subsections of a leg. Each step
	// provides instructions for how to move to the next step in the leg such as
	// the step's start position, end position, travel distance, travel duration,
	// and geometry offset.
	//
	// Steps is a required field
	Steps []*Step `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the calculated route's details for each path between a pair of positions. 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 (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html):

  • 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.

func (Leg) GoString added in v1.38.51 

func (s Leg) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Leg) SetDistance added in v1.38.51 

func (s *Leg) SetDistance(v float64) *Leg

SetDistance sets the Distance field's value.

func (*Leg) SetDurationSeconds added in v1.38.51 

func (s *Leg) SetDurationSeconds(v float64) *Leg

SetDurationSeconds sets the DurationSeconds field's value.

func (*Leg) SetEndPosition added in v1.38.51 

func (s *Leg) SetEndPosition(v []*float64) *Leg

SetEndPosition sets the EndPosition field's value.

func (*Leg) SetGeometry added in v1.38.51 

func (s *Leg) SetGeometry(v *LegGeometry) *Leg

SetGeometry sets the Geometry field's value.

func (*Leg) SetStartPosition added in v1.38.51 

func (s *Leg) SetStartPosition(v []*float64) *Leg

SetStartPosition sets the StartPosition field's value.

func (*Leg) SetSteps added in v1.38.51 

func (s *Leg) SetSteps(v []*Step) *Leg

SetSteps sets the Steps field's value.

func (Leg) String added in v1.38.51 

func (s Leg) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LegGeometry added in v1.38.51 

type LegGeometry struct {

	// An ordered list of positions used to plot a route on a map.
	//
	// The first position is closest to the start position for the leg, and the
	// last position is the closest to the end position for the leg.
	//
	//    * For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]
	LineString [][]*float64 `min:"2" type:"list" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains the geometry details for each path between a pair of positions. Used in plotting a route leg on a map.

func (LegGeometry) GoString added in v1.38.51 

func (s LegGeometry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LegGeometry) SetLineString added in v1.38.51 

func (s *LegGeometry) SetLineString(v [][]*float64) *LegGeometry

SetLineString sets the LineString field's value.

func (LegGeometry) String added in v1.38.51 

func (s LegGeometry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDevicePositionsInput added in v1.38.51 

type ListDevicePositionsInput struct {

	// The geometry used to filter device positions.
	FilterGeometry *TrackingFilterGeometry `type:"structure"`

	// An optional limit for the number of entries returned in a single call.
	//
	// Default value: 100
	MaxResults *int64 `min:"1" type:"integer"`

	// 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 `min:"1" type:"string"`

	// The tracker resource containing the requested devices.
	//
	// TrackerName is a required field
	TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListDevicePositionsInput) GoString added in v1.38.51 

func (s ListDevicePositionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDevicePositionsInput) SetFilterGeometry added in v1.45.21 

func (s *ListDevicePositionsInput) SetFilterGeometry(v *TrackingFilterGeometry) *ListDevicePositionsInput

SetFilterGeometry sets the FilterGeometry field's value.

func (*ListDevicePositionsInput) SetMaxResults added in v1.38.51 

func (s *ListDevicePositionsInput) SetMaxResults(v int64) *ListDevicePositionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDevicePositionsInput) SetNextToken added in v1.38.51 

func (s *ListDevicePositionsInput) SetNextToken(v string) *ListDevicePositionsInput

SetNextToken sets the NextToken field's value.

func (*ListDevicePositionsInput) SetTrackerName added in v1.38.51 

func (s *ListDevicePositionsInput) SetTrackerName(v string) *ListDevicePositionsInput

SetTrackerName sets the TrackerName field's value.

func (ListDevicePositionsInput) String added in v1.38.51 

func (s ListDevicePositionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDevicePositionsInput) Validate added in v1.38.51 

func (s *ListDevicePositionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDevicePositionsOutput added in v1.38.51 

type ListDevicePositionsOutput struct {

	// Contains details about each device's last known position.
	//
	// Entries is a required field
	Entries []*ListDevicePositionsResponseEntry `type:"list" required:"true"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDevicePositionsOutput) GoString added in v1.38.51 

func (s ListDevicePositionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDevicePositionsOutput) SetEntries added in v1.38.51 

func (s *ListDevicePositionsOutput) SetEntries(v []*ListDevicePositionsResponseEntry) *ListDevicePositionsOutput

SetEntries sets the Entries field's value.

func (*ListDevicePositionsOutput) SetNextToken added in v1.38.51 

func (s *ListDevicePositionsOutput) SetNextToken(v string) *ListDevicePositionsOutput

SetNextToken sets the NextToken field's value.

func (ListDevicePositionsOutput) String added in v1.38.51 

func (s ListDevicePositionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDevicePositionsResponseEntry added in v1.38.51 

type ListDevicePositionsResponseEntry struct {

	// The accuracy of the device position.
	Accuracy *PositionalAccuracy `type:"structure"`

	// The ID of the device for this position.
	//
	// DeviceId is a required field
	DeviceId *string `min:"1" type:"string" required:"true"`

	// The last known device position. Empty if no positions currently stored.
	//
	// Position is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListDevicePositionsResponseEntry's
	// String and GoString methods.
	//
	// Position is a required field
	Position []*float64 `min:"2" type:"list" required:"true" sensitive:"true"`

	// The properties associated with the position.
	//
	// PositionProperties is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListDevicePositionsResponseEntry's
	// String and GoString methods.
	PositionProperties map[string]*string `type:"map" sensitive:"true"`

	// The timestamp at which the device position was determined. Uses ISO 8601
	// (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ.
	//
	// SampleTime is a required field
	SampleTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains the tracker resource details.

func (ListDevicePositionsResponseEntry) GoString added in v1.38.51 

func (s ListDevicePositionsResponseEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDevicePositionsResponseEntry) SetAccuracy added in v1.42.20 

func (s *ListDevicePositionsResponseEntry) SetAccuracy(v *PositionalAccuracy) *ListDevicePositionsResponseEntry

SetAccuracy sets the Accuracy field's value.

func (*ListDevicePositionsResponseEntry) SetDeviceId added in v1.38.51 

func (s *ListDevicePositionsResponseEntry) SetDeviceId(v string) *ListDevicePositionsResponseEntry

SetDeviceId sets the DeviceId field's value.

func (*ListDevicePositionsResponseEntry) SetPosition added in v1.38.51 

func (s *ListDevicePositionsResponseEntry) SetPosition(v []*float64) *ListDevicePositionsResponseEntry

SetPosition sets the Position field's value.

func (*ListDevicePositionsResponseEntry) SetPositionProperties added in v1.42.20 

func (s *ListDevicePositionsResponseEntry) SetPositionProperties(v map[string]*string) *ListDevicePositionsResponseEntry

SetPositionProperties sets the PositionProperties field's value.

func (*ListDevicePositionsResponseEntry) SetSampleTime added in v1.38.51 

func (s *ListDevicePositionsResponseEntry) SetSampleTime(v time.Time) *ListDevicePositionsResponseEntry

SetSampleTime sets the SampleTime field's value.

func (ListDevicePositionsResponseEntry) String added in v1.38.51 

func (s ListDevicePositionsResponseEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListGeofenceCollectionsInput 

type ListGeofenceCollectionsInput struct {

	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 100
	MaxResults *int64 `min:"1" type:"integer"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListGeofenceCollectionsInput) GoString 

func (s ListGeofenceCollectionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGeofenceCollectionsInput) SetMaxResults 

func (s *ListGeofenceCollectionsInput) SetMaxResults(v int64) *ListGeofenceCollectionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListGeofenceCollectionsInput) SetNextToken 

func (s *ListGeofenceCollectionsInput) SetNextToken(v string) *ListGeofenceCollectionsInput

SetNextToken sets the NextToken field's value.

func (ListGeofenceCollectionsInput) String 

func (s ListGeofenceCollectionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGeofenceCollectionsInput) Validate 

func (s *ListGeofenceCollectionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListGeofenceCollectionsOutput 

type ListGeofenceCollectionsOutput struct {

	// Lists the geofence collections that exist in your Amazon Web Services account.
	//
	// Entries is a required field
	Entries []*ListGeofenceCollectionsResponseEntry `type:"list" required:"true"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListGeofenceCollectionsOutput) GoString 

func (s ListGeofenceCollectionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGeofenceCollectionsOutput) SetEntries 

func (s *ListGeofenceCollectionsOutput) SetEntries(v []*ListGeofenceCollectionsResponseEntry) *ListGeofenceCollectionsOutput

SetEntries sets the Entries field's value.

func (*ListGeofenceCollectionsOutput) SetNextToken 

func (s *ListGeofenceCollectionsOutput) SetNextToken(v string) *ListGeofenceCollectionsOutput

SetNextToken sets the NextToken field's value.

func (ListGeofenceCollectionsOutput) String 

func (s ListGeofenceCollectionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListGeofenceCollectionsResponseEntry 

type ListGeofenceCollectionsResponseEntry struct {

	// The name of the geofence collection.
	//
	// CollectionName is a required field
	CollectionName *string `min:"1" type:"string" required:"true"`

	// 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
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description for the geofence collection
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// No longer used. Always returns RequestBasedUsage.
	//
	// Deprecated: Deprecated. Always returns RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"`

	// No longer used. Always returns an empty string.
	//
	// Deprecated: Deprecated. Unused.
	PricingPlanDataSource *string `deprecated:"true" type:"string"`

	// Specifies a timestamp for when the 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
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains the geofence collection details.

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

func (ListGeofenceCollectionsResponseEntry) GoString 

func (s ListGeofenceCollectionsResponseEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGeofenceCollectionsResponseEntry) SetCollectionName 

func (s *ListGeofenceCollectionsResponseEntry) SetCollectionName(v string) *ListGeofenceCollectionsResponseEntry

SetCollectionName sets the CollectionName field's value.

func (*ListGeofenceCollectionsResponseEntry) SetCreateTime 

func (s *ListGeofenceCollectionsResponseEntry) SetCreateTime(v time.Time) *ListGeofenceCollectionsResponseEntry

SetCreateTime sets the CreateTime field's value.

func (*ListGeofenceCollectionsResponseEntry) SetDescription 

func (s *ListGeofenceCollectionsResponseEntry) SetDescription(v string) *ListGeofenceCollectionsResponseEntry

SetDescription sets the Description field's value.

func (*ListGeofenceCollectionsResponseEntry) SetPricingPlan added in v1.38.8 

func (s *ListGeofenceCollectionsResponseEntry) SetPricingPlan(v string) *ListGeofenceCollectionsResponseEntry

SetPricingPlan sets the PricingPlan field's value.

func (*ListGeofenceCollectionsResponseEntry) SetPricingPlanDataSource added in v1.38.8 

func (s *ListGeofenceCollectionsResponseEntry) SetPricingPlanDataSource(v string) *ListGeofenceCollectionsResponseEntry

SetPricingPlanDataSource sets the PricingPlanDataSource field's value.

func (*ListGeofenceCollectionsResponseEntry) SetUpdateTime 

func (s *ListGeofenceCollectionsResponseEntry) SetUpdateTime(v time.Time) *ListGeofenceCollectionsResponseEntry

SetUpdateTime sets the UpdateTime field's value.

func (ListGeofenceCollectionsResponseEntry) String 

func (s ListGeofenceCollectionsResponseEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListGeofenceResponseEntry 

type ListGeofenceResponseEntry struct {

	// The timestamp for when the geofence was stored in a geofence collection in
	// ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format:
	// YYYY-MM-DDThh:mm:ss.sssZ
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The geofence identifier.
	//
	// GeofenceId is a required field
	GeofenceId *string `min:"1" type:"string" required:"true"`

	// 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListGeofenceResponseEntry's
	// String and GoString methods.
	GeofenceProperties map[string]*string `type:"map" sensitive:"true"`

	// Contains the geofence geometry details describing a polygon or a circle.
	//
	// Geometry is a required field
	Geometry *GeofenceGeometry `type:"structure" required:"true"`

	// 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.
	//
	// Status is a required field
	Status *string `type:"string" required:"true"`

	// 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
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains a list of geofences stored in a given geofence collection.

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

func (ListGeofenceResponseEntry) GoString 

func (s ListGeofenceResponseEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGeofenceResponseEntry) SetCreateTime 

func (s *ListGeofenceResponseEntry) SetCreateTime(v time.Time) *ListGeofenceResponseEntry

SetCreateTime sets the CreateTime field's value.

func (*ListGeofenceResponseEntry) SetGeofenceId 

func (s *ListGeofenceResponseEntry) SetGeofenceId(v string) *ListGeofenceResponseEntry

SetGeofenceId sets the GeofenceId field's value.

func (*ListGeofenceResponseEntry) SetGeofenceProperties added in v1.44.283 

func (s *ListGeofenceResponseEntry) SetGeofenceProperties(v map[string]*string) *ListGeofenceResponseEntry

SetGeofenceProperties sets the GeofenceProperties field's value.

func (*ListGeofenceResponseEntry) SetGeometry 

func (s *ListGeofenceResponseEntry) SetGeometry(v *GeofenceGeometry) *ListGeofenceResponseEntry

SetGeometry sets the Geometry field's value.

func (*ListGeofenceResponseEntry) SetStatus 

func (s *ListGeofenceResponseEntry) SetStatus(v string) *ListGeofenceResponseEntry

SetStatus sets the Status field's value.

func (*ListGeofenceResponseEntry) SetUpdateTime 

func (s *ListGeofenceResponseEntry) SetUpdateTime(v time.Time) *ListGeofenceResponseEntry

SetUpdateTime sets the UpdateTime field's value.

func (ListGeofenceResponseEntry) String 

func (s ListGeofenceResponseEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListGeofencesInput 

type ListGeofencesInput struct {

	// The name of the geofence collection storing the list of geofences.
	//
	// CollectionName is a required field
	CollectionName *string `location:"uri" locationName:"CollectionName" min:"1" type:"string" required:"true"`

	// An optional limit for the number of geofences returned in a single call.
	//
	// Default value: 100
	MaxResults *int64 `min:"1" type:"integer"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListGeofencesInput) GoString 

func (s ListGeofencesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGeofencesInput) SetCollectionName 

func (s *ListGeofencesInput) SetCollectionName(v string) *ListGeofencesInput

SetCollectionName sets the CollectionName field's value.

func (*ListGeofencesInput) SetMaxResults added in v1.44.9 

func (s *ListGeofencesInput) SetMaxResults(v int64) *ListGeofencesInput

SetMaxResults sets the MaxResults field's value.

func (*ListGeofencesInput) SetNextToken 

func (s *ListGeofencesInput) SetNextToken(v string) *ListGeofencesInput

SetNextToken sets the NextToken field's value.

func (ListGeofencesInput) String 

func (s ListGeofencesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGeofencesInput) Validate 

func (s *ListGeofencesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListGeofencesOutput 

type ListGeofencesOutput struct {

	// Contains a list of geofences stored in the geofence collection.
	//
	// Entries is a required field
	Entries []*ListGeofenceResponseEntry `type:"list" required:"true"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListGeofencesOutput) GoString 

func (s ListGeofencesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGeofencesOutput) SetEntries 

func (s *ListGeofencesOutput) SetEntries(v []*ListGeofenceResponseEntry) *ListGeofencesOutput

SetEntries sets the Entries field's value.

func (*ListGeofencesOutput) SetNextToken 

func (s *ListGeofencesOutput) SetNextToken(v string) *ListGeofencesOutput

SetNextToken sets the NextToken field's value.

func (ListGeofencesOutput) String 

func (s ListGeofencesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListKeysInput added in v1.44.208 

type ListKeysInput struct {

	// Optionally filter the list to only Active or Expired API keys.
	Filter *ApiKeyFilter `type:"structure"`

	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 100
	MaxResults *int64 `min:"1" type:"integer"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListKeysInput) GoString added in v1.44.208 

func (s ListKeysInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListKeysInput) SetFilter added in v1.44.208 

func (s *ListKeysInput) SetFilter(v *ApiKeyFilter) *ListKeysInput

SetFilter sets the Filter field's value.

func (*ListKeysInput) SetMaxResults added in v1.44.208 

func (s *ListKeysInput) SetMaxResults(v int64) *ListKeysInput

SetMaxResults sets the MaxResults field's value.

func (*ListKeysInput) SetNextToken added in v1.44.208 

func (s *ListKeysInput) SetNextToken(v string) *ListKeysInput

SetNextToken sets the NextToken field's value.

func (ListKeysInput) String added in v1.44.208 

func (s ListKeysInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListKeysInput) Validate added in v1.44.208 

func (s *ListKeysInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListKeysOutput added in v1.44.208 

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.
	//
	// Entries is a required field
	Entries []*ListKeysResponseEntry `type:"list" required:"true"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListKeysOutput) GoString added in v1.44.208 

func (s ListKeysOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListKeysOutput) SetEntries added in v1.44.208 

func (s *ListKeysOutput) SetEntries(v []*ListKeysResponseEntry) *ListKeysOutput

SetEntries sets the Entries field's value.

func (*ListKeysOutput) SetNextToken added in v1.44.208 

func (s *ListKeysOutput) SetNextToken(v string) *ListKeysOutput

SetNextToken sets the NextToken field's value.

func (ListKeysOutput) String added in v1.44.208 

func (s ListKeysOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListKeysResponseEntry added in v1.44.208 

type ListKeysResponseEntry struct {

	// The timestamp of when the API key was created, in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html)
	// format: YYYY-MM-DDThh:mm:ss.sssZ.
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The optional description for the API key resource.
	Description *string `type:"string"`

	// The timestamp for when the API key resource will expire, in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html)
	// format: YYYY-MM-DDThh:mm:ss.sssZ.
	//
	// ExpireTime is a required field
	ExpireTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The name of the API key resource.
	//
	// KeyName is a required field
	KeyName *string `min:"1" type:"string" required:"true"`

	// API Restrictions on the allowed actions, resources, and referers for an API
	// key resource.
	//
	// Restrictions is a required field
	Restrictions *ApiKeyRestrictions `type:"structure" required:"true"`

	// The timestamp of when the API key was last updated, in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html)
	// format: YYYY-MM-DDThh:mm:ss.sssZ.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

An API key resource listed in your Amazon Web Services account.

func (ListKeysResponseEntry) GoString added in v1.44.208 

func (s ListKeysResponseEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListKeysResponseEntry) SetCreateTime added in v1.44.208 

func (s *ListKeysResponseEntry) SetCreateTime(v time.Time) *ListKeysResponseEntry

SetCreateTime sets the CreateTime field's value.

func (*ListKeysResponseEntry) SetDescription added in v1.44.208 

func (s *ListKeysResponseEntry) SetDescription(v string) *ListKeysResponseEntry

SetDescription sets the Description field's value.

func (*ListKeysResponseEntry) SetExpireTime added in v1.44.208 

func (s *ListKeysResponseEntry) SetExpireTime(v time.Time) *ListKeysResponseEntry

SetExpireTime sets the ExpireTime field's value.

func (*ListKeysResponseEntry) SetKeyName added in v1.44.208 

func (s *ListKeysResponseEntry) SetKeyName(v string) *ListKeysResponseEntry

SetKeyName sets the KeyName field's value.

func (*ListKeysResponseEntry) SetRestrictions added in v1.44.208 

func (s *ListKeysResponseEntry) SetRestrictions(v *ApiKeyRestrictions) *ListKeysResponseEntry

SetRestrictions sets the Restrictions field's value.

func (*ListKeysResponseEntry) SetUpdateTime added in v1.44.208 

func (s *ListKeysResponseEntry) SetUpdateTime(v time.Time) *ListKeysResponseEntry

SetUpdateTime sets the UpdateTime field's value.

func (ListKeysResponseEntry) String added in v1.44.208 

func (s ListKeysResponseEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListMapsInput 

type ListMapsInput struct {

	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 100
	MaxResults *int64 `min:"1" type:"integer"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListMapsInput) GoString 

func (s ListMapsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMapsInput) SetMaxResults 

func (s *ListMapsInput) SetMaxResults(v int64) *ListMapsInput

SetMaxResults sets the MaxResults field's value.

func (*ListMapsInput) SetNextToken 

func (s *ListMapsInput) SetNextToken(v string) *ListMapsInput

SetNextToken sets the NextToken field's value.

func (ListMapsInput) String 

func (s ListMapsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMapsInput) Validate 

func (s *ListMapsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListMapsOutput 

type ListMapsOutput struct {

	// Contains a list of maps in your Amazon Web Services account
	//
	// Entries is a required field
	Entries []*ListMapsResponseEntry `type:"list" required:"true"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListMapsOutput) GoString 

func (s ListMapsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMapsOutput) SetEntries 

func (s *ListMapsOutput) SetEntries(v []*ListMapsResponseEntry) *ListMapsOutput

SetEntries sets the Entries field's value.

func (*ListMapsOutput) SetNextToken 

func (s *ListMapsOutput) SetNextToken(v string) *ListMapsOutput

SetNextToken sets the NextToken field's value.

func (ListMapsOutput) String 

func (s ListMapsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListMapsResponseEntry 

type ListMapsResponseEntry 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.
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// Specifies the data provider for the associated map tiles.
	//
	// DataSource is a required field
	DataSource *string `type:"string" required:"true"`

	// The description for the map resource.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// The name of the associated map resource.
	//
	// MapName is a required field
	MapName *string `min:"1" type:"string" required:"true"`

	// No longer used. Always returns RequestBasedUsage.
	//
	// Deprecated: Deprecated. Always returns RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"`

	// The timestamp for when the map 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.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains details of an existing map resource in your Amazon Web Services account.

func (ListMapsResponseEntry) GoString 

func (s ListMapsResponseEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMapsResponseEntry) SetCreateTime 

func (s *ListMapsResponseEntry) SetCreateTime(v time.Time) *ListMapsResponseEntry

SetCreateTime sets the CreateTime field's value.

func (*ListMapsResponseEntry) SetDataSource 

func (s *ListMapsResponseEntry) SetDataSource(v string) *ListMapsResponseEntry

SetDataSource sets the DataSource field's value.

func (*ListMapsResponseEntry) SetDescription 

func (s *ListMapsResponseEntry) SetDescription(v string) *ListMapsResponseEntry

SetDescription sets the Description field's value.

func (*ListMapsResponseEntry) SetMapName 

func (s *ListMapsResponseEntry) SetMapName(v string) *ListMapsResponseEntry

SetMapName sets the MapName field's value.

func (*ListMapsResponseEntry) SetPricingPlan added in v1.38.8 

func (s *ListMapsResponseEntry) SetPricingPlan(v string) *ListMapsResponseEntry

SetPricingPlan sets the PricingPlan field's value.

func (*ListMapsResponseEntry) SetUpdateTime 

func (s *ListMapsResponseEntry) SetUpdateTime(v time.Time) *ListMapsResponseEntry

SetUpdateTime sets the UpdateTime field's value.

func (ListMapsResponseEntry) String 

func (s ListMapsResponseEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListPlaceIndexesInput 

type ListPlaceIndexesInput struct {

	// An optional limit for the maximum number of results returned in a single
	// call.
	//
	// Default value: 100
	MaxResults *int64 `min:"1" type:"integer"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListPlaceIndexesInput) GoString 

func (s ListPlaceIndexesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPlaceIndexesInput) SetMaxResults 

func (s *ListPlaceIndexesInput) SetMaxResults(v int64) *ListPlaceIndexesInput

SetMaxResults sets the MaxResults field's value.

func (*ListPlaceIndexesInput) SetNextToken 

func (s *ListPlaceIndexesInput) SetNextToken(v string) *ListPlaceIndexesInput

SetNextToken sets the NextToken field's value.

func (ListPlaceIndexesInput) String 

func (s ListPlaceIndexesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPlaceIndexesInput) Validate 

func (s *ListPlaceIndexesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPlaceIndexesOutput 

type ListPlaceIndexesOutput struct {

	// Lists the place index resources that exist in your Amazon Web Services account
	//
	// Entries is a required field
	Entries []*ListPlaceIndexesResponseEntry `type:"list" required:"true"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListPlaceIndexesOutput) GoString 

func (s ListPlaceIndexesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPlaceIndexesOutput) SetEntries 

func (s *ListPlaceIndexesOutput) SetEntries(v []*ListPlaceIndexesResponseEntry) *ListPlaceIndexesOutput

SetEntries sets the Entries field's value.

func (*ListPlaceIndexesOutput) SetNextToken 

func (s *ListPlaceIndexesOutput) SetNextToken(v string) *ListPlaceIndexesOutput

SetNextToken sets the NextToken field's value.

func (ListPlaceIndexesOutput) String 

func (s ListPlaceIndexesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListPlaceIndexesResponseEntry 

type ListPlaceIndexesResponseEntry 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.
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// 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 (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html).
	//
	// DataSource is a required field
	DataSource *string `type:"string" required:"true"`

	// The optional description for the place index resource.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// The name of the place index resource.
	//
	// IndexName is a required field
	IndexName *string `min:"1" type:"string" required:"true"`

	// No longer used. Always returns RequestBasedUsage.
	//
	// Deprecated: Deprecated. Always returns RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"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.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

A place index resource listed in your Amazon Web Services account.

func (ListPlaceIndexesResponseEntry) GoString 

func (s ListPlaceIndexesResponseEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPlaceIndexesResponseEntry) SetCreateTime 

func (s *ListPlaceIndexesResponseEntry) SetCreateTime(v time.Time) *ListPlaceIndexesResponseEntry

SetCreateTime sets the CreateTime field's value.

func (*ListPlaceIndexesResponseEntry) SetDataSource 

func (s *ListPlaceIndexesResponseEntry) SetDataSource(v string) *ListPlaceIndexesResponseEntry

SetDataSource sets the DataSource field's value.

func (*ListPlaceIndexesResponseEntry) SetDescription 

func (s *ListPlaceIndexesResponseEntry) SetDescription(v string) *ListPlaceIndexesResponseEntry

SetDescription sets the Description field's value.

func (*ListPlaceIndexesResponseEntry) SetIndexName 

func (s *ListPlaceIndexesResponseEntry) SetIndexName(v string) *ListPlaceIndexesResponseEntry

SetIndexName sets the IndexName field's value.

func (*ListPlaceIndexesResponseEntry) SetPricingPlan added in v1.38.8 

func (s *ListPlaceIndexesResponseEntry) SetPricingPlan(v string) *ListPlaceIndexesResponseEntry

SetPricingPlan sets the PricingPlan field's value.

func (*ListPlaceIndexesResponseEntry) SetUpdateTime 

func (s *ListPlaceIndexesResponseEntry) SetUpdateTime(v time.Time) *ListPlaceIndexesResponseEntry

SetUpdateTime sets the UpdateTime field's value.

func (ListPlaceIndexesResponseEntry) String 

func (s ListPlaceIndexesResponseEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListRouteCalculatorsInput added in v1.38.51 

type ListRouteCalculatorsInput struct {

	// An optional maximum number of results returned in a single call.
	//
	// Default Value: 100
	MaxResults *int64 `min:"1" type:"integer"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListRouteCalculatorsInput) GoString added in v1.38.51 

func (s ListRouteCalculatorsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRouteCalculatorsInput) SetMaxResults added in v1.38.51 

func (s *ListRouteCalculatorsInput) SetMaxResults(v int64) *ListRouteCalculatorsInput

SetMaxResults sets the MaxResults field's value.

func (*ListRouteCalculatorsInput) SetNextToken added in v1.38.51 

func (s *ListRouteCalculatorsInput) SetNextToken(v string) *ListRouteCalculatorsInput

SetNextToken sets the NextToken field's value.

func (ListRouteCalculatorsInput) String added in v1.38.51 

func (s ListRouteCalculatorsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRouteCalculatorsInput) Validate added in v1.38.51 

func (s *ListRouteCalculatorsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListRouteCalculatorsOutput added in v1.38.51 

type ListRouteCalculatorsOutput struct {

	// Lists the route calculator resources that exist in your Amazon Web Services
	// account
	//
	// Entries is a required field
	Entries []*ListRouteCalculatorsResponseEntry `type:"list" required:"true"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListRouteCalculatorsOutput) GoString added in v1.38.51 

func (s ListRouteCalculatorsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRouteCalculatorsOutput) SetEntries added in v1.38.51 

func (s *ListRouteCalculatorsOutput) SetEntries(v []*ListRouteCalculatorsResponseEntry) *ListRouteCalculatorsOutput

SetEntries sets the Entries field's value.

func (*ListRouteCalculatorsOutput) SetNextToken added in v1.38.51 

func (s *ListRouteCalculatorsOutput) SetNextToken(v string) *ListRouteCalculatorsOutput

SetNextToken sets the NextToken field's value.

func (ListRouteCalculatorsOutput) String added in v1.38.51 

func (s ListRouteCalculatorsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListRouteCalculatorsResponseEntry added in v1.38.51 

type ListRouteCalculatorsResponseEntry struct {

	// The name of the route calculator resource.
	//
	// CalculatorName is a required field
	CalculatorName *string `min:"1" type:"string" required:"true"`

	// The timestamp when the route calculator resource was created in ISO 8601
	// (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ.
	//
	//    * For example, 2020–07-2T12:15:20.000Z+01:00
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// 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 (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html).
	//
	// DataSource is a required field
	DataSource *string `type:"string" required:"true"`

	// The optional description of the route calculator resource.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// Always returns RequestBasedUsage.
	//
	// Deprecated: Deprecated. Always returns RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"`

	// The timestamp when the route calculator 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.
	//
	//    * For example, 2020–07-2T12:15:20.000Z+01:00
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

A route calculator resource listed in your Amazon Web Services account.

func (ListRouteCalculatorsResponseEntry) GoString added in v1.38.51 

func (s ListRouteCalculatorsResponseEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRouteCalculatorsResponseEntry) SetCalculatorName added in v1.38.51 

func (s *ListRouteCalculatorsResponseEntry) SetCalculatorName(v string) *ListRouteCalculatorsResponseEntry

SetCalculatorName sets the CalculatorName field's value.

func (*ListRouteCalculatorsResponseEntry) SetCreateTime added in v1.38.51 

func (s *ListRouteCalculatorsResponseEntry) SetCreateTime(v time.Time) *ListRouteCalculatorsResponseEntry

SetCreateTime sets the CreateTime field's value.

func (*ListRouteCalculatorsResponseEntry) SetDataSource added in v1.38.51 

func (s *ListRouteCalculatorsResponseEntry) SetDataSource(v string) *ListRouteCalculatorsResponseEntry

SetDataSource sets the DataSource field's value.

func (*ListRouteCalculatorsResponseEntry) SetDescription added in v1.38.51 

func (s *ListRouteCalculatorsResponseEntry) SetDescription(v string) *ListRouteCalculatorsResponseEntry

SetDescription sets the Description field's value.

func (*ListRouteCalculatorsResponseEntry) SetPricingPlan added in v1.38.51 

func (s *ListRouteCalculatorsResponseEntry) SetPricingPlan(v string) *ListRouteCalculatorsResponseEntry

SetPricingPlan sets the PricingPlan field's value.

func (*ListRouteCalculatorsResponseEntry) SetUpdateTime added in v1.38.51 

func (s *ListRouteCalculatorsResponseEntry) SetUpdateTime(v time.Time) *ListRouteCalculatorsResponseEntry

SetUpdateTime sets the UpdateTime field's value.

func (ListRouteCalculatorsResponseEntry) String added in v1.38.51 

func (s ListRouteCalculatorsResponseEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.38.51 

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
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.38.51 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn added in v1.38.51 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.38.51 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.38.51 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.38.51 

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 `type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.38.51 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.38.51 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.38.51 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTrackerConsumersInput 

type ListTrackerConsumersInput struct {

	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 100
	MaxResults *int64 `min:"1" type:"integer"`

	// 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 `min:"1" type:"string"`

	// The tracker resource whose associated geofence collections you want to list.
	//
	// TrackerName is a required field
	TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTrackerConsumersInput) GoString 

func (s ListTrackerConsumersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTrackerConsumersInput) SetMaxResults 

func (s *ListTrackerConsumersInput) SetMaxResults(v int64) *ListTrackerConsumersInput

SetMaxResults sets the MaxResults field's value.

func (*ListTrackerConsumersInput) SetNextToken 

func (s *ListTrackerConsumersInput) SetNextToken(v string) *ListTrackerConsumersInput

SetNextToken sets the NextToken field's value.

func (*ListTrackerConsumersInput) SetTrackerName 

func (s *ListTrackerConsumersInput) SetTrackerName(v string) *ListTrackerConsumersInput

SetTrackerName sets the TrackerName field's value.

func (ListTrackerConsumersInput) String 

func (s ListTrackerConsumersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTrackerConsumersInput) Validate 

func (s *ListTrackerConsumersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTrackerConsumersOutput 

type ListTrackerConsumersOutput struct {

	// Contains the list of geofence collection ARNs associated to the tracker resource.
	//
	// ConsumerArns is a required field
	ConsumerArns []*string `type:"list" required:"true"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListTrackerConsumersOutput) GoString 

func (s ListTrackerConsumersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTrackerConsumersOutput) SetConsumerArns 

func (s *ListTrackerConsumersOutput) SetConsumerArns(v []*string) *ListTrackerConsumersOutput

SetConsumerArns sets the ConsumerArns field's value.

func (*ListTrackerConsumersOutput) SetNextToken 

func (s *ListTrackerConsumersOutput) SetNextToken(v string) *ListTrackerConsumersOutput

SetNextToken sets the NextToken field's value.

func (ListTrackerConsumersOutput) String 

func (s ListTrackerConsumersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTrackersInput 

type ListTrackersInput struct {

	// An optional limit for the number of resources returned in a single call.
	//
	// Default value: 100
	MaxResults *int64 `min:"1" type:"integer"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListTrackersInput) GoString 

func (s ListTrackersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTrackersInput) SetMaxResults 

func (s *ListTrackersInput) SetMaxResults(v int64) *ListTrackersInput

SetMaxResults sets the MaxResults field's value.

func (*ListTrackersInput) SetNextToken 

func (s *ListTrackersInput) SetNextToken(v string) *ListTrackersInput

SetNextToken sets the NextToken field's value.

func (ListTrackersInput) String 

func (s ListTrackersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTrackersInput) Validate 

func (s *ListTrackersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.
	//
	// Entries is a required field
	Entries []*ListTrackersResponseEntry `type:"list" required:"true"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListTrackersOutput) GoString 

func (s ListTrackersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTrackersOutput) SetEntries 

func (s *ListTrackersOutput) SetEntries(v []*ListTrackersResponseEntry) *ListTrackersOutput

SetEntries sets the Entries field's value.

func (*ListTrackersOutput) SetNextToken 

func (s *ListTrackersOutput) SetNextToken(v string) *ListTrackersOutput

SetNextToken sets the NextToken field's value.

func (ListTrackersOutput) String 

func (s ListTrackersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTrackersResponseEntry 

type ListTrackersResponseEntry 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.
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description for the tracker resource.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// Always returns RequestBasedUsage.
	//
	// Deprecated: Deprecated. Always returns RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"`

	// No longer used. Always returns an empty string.
	//
	// Deprecated: Deprecated. Unused.
	PricingPlanDataSource *string `deprecated:"true" type:"string"`

	// The name of the tracker resource.
	//
	// TrackerName is a required field
	TrackerName *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains the tracker resource details.

func (ListTrackersResponseEntry) GoString 

func (s ListTrackersResponseEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTrackersResponseEntry) SetCreateTime 

func (s *ListTrackersResponseEntry) SetCreateTime(v time.Time) *ListTrackersResponseEntry

SetCreateTime sets the CreateTime field's value.

func (*ListTrackersResponseEntry) SetDescription 

func (s *ListTrackersResponseEntry) SetDescription(v string) *ListTrackersResponseEntry

SetDescription sets the Description field's value.

func (*ListTrackersResponseEntry) SetPricingPlan added in v1.38.8 

func (s *ListTrackersResponseEntry) SetPricingPlan(v string) *ListTrackersResponseEntry

SetPricingPlan sets the PricingPlan field's value.

func (*ListTrackersResponseEntry) SetPricingPlanDataSource added in v1.38.8 

func (s *ListTrackersResponseEntry) SetPricingPlanDataSource(v string) *ListTrackersResponseEntry

SetPricingPlanDataSource sets the PricingPlanDataSource field's value.

func (*ListTrackersResponseEntry) SetTrackerName 

func (s *ListTrackersResponseEntry) SetTrackerName(v string) *ListTrackersResponseEntry

SetTrackerName sets the TrackerName field's value.

func (*ListTrackersResponseEntry) SetUpdateTime 

func (s *ListTrackersResponseEntry) SetUpdateTime(v time.Time) *ListTrackersResponseEntry

SetUpdateTime sets the UpdateTime field's value.

func (ListTrackersResponseEntry) String 

func (s ListTrackersResponseEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LocationService 

type LocationService struct {
	*client.Client
}

LocationService provides the API operation methods for making requests to Amazon Location Service. See this package's package overview docs for details on the service.

LocationService methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *LocationService

New creates a new instance of the LocationService client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a LocationService client from just a session.
svc := locationservice.New(mySession)

// Create a LocationService client with additional configuration
svc := locationservice.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*LocationService) AssociateTrackerConsumer 

func (c *LocationService) AssociateTrackerConsumer(input *AssociateTrackerConsumerInput) (*AssociateTrackerConsumerOutput, error)

AssociateTrackerConsumer API operation for Amazon Location Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation AssociateTrackerConsumer for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • ConflictException The request was unsuccessful because of a conflict.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ServiceQuotaExceededException The operation was denied because the request would exceed the maximum quota (https://docs.aws.amazon.com/location/latest/developerguide/location-quotas.html) set for Amazon Location Service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/AssociateTrackerConsumer

func (*LocationService) AssociateTrackerConsumerRequest 

func (c *LocationService) AssociateTrackerConsumerRequest(input *AssociateTrackerConsumerInput) (req *request.Request, output *AssociateTrackerConsumerOutput)

AssociateTrackerConsumerRequest generates a "aws/request.Request" representing the client's request for the AssociateTrackerConsumer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateTrackerConsumer for more information on using the AssociateTrackerConsumer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateTrackerConsumerRequest method.
req, resp := client.AssociateTrackerConsumerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/AssociateTrackerConsumer

func (*LocationService) AssociateTrackerConsumerWithContext 

func (c *LocationService) AssociateTrackerConsumerWithContext(ctx aws.Context, input *AssociateTrackerConsumerInput, opts ...request.Option) (*AssociateTrackerConsumerOutput, error)

AssociateTrackerConsumerWithContext is the same as AssociateTrackerConsumer with the addition of the ability to pass a context and additional request options.

See AssociateTrackerConsumer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) BatchDeleteDevicePositionHistory added in v1.38.51 

func (c *LocationService) BatchDeleteDevicePositionHistory(input *BatchDeleteDevicePositionHistoryInput) (*BatchDeleteDevicePositionHistoryOutput, error)

BatchDeleteDevicePositionHistory API operation for Amazon Location Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation BatchDeleteDevicePositionHistory for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchDeleteDevicePositionHistory

func (*LocationService) BatchDeleteDevicePositionHistoryRequest added in v1.38.51 

func (c *LocationService) BatchDeleteDevicePositionHistoryRequest(input *BatchDeleteDevicePositionHistoryInput) (req *request.Request, output *BatchDeleteDevicePositionHistoryOutput)

BatchDeleteDevicePositionHistoryRequest generates a "aws/request.Request" representing the client's request for the BatchDeleteDevicePositionHistory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchDeleteDevicePositionHistory for more information on using the BatchDeleteDevicePositionHistory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchDeleteDevicePositionHistoryRequest method.
req, resp := client.BatchDeleteDevicePositionHistoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchDeleteDevicePositionHistory

func (*LocationService) BatchDeleteDevicePositionHistoryWithContext added in v1.38.51 

func (c *LocationService) BatchDeleteDevicePositionHistoryWithContext(ctx aws.Context, input *BatchDeleteDevicePositionHistoryInput, opts ...request.Option) (*BatchDeleteDevicePositionHistoryOutput, error)

BatchDeleteDevicePositionHistoryWithContext is the same as BatchDeleteDevicePositionHistory with the addition of the ability to pass a context and additional request options.

See BatchDeleteDevicePositionHistory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) BatchDeleteGeofence 

func (c *LocationService) BatchDeleteGeofence(input *BatchDeleteGeofenceInput) (*BatchDeleteGeofenceOutput, error)

BatchDeleteGeofence API operation for Amazon Location Service.

Deletes a batch of geofences from a geofence collection.

This operation deletes the resource permanently.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation BatchDeleteGeofence for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchDeleteGeofence

func (*LocationService) BatchDeleteGeofenceRequest 

func (c *LocationService) BatchDeleteGeofenceRequest(input *BatchDeleteGeofenceInput) (req *request.Request, output *BatchDeleteGeofenceOutput)

BatchDeleteGeofenceRequest generates a "aws/request.Request" representing the client's request for the BatchDeleteGeofence operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchDeleteGeofence for more information on using the BatchDeleteGeofence API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchDeleteGeofenceRequest method.
req, resp := client.BatchDeleteGeofenceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchDeleteGeofence

func (*LocationService) BatchDeleteGeofenceWithContext 

func (c *LocationService) BatchDeleteGeofenceWithContext(ctx aws.Context, input *BatchDeleteGeofenceInput, opts ...request.Option) (*BatchDeleteGeofenceOutput, error)

BatchDeleteGeofenceWithContext is the same as BatchDeleteGeofence with the addition of the ability to pass a context and additional request options.

See BatchDeleteGeofence for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) BatchEvaluateGeofences 

func (c *LocationService) BatchEvaluateGeofences(input *BatchEvaluateGeofencesInput) (*BatchEvaluateGeofencesOutput, error)

BatchEvaluateGeofences API operation for Amazon Location Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation BatchEvaluateGeofences for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchEvaluateGeofences

func (*LocationService) BatchEvaluateGeofencesRequest 

func (c *LocationService) BatchEvaluateGeofencesRequest(input *BatchEvaluateGeofencesInput) (req *request.Request, output *BatchEvaluateGeofencesOutput)

BatchEvaluateGeofencesRequest generates a "aws/request.Request" representing the client's request for the BatchEvaluateGeofences operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchEvaluateGeofences for more information on using the BatchEvaluateGeofences API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchEvaluateGeofencesRequest method.
req, resp := client.BatchEvaluateGeofencesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchEvaluateGeofences

func (*LocationService) BatchEvaluateGeofencesWithContext 

func (c *LocationService) BatchEvaluateGeofencesWithContext(ctx aws.Context, input *BatchEvaluateGeofencesInput, opts ...request.Option) (*BatchEvaluateGeofencesOutput, error)

BatchEvaluateGeofencesWithContext is the same as BatchEvaluateGeofences with the addition of the ability to pass a context and additional request options.

See BatchEvaluateGeofences for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) BatchGetDevicePosition 

func (c *LocationService) BatchGetDevicePosition(input *BatchGetDevicePositionInput) (*BatchGetDevicePositionOutput, error)

BatchGetDevicePosition API operation for Amazon Location Service.

Lists the latest device positions for requested devices.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation BatchGetDevicePosition for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchGetDevicePosition

func (*LocationService) BatchGetDevicePositionRequest 

func (c *LocationService) BatchGetDevicePositionRequest(input *BatchGetDevicePositionInput) (req *request.Request, output *BatchGetDevicePositionOutput)

BatchGetDevicePositionRequest generates a "aws/request.Request" representing the client's request for the BatchGetDevicePosition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchGetDevicePosition for more information on using the BatchGetDevicePosition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchGetDevicePositionRequest method.
req, resp := client.BatchGetDevicePositionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchGetDevicePosition

func (*LocationService) BatchGetDevicePositionWithContext 

func (c *LocationService) BatchGetDevicePositionWithContext(ctx aws.Context, input *BatchGetDevicePositionInput, opts ...request.Option) (*BatchGetDevicePositionOutput, error)

BatchGetDevicePositionWithContext is the same as BatchGetDevicePosition with the addition of the ability to pass a context and additional request options.

See BatchGetDevicePosition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) BatchPutGeofence 

func (c *LocationService) BatchPutGeofence(input *BatchPutGeofenceInput) (*BatchPutGeofenceOutput, error)

BatchPutGeofence API operation for Amazon Location Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation BatchPutGeofence for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchPutGeofence

func (*LocationService) BatchPutGeofenceRequest 

func (c *LocationService) BatchPutGeofenceRequest(input *BatchPutGeofenceInput) (req *request.Request, output *BatchPutGeofenceOutput)

BatchPutGeofenceRequest generates a "aws/request.Request" representing the client's request for the BatchPutGeofence operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchPutGeofence for more information on using the BatchPutGeofence API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchPutGeofenceRequest method.
req, resp := client.BatchPutGeofenceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchPutGeofence

func (*LocationService) BatchPutGeofenceWithContext 

func (c *LocationService) BatchPutGeofenceWithContext(ctx aws.Context, input *BatchPutGeofenceInput, opts ...request.Option) (*BatchPutGeofenceOutput, error)

BatchPutGeofenceWithContext is the same as BatchPutGeofence with the addition of the ability to pass a context and additional request options.

See BatchPutGeofence for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) BatchUpdateDevicePosition 

func (c *LocationService) BatchUpdateDevicePosition(input *BatchUpdateDevicePositionInput) (*BatchUpdateDevicePositionOutput, error)

BatchUpdateDevicePosition API operation for Amazon Location Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation BatchUpdateDevicePosition for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchUpdateDevicePosition

func (*LocationService) BatchUpdateDevicePositionRequest 

func (c *LocationService) BatchUpdateDevicePositionRequest(input *BatchUpdateDevicePositionInput) (req *request.Request, output *BatchUpdateDevicePositionOutput)

BatchUpdateDevicePositionRequest generates a "aws/request.Request" representing the client's request for the BatchUpdateDevicePosition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchUpdateDevicePosition for more information on using the BatchUpdateDevicePosition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchUpdateDevicePositionRequest method.
req, resp := client.BatchUpdateDevicePositionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchUpdateDevicePosition

func (*LocationService) BatchUpdateDevicePositionWithContext 

func (c *LocationService) BatchUpdateDevicePositionWithContext(ctx aws.Context, input *BatchUpdateDevicePositionInput, opts ...request.Option) (*BatchUpdateDevicePositionOutput, error)

BatchUpdateDevicePositionWithContext is the same as BatchUpdateDevicePosition with the addition of the ability to pass a context and additional request options.

See BatchUpdateDevicePosition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) CalculateRoute added in v1.38.51 

func (c *LocationService) CalculateRoute(input *CalculateRouteInput) (*CalculateRouteOutput, error)

CalculateRoute API operation for Amazon Location Service.

Calculates a route (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html) given the following required parameters: DeparturePosition and DestinationPosition. Requires that you first create a route calculator resource (https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html).

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 (https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html) 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 (https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html) 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation CalculateRoute for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRoute

func (*LocationService) CalculateRouteMatrix added in v1.42.36 

func (c *LocationService) CalculateRouteMatrix(input *CalculateRouteMatrixInput) (*CalculateRouteMatrixOutput, error)

CalculateRouteMatrix API operation for Amazon Location Service. 

Calculates a route matrix (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html)
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 (https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html).

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:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation CalculateRouteMatrix for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteMatrix

func (*LocationService) CalculateRouteMatrixRequest added in v1.42.36 

func (c *LocationService) CalculateRouteMatrixRequest(input *CalculateRouteMatrixInput) (req *request.Request, output *CalculateRouteMatrixOutput)

CalculateRouteMatrixRequest generates a "aws/request.Request" representing the client's request for the CalculateRouteMatrix operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CalculateRouteMatrix for more information on using the CalculateRouteMatrix API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CalculateRouteMatrixRequest method.
req, resp := client.CalculateRouteMatrixRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteMatrix

func (*LocationService) CalculateRouteMatrixWithContext added in v1.42.36 

func (c *LocationService) CalculateRouteMatrixWithContext(ctx aws.Context, input *CalculateRouteMatrixInput, opts ...request.Option) (*CalculateRouteMatrixOutput, error)

CalculateRouteMatrixWithContext is the same as CalculateRouteMatrix with the addition of the ability to pass a context and additional request options.

See CalculateRouteMatrix for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) CalculateRouteRequest added in v1.38.51 

func (c *LocationService) CalculateRouteRequest(input *CalculateRouteInput) (req *request.Request, output *CalculateRouteOutput)

CalculateRouteRequest generates a "aws/request.Request" representing the client's request for the CalculateRoute operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CalculateRoute for more information on using the CalculateRoute API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CalculateRouteRequest method.
req, resp := client.CalculateRouteRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRoute

func (*LocationService) CalculateRouteWithContext added in v1.38.51 

func (c *LocationService) CalculateRouteWithContext(ctx aws.Context, input *CalculateRouteInput, opts ...request.Option) (*CalculateRouteOutput, error)

CalculateRouteWithContext is the same as CalculateRoute with the addition of the ability to pass a context and additional request options.

See CalculateRoute for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) CreateGeofenceCollection 

func (c *LocationService) CreateGeofenceCollection(input *CreateGeofenceCollectionInput) (*CreateGeofenceCollectionOutput, error)

CreateGeofenceCollection API operation for Amazon Location Service.

Creates a geofence collection, which manages and stores geofences.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation CreateGeofenceCollection for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ConflictException The request was unsuccessful because of a conflict.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ServiceQuotaExceededException The operation was denied because the request would exceed the maximum quota (https://docs.aws.amazon.com/location/latest/developerguide/location-quotas.html) set for Amazon Location Service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateGeofenceCollection

func (*LocationService) CreateGeofenceCollectionRequest 

func (c *LocationService) CreateGeofenceCollectionRequest(input *CreateGeofenceCollectionInput) (req *request.Request, output *CreateGeofenceCollectionOutput)

CreateGeofenceCollectionRequest generates a "aws/request.Request" representing the client's request for the CreateGeofenceCollection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateGeofenceCollection for more information on using the CreateGeofenceCollection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateGeofenceCollectionRequest method.
req, resp := client.CreateGeofenceCollectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateGeofenceCollection

func (*LocationService) CreateGeofenceCollectionWithContext 

func (c *LocationService) CreateGeofenceCollectionWithContext(ctx aws.Context, input *CreateGeofenceCollectionInput, opts ...request.Option) (*CreateGeofenceCollectionOutput, error)

CreateGeofenceCollectionWithContext is the same as CreateGeofenceCollection with the addition of the ability to pass a context and additional request options.

See CreateGeofenceCollection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) CreateKey added in v1.44.208 

func (c *LocationService) CreateKey(input *CreateKeyInput) (*CreateKeyOutput, error)

CreateKey API operation for Amazon Location Service.

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 (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation CreateKey for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ConflictException The request was unsuccessful because of a conflict.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ServiceQuotaExceededException The operation was denied because the request would exceed the maximum quota (https://docs.aws.amazon.com/location/latest/developerguide/location-quotas.html) set for Amazon Location Service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateKey

func (*LocationService) CreateKeyRequest added in v1.44.208 

func (c *LocationService) CreateKeyRequest(input *CreateKeyInput) (req *request.Request, output *CreateKeyOutput)

CreateKeyRequest generates a "aws/request.Request" representing the client's request for the CreateKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateKey for more information on using the CreateKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateKeyRequest method.
req, resp := client.CreateKeyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateKey

func (*LocationService) CreateKeyWithContext added in v1.44.208 

func (c *LocationService) CreateKeyWithContext(ctx aws.Context, input *CreateKeyInput, opts ...request.Option) (*CreateKeyOutput, error)

CreateKeyWithContext is the same as CreateKey with the addition of the ability to pass a context and additional request options.

See CreateKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) CreateMap 

func (c *LocationService) CreateMap(input *CreateMapInput) (*CreateMapOutput, error)

CreateMap API operation for Amazon Location Service.

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 terms (http://aws.amazon.com/service-terms) for more details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation CreateMap for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ConflictException The request was unsuccessful because of a conflict.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ServiceQuotaExceededException The operation was denied because the request would exceed the maximum quota (https://docs.aws.amazon.com/location/latest/developerguide/location-quotas.html) set for Amazon Location Service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateMap

func (*LocationService) CreateMapRequest 

func (c *LocationService) CreateMapRequest(input *CreateMapInput) (req *request.Request, output *CreateMapOutput)

CreateMapRequest generates a "aws/request.Request" representing the client's request for the CreateMap operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateMap for more information on using the CreateMap API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateMapRequest method.
req, resp := client.CreateMapRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateMap

func (*LocationService) CreateMapWithContext 

func (c *LocationService) CreateMapWithContext(ctx aws.Context, input *CreateMapInput, opts ...request.Option) (*CreateMapOutput, error)

CreateMapWithContext is the same as CreateMap with the addition of the ability to pass a context and additional request options.

See CreateMap for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) CreatePlaceIndex 

func (c *LocationService) CreatePlaceIndex(input *CreatePlaceIndexInput) (*CreatePlaceIndexOutput, error)

CreatePlaceIndex API operation for Amazon Location Service.

Creates a place index resource in your Amazon Web Services account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.

If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms (http://aws.amazon.com/service-terms) for more details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation CreatePlaceIndex for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ConflictException The request was unsuccessful because of a conflict.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ServiceQuotaExceededException The operation was denied because the request would exceed the maximum quota (https://docs.aws.amazon.com/location/latest/developerguide/location-quotas.html) set for Amazon Location Service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreatePlaceIndex

func (*LocationService) CreatePlaceIndexRequest 

func (c *LocationService) CreatePlaceIndexRequest(input *CreatePlaceIndexInput) (req *request.Request, output *CreatePlaceIndexOutput)

CreatePlaceIndexRequest generates a "aws/request.Request" representing the client's request for the CreatePlaceIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePlaceIndex for more information on using the CreatePlaceIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreatePlaceIndexRequest method.
req, resp := client.CreatePlaceIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreatePlaceIndex

func (*LocationService) CreatePlaceIndexWithContext 

func (c *LocationService) CreatePlaceIndexWithContext(ctx aws.Context, input *CreatePlaceIndexInput, opts ...request.Option) (*CreatePlaceIndexOutput, error)

CreatePlaceIndexWithContext is the same as CreatePlaceIndex with the addition of the ability to pass a context and additional request options.

See CreatePlaceIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) CreateRouteCalculator added in v1.38.51 

func (c *LocationService) CreateRouteCalculator(input *CreateRouteCalculatorInput) (*CreateRouteCalculatorOutput, error)

CreateRouteCalculator API operation for Amazon Location Service.

Creates a route calculator resource in your Amazon Web Services account.

You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.

If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms (http://aws.amazon.com/service-terms) for more details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation CreateRouteCalculator for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ConflictException The request was unsuccessful because of a conflict.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ServiceQuotaExceededException The operation was denied because the request would exceed the maximum quota (https://docs.aws.amazon.com/location/latest/developerguide/location-quotas.html) set for Amazon Location Service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateRouteCalculator

func (*LocationService) CreateRouteCalculatorRequest added in v1.38.51 

func (c *LocationService) CreateRouteCalculatorRequest(input *CreateRouteCalculatorInput) (req *request.Request, output *CreateRouteCalculatorOutput)

CreateRouteCalculatorRequest generates a "aws/request.Request" representing the client's request for the CreateRouteCalculator operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRouteCalculator for more information on using the CreateRouteCalculator API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateRouteCalculatorRequest method.
req, resp := client.CreateRouteCalculatorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateRouteCalculator

func (*LocationService) CreateRouteCalculatorWithContext added in v1.38.51 

func (c *LocationService) CreateRouteCalculatorWithContext(ctx aws.Context, input *CreateRouteCalculatorInput, opts ...request.Option) (*CreateRouteCalculatorOutput, error)

CreateRouteCalculatorWithContext is the same as CreateRouteCalculator with the addition of the ability to pass a context and additional request options.

See CreateRouteCalculator for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) CreateTracker 

func (c *LocationService) CreateTracker(input *CreateTrackerInput) (*CreateTrackerOutput, error)

CreateTracker API operation for Amazon Location Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation CreateTracker for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ConflictException The request was unsuccessful because of a conflict.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ServiceQuotaExceededException The operation was denied because the request would exceed the maximum quota (https://docs.aws.amazon.com/location/latest/developerguide/location-quotas.html) set for Amazon Location Service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateTracker

func (*LocationService) CreateTrackerRequest 

func (c *LocationService) CreateTrackerRequest(input *CreateTrackerInput) (req *request.Request, output *CreateTrackerOutput)

CreateTrackerRequest generates a "aws/request.Request" representing the client's request for the CreateTracker operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateTracker for more information on using the CreateTracker API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateTrackerRequest method.
req, resp := client.CreateTrackerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateTracker

func (*LocationService) CreateTrackerWithContext 

func (c *LocationService) CreateTrackerWithContext(ctx aws.Context, input *CreateTrackerInput, opts ...request.Option) (*CreateTrackerOutput, error)

CreateTrackerWithContext is the same as CreateTracker with the addition of the ability to pass a context and additional request options.

See CreateTracker for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) DeleteGeofenceCollection 

func (c *LocationService) DeleteGeofenceCollection(input *DeleteGeofenceCollectionInput) (*DeleteGeofenceCollectionOutput, error)

DeleteGeofenceCollection API operation for Amazon Location Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation DeleteGeofenceCollection for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteGeofenceCollection

func (*LocationService) DeleteGeofenceCollectionRequest 

func (c *LocationService) DeleteGeofenceCollectionRequest(input *DeleteGeofenceCollectionInput) (req *request.Request, output *DeleteGeofenceCollectionOutput)

DeleteGeofenceCollectionRequest generates a "aws/request.Request" representing the client's request for the DeleteGeofenceCollection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteGeofenceCollection for more information on using the DeleteGeofenceCollection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteGeofenceCollectionRequest method.
req, resp := client.DeleteGeofenceCollectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteGeofenceCollection

func (*LocationService) DeleteGeofenceCollectionWithContext 

func (c *LocationService) DeleteGeofenceCollectionWithContext(ctx aws.Context, input *DeleteGeofenceCollectionInput, opts ...request.Option) (*DeleteGeofenceCollectionOutput, error)

DeleteGeofenceCollectionWithContext is the same as DeleteGeofenceCollection with the addition of the ability to pass a context and additional request options.

See DeleteGeofenceCollection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) DeleteKey added in v1.44.208 

func (c *LocationService) DeleteKey(input *DeleteKeyInput) (*DeleteKeyOutput, error)

DeleteKey API operation for Amazon Location Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation DeleteKey for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteKey

func (*LocationService) DeleteKeyRequest added in v1.44.208 

func (c *LocationService) DeleteKeyRequest(input *DeleteKeyInput) (req *request.Request, output *DeleteKeyOutput)

DeleteKeyRequest generates a "aws/request.Request" representing the client's request for the DeleteKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteKey for more information on using the DeleteKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteKeyRequest method.
req, resp := client.DeleteKeyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteKey

func (*LocationService) DeleteKeyWithContext added in v1.44.208 

func (c *LocationService) DeleteKeyWithContext(ctx aws.Context, input *DeleteKeyInput, opts ...request.Option) (*DeleteKeyOutput, error)

DeleteKeyWithContext is the same as DeleteKey with the addition of the ability to pass a context and additional request options.

See DeleteKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) DeleteMap 

func (c *LocationService) DeleteMap(input *DeleteMapInput) (*DeleteMapOutput, error)

DeleteMap API operation for Amazon Location Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation DeleteMap for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteMap

func (*LocationService) DeleteMapRequest 

func (c *LocationService) DeleteMapRequest(input *DeleteMapInput) (req *request.Request, output *DeleteMapOutput)

DeleteMapRequest generates a "aws/request.Request" representing the client's request for the DeleteMap operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteMap for more information on using the DeleteMap API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteMapRequest method.
req, resp := client.DeleteMapRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteMap

func (*LocationService) DeleteMapWithContext 

func (c *LocationService) DeleteMapWithContext(ctx aws.Context, input *DeleteMapInput, opts ...request.Option) (*DeleteMapOutput, error)

DeleteMapWithContext is the same as DeleteMap with the addition of the ability to pass a context and additional request options.

See DeleteMap for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) DeletePlaceIndex 

func (c *LocationService) DeletePlaceIndex(input *DeletePlaceIndexInput) (*DeletePlaceIndexOutput, error)

DeletePlaceIndex API operation for Amazon Location Service.

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

This operation deletes the resource permanently.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation DeletePlaceIndex for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeletePlaceIndex

func (*LocationService) DeletePlaceIndexRequest 

func (c *LocationService) DeletePlaceIndexRequest(input *DeletePlaceIndexInput) (req *request.Request, output *DeletePlaceIndexOutput)

DeletePlaceIndexRequest generates a "aws/request.Request" representing the client's request for the DeletePlaceIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePlaceIndex for more information on using the DeletePlaceIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeletePlaceIndexRequest method.
req, resp := client.DeletePlaceIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeletePlaceIndex

func (*LocationService) DeletePlaceIndexWithContext 

func (c *LocationService) DeletePlaceIndexWithContext(ctx aws.Context, input *DeletePlaceIndexInput, opts ...request.Option) (*DeletePlaceIndexOutput, error)

DeletePlaceIndexWithContext is the same as DeletePlaceIndex with the addition of the ability to pass a context and additional request options.

See DeletePlaceIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) DeleteRouteCalculator added in v1.38.51 

func (c *LocationService) DeleteRouteCalculator(input *DeleteRouteCalculatorInput) (*DeleteRouteCalculatorOutput, error)

DeleteRouteCalculator API operation for Amazon Location Service.

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

This operation deletes the resource permanently.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation DeleteRouteCalculator for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteRouteCalculator

func (*LocationService) DeleteRouteCalculatorRequest added in v1.38.51 

func (c *LocationService) DeleteRouteCalculatorRequest(input *DeleteRouteCalculatorInput) (req *request.Request, output *DeleteRouteCalculatorOutput)

DeleteRouteCalculatorRequest generates a "aws/request.Request" representing the client's request for the DeleteRouteCalculator operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRouteCalculator for more information on using the DeleteRouteCalculator API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteRouteCalculatorRequest method.
req, resp := client.DeleteRouteCalculatorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteRouteCalculator

func (*LocationService) DeleteRouteCalculatorWithContext added in v1.38.51 

func (c *LocationService) DeleteRouteCalculatorWithContext(ctx aws.Context, input *DeleteRouteCalculatorInput, opts ...request.Option) (*DeleteRouteCalculatorOutput, error)

DeleteRouteCalculatorWithContext is the same as DeleteRouteCalculator with the addition of the ability to pass a context and additional request options.

See DeleteRouteCalculator for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) DeleteTracker 

func (c *LocationService) DeleteTracker(input *DeleteTrackerInput) (*DeleteTrackerOutput, error)

DeleteTracker API operation for Amazon Location Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation DeleteTracker for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteTracker

func (*LocationService) DeleteTrackerRequest 

func (c *LocationService) DeleteTrackerRequest(input *DeleteTrackerInput) (req *request.Request, output *DeleteTrackerOutput)

DeleteTrackerRequest generates a "aws/request.Request" representing the client's request for the DeleteTracker operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteTracker for more information on using the DeleteTracker API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteTrackerRequest method.
req, resp := client.DeleteTrackerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteTracker

func (*LocationService) DeleteTrackerWithContext 

func (c *LocationService) DeleteTrackerWithContext(ctx aws.Context, input *DeleteTrackerInput, opts ...request.Option) (*DeleteTrackerOutput, error)

DeleteTrackerWithContext is the same as DeleteTracker with the addition of the ability to pass a context and additional request options.

See DeleteTracker for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) DescribeGeofenceCollection 

func (c *LocationService) DescribeGeofenceCollection(input *DescribeGeofenceCollectionInput) (*DescribeGeofenceCollectionOutput, error)

DescribeGeofenceCollection API operation for Amazon Location Service.

Retrieves the geofence collection details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation DescribeGeofenceCollection for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeGeofenceCollection

func (*LocationService) DescribeGeofenceCollectionRequest 

func (c *LocationService) DescribeGeofenceCollectionRequest(input *DescribeGeofenceCollectionInput) (req *request.Request, output *DescribeGeofenceCollectionOutput)

DescribeGeofenceCollectionRequest generates a "aws/request.Request" representing the client's request for the DescribeGeofenceCollection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGeofenceCollection for more information on using the DescribeGeofenceCollection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeGeofenceCollectionRequest method.
req, resp := client.DescribeGeofenceCollectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeGeofenceCollection

func (*LocationService) DescribeGeofenceCollectionWithContext 

func (c *LocationService) DescribeGeofenceCollectionWithContext(ctx aws.Context, input *DescribeGeofenceCollectionInput, opts ...request.Option) (*DescribeGeofenceCollectionOutput, error)

DescribeGeofenceCollectionWithContext is the same as DescribeGeofenceCollection with the addition of the ability to pass a context and additional request options.

See DescribeGeofenceCollection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) DescribeKey added in v1.44.208 

func (c *LocationService) DescribeKey(input *DescribeKeyInput) (*DescribeKeyOutput, error)

DescribeKey API operation for Amazon Location Service.

Retrieves the API key resource details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation DescribeKey for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeKey

func (*LocationService) DescribeKeyRequest added in v1.44.208 

func (c *LocationService) DescribeKeyRequest(input *DescribeKeyInput) (req *request.Request, output *DescribeKeyOutput)

DescribeKeyRequest generates a "aws/request.Request" representing the client's request for the DescribeKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeKey for more information on using the DescribeKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeKeyRequest method.
req, resp := client.DescribeKeyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeKey

func (*LocationService) DescribeKeyWithContext added in v1.44.208 

func (c *LocationService) DescribeKeyWithContext(ctx aws.Context, input *DescribeKeyInput, opts ...request.Option) (*DescribeKeyOutput, error)

DescribeKeyWithContext is the same as DescribeKey with the addition of the ability to pass a context and additional request options.

See DescribeKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) DescribeMap 

func (c *LocationService) DescribeMap(input *DescribeMapInput) (*DescribeMapOutput, error)

DescribeMap API operation for Amazon Location Service.

Retrieves the map resource details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation DescribeMap for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeMap

func (*LocationService) DescribeMapRequest 

func (c *LocationService) DescribeMapRequest(input *DescribeMapInput) (req *request.Request, output *DescribeMapOutput)

DescribeMapRequest generates a "aws/request.Request" representing the client's request for the DescribeMap operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMap for more information on using the DescribeMap API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeMapRequest method.
req, resp := client.DescribeMapRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeMap

func (*LocationService) DescribeMapWithContext 

func (c *LocationService) DescribeMapWithContext(ctx aws.Context, input *DescribeMapInput, opts ...request.Option) (*DescribeMapOutput, error)

DescribeMapWithContext is the same as DescribeMap with the addition of the ability to pass a context and additional request options.

See DescribeMap for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) DescribePlaceIndex 

func (c *LocationService) DescribePlaceIndex(input *DescribePlaceIndexInput) (*DescribePlaceIndexOutput, error)

DescribePlaceIndex API operation for Amazon Location Service.

Retrieves the place index resource details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation DescribePlaceIndex for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribePlaceIndex

func (*LocationService) DescribePlaceIndexRequest 

func (c *LocationService) DescribePlaceIndexRequest(input *DescribePlaceIndexInput) (req *request.Request, output *DescribePlaceIndexOutput)

DescribePlaceIndexRequest generates a "aws/request.Request" representing the client's request for the DescribePlaceIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePlaceIndex for more information on using the DescribePlaceIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribePlaceIndexRequest method.
req, resp := client.DescribePlaceIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribePlaceIndex

func (*LocationService) DescribePlaceIndexWithContext 

func (c *LocationService) DescribePlaceIndexWithContext(ctx aws.Context, input *DescribePlaceIndexInput, opts ...request.Option) (*DescribePlaceIndexOutput, error)

DescribePlaceIndexWithContext is the same as DescribePlaceIndex with the addition of the ability to pass a context and additional request options.

See DescribePlaceIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) DescribeRouteCalculator added in v1.38.51 

func (c *LocationService) DescribeRouteCalculator(input *DescribeRouteCalculatorInput) (*DescribeRouteCalculatorOutput, error)

DescribeRouteCalculator API operation for Amazon Location Service.

Retrieves the route calculator resource details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation DescribeRouteCalculator for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeRouteCalculator

func (*LocationService) DescribeRouteCalculatorRequest added in v1.38.51 

func (c *LocationService) DescribeRouteCalculatorRequest(input *DescribeRouteCalculatorInput) (req *request.Request, output *DescribeRouteCalculatorOutput)

DescribeRouteCalculatorRequest generates a "aws/request.Request" representing the client's request for the DescribeRouteCalculator operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeRouteCalculator for more information on using the DescribeRouteCalculator API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeRouteCalculatorRequest method.
req, resp := client.DescribeRouteCalculatorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeRouteCalculator

func (*LocationService) DescribeRouteCalculatorWithContext added in v1.38.51 

func (c *LocationService) DescribeRouteCalculatorWithContext(ctx aws.Context, input *DescribeRouteCalculatorInput, opts ...request.Option) (*DescribeRouteCalculatorOutput, error)

DescribeRouteCalculatorWithContext is the same as DescribeRouteCalculator with the addition of the ability to pass a context and additional request options.

See DescribeRouteCalculator for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) DescribeTracker 

func (c *LocationService) DescribeTracker(input *DescribeTrackerInput) (*DescribeTrackerOutput, error)

DescribeTracker API operation for Amazon Location Service.

Retrieves the tracker resource details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation DescribeTracker for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeTracker

func (*LocationService) DescribeTrackerRequest 

func (c *LocationService) DescribeTrackerRequest(input *DescribeTrackerInput) (req *request.Request, output *DescribeTrackerOutput)

DescribeTrackerRequest generates a "aws/request.Request" representing the client's request for the DescribeTracker operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTracker for more information on using the DescribeTracker API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeTrackerRequest method.
req, resp := client.DescribeTrackerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeTracker

func (*LocationService) DescribeTrackerWithContext 

func (c *LocationService) DescribeTrackerWithContext(ctx aws.Context, input *DescribeTrackerInput, opts ...request.Option) (*DescribeTrackerOutput, error)

DescribeTrackerWithContext is the same as DescribeTracker with the addition of the ability to pass a context and additional request options.

See DescribeTracker for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) DisassociateTrackerConsumer 

func (c *LocationService) DisassociateTrackerConsumer(input *DisassociateTrackerConsumerInput) (*DisassociateTrackerConsumerOutput, error)

DisassociateTrackerConsumer API operation for Amazon Location Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation DisassociateTrackerConsumer for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DisassociateTrackerConsumer

func (*LocationService) DisassociateTrackerConsumerRequest 

func (c *LocationService) DisassociateTrackerConsumerRequest(input *DisassociateTrackerConsumerInput) (req *request.Request, output *DisassociateTrackerConsumerOutput)

DisassociateTrackerConsumerRequest generates a "aws/request.Request" representing the client's request for the DisassociateTrackerConsumer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateTrackerConsumer for more information on using the DisassociateTrackerConsumer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociateTrackerConsumerRequest method.
req, resp := client.DisassociateTrackerConsumerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DisassociateTrackerConsumer

func (*LocationService) DisassociateTrackerConsumerWithContext 

func (c *LocationService) DisassociateTrackerConsumerWithContext(ctx aws.Context, input *DisassociateTrackerConsumerInput, opts ...request.Option) (*DisassociateTrackerConsumerOutput, error)

DisassociateTrackerConsumerWithContext is the same as DisassociateTrackerConsumer with the addition of the ability to pass a context and additional request options.

See DisassociateTrackerConsumer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ForecastGeofenceEvents added in v1.53.18 

func (c *LocationService) ForecastGeofenceEvents(input *ForecastGeofenceEventsInput) (*ForecastGeofenceEventsOutput, error)

ForecastGeofenceEvents API operation for Amazon Location Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation ForecastGeofenceEvents for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ForecastGeofenceEvents

func (*LocationService) ForecastGeofenceEventsPages added in v1.53.18 

func (c *LocationService) ForecastGeofenceEventsPages(input *ForecastGeofenceEventsInput, fn func(*ForecastGeofenceEventsOutput, bool) bool) error

ForecastGeofenceEventsPages iterates over the pages of a ForecastGeofenceEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ForecastGeofenceEvents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ForecastGeofenceEvents operation.
pageNum := 0
err := client.ForecastGeofenceEventsPages(params,
    func(page *locationservice.ForecastGeofenceEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LocationService) ForecastGeofenceEventsPagesWithContext added in v1.53.18 

func (c *LocationService) ForecastGeofenceEventsPagesWithContext(ctx aws.Context, input *ForecastGeofenceEventsInput, fn func(*ForecastGeofenceEventsOutput, bool) bool, opts ...request.Option) error

ForecastGeofenceEventsPagesWithContext same as ForecastGeofenceEventsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ForecastGeofenceEventsRequest added in v1.53.18 

func (c *LocationService) ForecastGeofenceEventsRequest(input *ForecastGeofenceEventsInput) (req *request.Request, output *ForecastGeofenceEventsOutput)

ForecastGeofenceEventsRequest generates a "aws/request.Request" representing the client's request for the ForecastGeofenceEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ForecastGeofenceEvents for more information on using the ForecastGeofenceEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ForecastGeofenceEventsRequest method.
req, resp := client.ForecastGeofenceEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ForecastGeofenceEvents

func (*LocationService) ForecastGeofenceEventsWithContext added in v1.53.18 

func (c *LocationService) ForecastGeofenceEventsWithContext(ctx aws.Context, input *ForecastGeofenceEventsInput, opts ...request.Option) (*ForecastGeofenceEventsOutput, error)

ForecastGeofenceEventsWithContext is the same as ForecastGeofenceEvents with the addition of the ability to pass a context and additional request options.

See ForecastGeofenceEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) GetDevicePosition 

func (c *LocationService) GetDevicePosition(input *GetDevicePositionInput) (*GetDevicePositionOutput, error)

GetDevicePosition API operation for Amazon Location Service.

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

Device positions are deleted after 30 days.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation GetDevicePosition for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePosition

func (*LocationService) GetDevicePositionHistory 

func (c *LocationService) GetDevicePositionHistory(input *GetDevicePositionHistoryInput) (*GetDevicePositionHistoryOutput, error)

GetDevicePositionHistory API operation for Amazon Location Service.

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

Device positions are deleted after 30 days.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation GetDevicePositionHistory for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePositionHistory

func (*LocationService) GetDevicePositionHistoryPages 

func (c *LocationService) GetDevicePositionHistoryPages(input *GetDevicePositionHistoryInput, fn func(*GetDevicePositionHistoryOutput, bool) bool) error

GetDevicePositionHistoryPages iterates over the pages of a GetDevicePositionHistory operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetDevicePositionHistory method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetDevicePositionHistory operation.
pageNum := 0
err := client.GetDevicePositionHistoryPages(params,
    func(page *locationservice.GetDevicePositionHistoryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LocationService) GetDevicePositionHistoryPagesWithContext 

func (c *LocationService) GetDevicePositionHistoryPagesWithContext(ctx aws.Context, input *GetDevicePositionHistoryInput, fn func(*GetDevicePositionHistoryOutput, bool) bool, opts ...request.Option) error

GetDevicePositionHistoryPagesWithContext same as GetDevicePositionHistoryPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) GetDevicePositionHistoryRequest 

func (c *LocationService) GetDevicePositionHistoryRequest(input *GetDevicePositionHistoryInput) (req *request.Request, output *GetDevicePositionHistoryOutput)

GetDevicePositionHistoryRequest generates a "aws/request.Request" representing the client's request for the GetDevicePositionHistory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDevicePositionHistory for more information on using the GetDevicePositionHistory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDevicePositionHistoryRequest method.
req, resp := client.GetDevicePositionHistoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePositionHistory

func (*LocationService) GetDevicePositionHistoryWithContext 

func (c *LocationService) GetDevicePositionHistoryWithContext(ctx aws.Context, input *GetDevicePositionHistoryInput, opts ...request.Option) (*GetDevicePositionHistoryOutput, error)

GetDevicePositionHistoryWithContext is the same as GetDevicePositionHistory with the addition of the ability to pass a context and additional request options.

See GetDevicePositionHistory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) GetDevicePositionRequest 

func (c *LocationService) GetDevicePositionRequest(input *GetDevicePositionInput) (req *request.Request, output *GetDevicePositionOutput)

GetDevicePositionRequest generates a "aws/request.Request" representing the client's request for the GetDevicePosition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDevicePosition for more information on using the GetDevicePosition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDevicePositionRequest method.
req, resp := client.GetDevicePositionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePosition

func (*LocationService) GetDevicePositionWithContext 

func (c *LocationService) GetDevicePositionWithContext(ctx aws.Context, input *GetDevicePositionInput, opts ...request.Option) (*GetDevicePositionOutput, error)

GetDevicePositionWithContext is the same as GetDevicePosition with the addition of the ability to pass a context and additional request options.

See GetDevicePosition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) GetGeofence 

func (c *LocationService) GetGeofence(input *GetGeofenceInput) (*GetGeofenceOutput, error)

GetGeofence API operation for Amazon Location Service.

Retrieves the geofence details from a geofence collection.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation GetGeofence for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetGeofence

func (*LocationService) GetGeofenceRequest 

func (c *LocationService) GetGeofenceRequest(input *GetGeofenceInput) (req *request.Request, output *GetGeofenceOutput)

GetGeofenceRequest generates a "aws/request.Request" representing the client's request for the GetGeofence operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetGeofence for more information on using the GetGeofence API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetGeofenceRequest method.
req, resp := client.GetGeofenceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetGeofence

func (*LocationService) GetGeofenceWithContext 

func (c *LocationService) GetGeofenceWithContext(ctx aws.Context, input *GetGeofenceInput, opts ...request.Option) (*GetGeofenceOutput, error)

GetGeofenceWithContext is the same as GetGeofence with the addition of the ability to pass a context and additional request options.

See GetGeofence for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) GetMapGlyphs 

func (c *LocationService) GetMapGlyphs(input *GetMapGlyphsInput) (*GetMapGlyphsOutput, error)

GetMapGlyphs API operation for Amazon Location Service.

Retrieves glyphs used to display labels on a map.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation GetMapGlyphs for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapGlyphs

func (*LocationService) GetMapGlyphsRequest 

func (c *LocationService) GetMapGlyphsRequest(input *GetMapGlyphsInput) (req *request.Request, output *GetMapGlyphsOutput)

GetMapGlyphsRequest generates a "aws/request.Request" representing the client's request for the GetMapGlyphs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMapGlyphs for more information on using the GetMapGlyphs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetMapGlyphsRequest method.
req, resp := client.GetMapGlyphsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapGlyphs

func (*LocationService) GetMapGlyphsWithContext 

func (c *LocationService) GetMapGlyphsWithContext(ctx aws.Context, input *GetMapGlyphsInput, opts ...request.Option) (*GetMapGlyphsOutput, error)

GetMapGlyphsWithContext is the same as GetMapGlyphs with the addition of the ability to pass a context and additional request options.

See GetMapGlyphs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) GetMapSprites 

func (c *LocationService) GetMapSprites(input *GetMapSpritesInput) (*GetMapSpritesOutput, error)

GetMapSprites API operation for Amazon Location Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation GetMapSprites for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapSprites

func (*LocationService) GetMapSpritesRequest 

func (c *LocationService) GetMapSpritesRequest(input *GetMapSpritesInput) (req *request.Request, output *GetMapSpritesOutput)

GetMapSpritesRequest generates a "aws/request.Request" representing the client's request for the GetMapSprites operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMapSprites for more information on using the GetMapSprites API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetMapSpritesRequest method.
req, resp := client.GetMapSpritesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapSprites

func (*LocationService) GetMapSpritesWithContext 

func (c *LocationService) GetMapSpritesWithContext(ctx aws.Context, input *GetMapSpritesInput, opts ...request.Option) (*GetMapSpritesOutput, error)

GetMapSpritesWithContext is the same as GetMapSprites with the addition of the ability to pass a context and additional request options.

See GetMapSprites for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) GetMapStyleDescriptor 

func (c *LocationService) GetMapStyleDescriptor(input *GetMapStyleDescriptorInput) (*GetMapStyleDescriptorOutput, error)

GetMapStyleDescriptor API operation for Amazon Location Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation GetMapStyleDescriptor for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapStyleDescriptor

func (*LocationService) GetMapStyleDescriptorRequest 

func (c *LocationService) GetMapStyleDescriptorRequest(input *GetMapStyleDescriptorInput) (req *request.Request, output *GetMapStyleDescriptorOutput)

GetMapStyleDescriptorRequest generates a "aws/request.Request" representing the client's request for the GetMapStyleDescriptor operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMapStyleDescriptor for more information on using the GetMapStyleDescriptor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetMapStyleDescriptorRequest method.
req, resp := client.GetMapStyleDescriptorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapStyleDescriptor

func (*LocationService) GetMapStyleDescriptorWithContext 

func (c *LocationService) GetMapStyleDescriptorWithContext(ctx aws.Context, input *GetMapStyleDescriptorInput, opts ...request.Option) (*GetMapStyleDescriptorOutput, error)

GetMapStyleDescriptorWithContext is the same as GetMapStyleDescriptor with the addition of the ability to pass a context and additional request options.

See GetMapStyleDescriptor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) GetMapTile 

func (c *LocationService) GetMapTile(input *GetMapTileInput) (*GetMapTileOutput, error)

GetMapTile API operation for Amazon Location Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation GetMapTile for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapTile

func (*LocationService) GetMapTileRequest 

func (c *LocationService) GetMapTileRequest(input *GetMapTileInput) (req *request.Request, output *GetMapTileOutput)

GetMapTileRequest generates a "aws/request.Request" representing the client's request for the GetMapTile operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMapTile for more information on using the GetMapTile API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetMapTileRequest method.
req, resp := client.GetMapTileRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapTile

func (*LocationService) GetMapTileWithContext 

func (c *LocationService) GetMapTileWithContext(ctx aws.Context, input *GetMapTileInput, opts ...request.Option) (*GetMapTileOutput, error)

GetMapTileWithContext is the same as GetMapTile with the addition of the ability to pass a context and additional request options.

See GetMapTile for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) GetPlace added in v1.44.107 

func (c *LocationService) GetPlace(input *GetPlaceInput) (*GetPlaceOutput, error)

GetPlace API operation for Amazon Location Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation GetPlace for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetPlace

func (*LocationService) GetPlaceRequest added in v1.44.107 

func (c *LocationService) GetPlaceRequest(input *GetPlaceInput) (req *request.Request, output *GetPlaceOutput)

GetPlaceRequest generates a "aws/request.Request" representing the client's request for the GetPlace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPlace for more information on using the GetPlace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetPlaceRequest method.
req, resp := client.GetPlaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetPlace

func (*LocationService) GetPlaceWithContext added in v1.44.107 

func (c *LocationService) GetPlaceWithContext(ctx aws.Context, input *GetPlaceInput, opts ...request.Option) (*GetPlaceOutput, error)

GetPlaceWithContext is the same as GetPlace with the addition of the ability to pass a context and additional request options.

See GetPlace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListDevicePositions added in v1.38.51 

func (c *LocationService) ListDevicePositions(input *ListDevicePositionsInput) (*ListDevicePositionsOutput, error)

ListDevicePositions API operation for Amazon Location Service.

A batch request to retrieve all device positions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation ListDevicePositions for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListDevicePositions

func (*LocationService) ListDevicePositionsPages added in v1.38.51 

func (c *LocationService) ListDevicePositionsPages(input *ListDevicePositionsInput, fn func(*ListDevicePositionsOutput, bool) bool) error

ListDevicePositionsPages iterates over the pages of a ListDevicePositions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDevicePositions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListDevicePositions operation.
pageNum := 0
err := client.ListDevicePositionsPages(params,
    func(page *locationservice.ListDevicePositionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LocationService) ListDevicePositionsPagesWithContext added in v1.38.51 

func (c *LocationService) ListDevicePositionsPagesWithContext(ctx aws.Context, input *ListDevicePositionsInput, fn func(*ListDevicePositionsOutput, bool) bool, opts ...request.Option) error

ListDevicePositionsPagesWithContext same as ListDevicePositionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListDevicePositionsRequest added in v1.38.51 

func (c *LocationService) ListDevicePositionsRequest(input *ListDevicePositionsInput) (req *request.Request, output *ListDevicePositionsOutput)

ListDevicePositionsRequest generates a "aws/request.Request" representing the client's request for the ListDevicePositions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDevicePositions for more information on using the ListDevicePositions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDevicePositionsRequest method.
req, resp := client.ListDevicePositionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListDevicePositions

func (*LocationService) ListDevicePositionsWithContext added in v1.38.51 

func (c *LocationService) ListDevicePositionsWithContext(ctx aws.Context, input *ListDevicePositionsInput, opts ...request.Option) (*ListDevicePositionsOutput, error)

ListDevicePositionsWithContext is the same as ListDevicePositions with the addition of the ability to pass a context and additional request options.

See ListDevicePositions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListGeofenceCollections 

func (c *LocationService) ListGeofenceCollections(input *ListGeofenceCollectionsInput) (*ListGeofenceCollectionsOutput, error)

ListGeofenceCollections API operation for Amazon Location Service.

Lists geofence collections in your Amazon Web Services account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation ListGeofenceCollections for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofenceCollections

func (*LocationService) ListGeofenceCollectionsPages 

func (c *LocationService) ListGeofenceCollectionsPages(input *ListGeofenceCollectionsInput, fn func(*ListGeofenceCollectionsOutput, bool) bool) error

ListGeofenceCollectionsPages iterates over the pages of a ListGeofenceCollections operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListGeofenceCollections method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListGeofenceCollections operation.
pageNum := 0
err := client.ListGeofenceCollectionsPages(params,
    func(page *locationservice.ListGeofenceCollectionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LocationService) ListGeofenceCollectionsPagesWithContext 

func (c *LocationService) ListGeofenceCollectionsPagesWithContext(ctx aws.Context, input *ListGeofenceCollectionsInput, fn func(*ListGeofenceCollectionsOutput, bool) bool, opts ...request.Option) error

ListGeofenceCollectionsPagesWithContext same as ListGeofenceCollectionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListGeofenceCollectionsRequest 

func (c *LocationService) ListGeofenceCollectionsRequest(input *ListGeofenceCollectionsInput) (req *request.Request, output *ListGeofenceCollectionsOutput)

ListGeofenceCollectionsRequest generates a "aws/request.Request" representing the client's request for the ListGeofenceCollections operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListGeofenceCollections for more information on using the ListGeofenceCollections API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListGeofenceCollectionsRequest method.
req, resp := client.ListGeofenceCollectionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofenceCollections

func (*LocationService) ListGeofenceCollectionsWithContext 

func (c *LocationService) ListGeofenceCollectionsWithContext(ctx aws.Context, input *ListGeofenceCollectionsInput, opts ...request.Option) (*ListGeofenceCollectionsOutput, error)

ListGeofenceCollectionsWithContext is the same as ListGeofenceCollections with the addition of the ability to pass a context and additional request options.

See ListGeofenceCollections for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListGeofences 

func (c *LocationService) ListGeofences(input *ListGeofencesInput) (*ListGeofencesOutput, error)

ListGeofences API operation for Amazon Location Service.

Lists geofences stored in a given geofence collection.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation ListGeofences for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofences

func (*LocationService) ListGeofencesPages 

func (c *LocationService) ListGeofencesPages(input *ListGeofencesInput, fn func(*ListGeofencesOutput, bool) bool) error

ListGeofencesPages iterates over the pages of a ListGeofences operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListGeofences method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListGeofences operation.
pageNum := 0
err := client.ListGeofencesPages(params,
    func(page *locationservice.ListGeofencesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LocationService) ListGeofencesPagesWithContext 

func (c *LocationService) ListGeofencesPagesWithContext(ctx aws.Context, input *ListGeofencesInput, fn func(*ListGeofencesOutput, bool) bool, opts ...request.Option) error

ListGeofencesPagesWithContext same as ListGeofencesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListGeofencesRequest 

func (c *LocationService) ListGeofencesRequest(input *ListGeofencesInput) (req *request.Request, output *ListGeofencesOutput)

ListGeofencesRequest generates a "aws/request.Request" representing the client's request for the ListGeofences operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListGeofences for more information on using the ListGeofences API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListGeofencesRequest method.
req, resp := client.ListGeofencesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofences

func (*LocationService) ListGeofencesWithContext 

func (c *LocationService) ListGeofencesWithContext(ctx aws.Context, input *ListGeofencesInput, opts ...request.Option) (*ListGeofencesOutput, error)

ListGeofencesWithContext is the same as ListGeofences with the addition of the ability to pass a context and additional request options.

See ListGeofences for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListKeys added in v1.44.208 

func (c *LocationService) ListKeys(input *ListKeysInput) (*ListKeysOutput, error)

ListKeys API operation for Amazon Location Service.

Lists API key resources in your Amazon Web Services account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation ListKeys for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListKeys

func (*LocationService) ListKeysPages added in v1.44.208 

func (c *LocationService) ListKeysPages(input *ListKeysInput, fn func(*ListKeysOutput, bool) bool) error

ListKeysPages iterates over the pages of a ListKeys operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListKeys method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListKeys operation.
pageNum := 0
err := client.ListKeysPages(params,
    func(page *locationservice.ListKeysOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LocationService) ListKeysPagesWithContext added in v1.44.208 

func (c *LocationService) ListKeysPagesWithContext(ctx aws.Context, input *ListKeysInput, fn func(*ListKeysOutput, bool) bool, opts ...request.Option) error

ListKeysPagesWithContext same as ListKeysPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListKeysRequest added in v1.44.208 

func (c *LocationService) ListKeysRequest(input *ListKeysInput) (req *request.Request, output *ListKeysOutput)

ListKeysRequest generates a "aws/request.Request" representing the client's request for the ListKeys operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListKeys for more information on using the ListKeys API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListKeysRequest method.
req, resp := client.ListKeysRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListKeys

func (*LocationService) ListKeysWithContext added in v1.44.208 

func (c *LocationService) ListKeysWithContext(ctx aws.Context, input *ListKeysInput, opts ...request.Option) (*ListKeysOutput, error)

ListKeysWithContext is the same as ListKeys with the addition of the ability to pass a context and additional request options.

See ListKeys for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListMaps 

func (c *LocationService) ListMaps(input *ListMapsInput) (*ListMapsOutput, error)

ListMaps API operation for Amazon Location Service.

Lists map resources in your Amazon Web Services account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation ListMaps for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListMaps

func (*LocationService) ListMapsPages 

func (c *LocationService) ListMapsPages(input *ListMapsInput, fn func(*ListMapsOutput, bool) bool) error

ListMapsPages iterates over the pages of a ListMaps operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMaps method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListMaps operation.
pageNum := 0
err := client.ListMapsPages(params,
    func(page *locationservice.ListMapsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LocationService) ListMapsPagesWithContext 

func (c *LocationService) ListMapsPagesWithContext(ctx aws.Context, input *ListMapsInput, fn func(*ListMapsOutput, bool) bool, opts ...request.Option) error

ListMapsPagesWithContext same as ListMapsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListMapsRequest 

func (c *LocationService) ListMapsRequest(input *ListMapsInput) (req *request.Request, output *ListMapsOutput)

ListMapsRequest generates a "aws/request.Request" representing the client's request for the ListMaps operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListMaps for more information on using the ListMaps API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListMapsRequest method.
req, resp := client.ListMapsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListMaps

func (*LocationService) ListMapsWithContext 

func (c *LocationService) ListMapsWithContext(ctx aws.Context, input *ListMapsInput, opts ...request.Option) (*ListMapsOutput, error)

ListMapsWithContext is the same as ListMaps with the addition of the ability to pass a context and additional request options.

See ListMaps for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListPlaceIndexes 

func (c *LocationService) ListPlaceIndexes(input *ListPlaceIndexesInput) (*ListPlaceIndexesOutput, error)

ListPlaceIndexes API operation for Amazon Location Service.

Lists place index resources in your Amazon Web Services account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation ListPlaceIndexes for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListPlaceIndexes

func (*LocationService) ListPlaceIndexesPages 

func (c *LocationService) ListPlaceIndexesPages(input *ListPlaceIndexesInput, fn func(*ListPlaceIndexesOutput, bool) bool) error

ListPlaceIndexesPages iterates over the pages of a ListPlaceIndexes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPlaceIndexes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListPlaceIndexes operation.
pageNum := 0
err := client.ListPlaceIndexesPages(params,
    func(page *locationservice.ListPlaceIndexesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LocationService) ListPlaceIndexesPagesWithContext 

func (c *LocationService) ListPlaceIndexesPagesWithContext(ctx aws.Context, input *ListPlaceIndexesInput, fn func(*ListPlaceIndexesOutput, bool) bool, opts ...request.Option) error

ListPlaceIndexesPagesWithContext same as ListPlaceIndexesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListPlaceIndexesRequest 

func (c *LocationService) ListPlaceIndexesRequest(input *ListPlaceIndexesInput) (req *request.Request, output *ListPlaceIndexesOutput)

ListPlaceIndexesRequest generates a "aws/request.Request" representing the client's request for the ListPlaceIndexes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPlaceIndexes for more information on using the ListPlaceIndexes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListPlaceIndexesRequest method.
req, resp := client.ListPlaceIndexesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListPlaceIndexes

func (*LocationService) ListPlaceIndexesWithContext 

func (c *LocationService) ListPlaceIndexesWithContext(ctx aws.Context, input *ListPlaceIndexesInput, opts ...request.Option) (*ListPlaceIndexesOutput, error)

ListPlaceIndexesWithContext is the same as ListPlaceIndexes with the addition of the ability to pass a context and additional request options.

See ListPlaceIndexes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListRouteCalculators added in v1.38.51 

func (c *LocationService) ListRouteCalculators(input *ListRouteCalculatorsInput) (*ListRouteCalculatorsOutput, error)

ListRouteCalculators API operation for Amazon Location Service.

Lists route calculator resources in your Amazon Web Services account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation ListRouteCalculators for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListRouteCalculators

func (*LocationService) ListRouteCalculatorsPages added in v1.38.51 

func (c *LocationService) ListRouteCalculatorsPages(input *ListRouteCalculatorsInput, fn func(*ListRouteCalculatorsOutput, bool) bool) error

ListRouteCalculatorsPages iterates over the pages of a ListRouteCalculators operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListRouteCalculators method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListRouteCalculators operation.
pageNum := 0
err := client.ListRouteCalculatorsPages(params,
    func(page *locationservice.ListRouteCalculatorsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LocationService) ListRouteCalculatorsPagesWithContext added in v1.38.51 

func (c *LocationService) ListRouteCalculatorsPagesWithContext(ctx aws.Context, input *ListRouteCalculatorsInput, fn func(*ListRouteCalculatorsOutput, bool) bool, opts ...request.Option) error

ListRouteCalculatorsPagesWithContext same as ListRouteCalculatorsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListRouteCalculatorsRequest added in v1.38.51 

func (c *LocationService) ListRouteCalculatorsRequest(input *ListRouteCalculatorsInput) (req *request.Request, output *ListRouteCalculatorsOutput)

ListRouteCalculatorsRequest generates a "aws/request.Request" representing the client's request for the ListRouteCalculators operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRouteCalculators for more information on using the ListRouteCalculators API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListRouteCalculatorsRequest method.
req, resp := client.ListRouteCalculatorsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListRouteCalculators

func (*LocationService) ListRouteCalculatorsWithContext added in v1.38.51 

func (c *LocationService) ListRouteCalculatorsWithContext(ctx aws.Context, input *ListRouteCalculatorsInput, opts ...request.Option) (*ListRouteCalculatorsOutput, error)

ListRouteCalculatorsWithContext is the same as ListRouteCalculators with the addition of the ability to pass a context and additional request options.

See ListRouteCalculators for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListTagsForResource added in v1.38.51 

func (c *LocationService) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Location Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTagsForResource

func (*LocationService) ListTagsForResourceRequest added in v1.38.51 

func (c *LocationService) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTagsForResource

func (*LocationService) ListTagsForResourceWithContext added in v1.38.51 

func (c *LocationService) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListTrackerConsumers 

func (c *LocationService) ListTrackerConsumers(input *ListTrackerConsumersInput) (*ListTrackerConsumersOutput, error)

ListTrackerConsumers API operation for Amazon Location Service.

Lists geofence collections currently associated to the given tracker resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation ListTrackerConsumers for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTrackerConsumers

func (*LocationService) ListTrackerConsumersPages 

func (c *LocationService) ListTrackerConsumersPages(input *ListTrackerConsumersInput, fn func(*ListTrackerConsumersOutput, bool) bool) error

ListTrackerConsumersPages iterates over the pages of a ListTrackerConsumers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTrackerConsumers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTrackerConsumers operation.
pageNum := 0
err := client.ListTrackerConsumersPages(params,
    func(page *locationservice.ListTrackerConsumersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LocationService) ListTrackerConsumersPagesWithContext 

func (c *LocationService) ListTrackerConsumersPagesWithContext(ctx aws.Context, input *ListTrackerConsumersInput, fn func(*ListTrackerConsumersOutput, bool) bool, opts ...request.Option) error

ListTrackerConsumersPagesWithContext same as ListTrackerConsumersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListTrackerConsumersRequest 

func (c *LocationService) ListTrackerConsumersRequest(input *ListTrackerConsumersInput) (req *request.Request, output *ListTrackerConsumersOutput)

ListTrackerConsumersRequest generates a "aws/request.Request" representing the client's request for the ListTrackerConsumers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTrackerConsumers for more information on using the ListTrackerConsumers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTrackerConsumersRequest method.
req, resp := client.ListTrackerConsumersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTrackerConsumers

func (*LocationService) ListTrackerConsumersWithContext 

func (c *LocationService) ListTrackerConsumersWithContext(ctx aws.Context, input *ListTrackerConsumersInput, opts ...request.Option) (*ListTrackerConsumersOutput, error)

ListTrackerConsumersWithContext is the same as ListTrackerConsumers with the addition of the ability to pass a context and additional request options.

See ListTrackerConsumers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListTrackers 

func (c *LocationService) ListTrackers(input *ListTrackersInput) (*ListTrackersOutput, error)

ListTrackers API operation for Amazon Location Service.

Lists tracker resources in your Amazon Web Services account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation ListTrackers for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTrackers

func (*LocationService) ListTrackersPages 

func (c *LocationService) ListTrackersPages(input *ListTrackersInput, fn func(*ListTrackersOutput, bool) bool) error

ListTrackersPages iterates over the pages of a ListTrackers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTrackers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTrackers operation.
pageNum := 0
err := client.ListTrackersPages(params,
    func(page *locationservice.ListTrackersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LocationService) ListTrackersPagesWithContext 

func (c *LocationService) ListTrackersPagesWithContext(ctx aws.Context, input *ListTrackersInput, fn func(*ListTrackersOutput, bool) bool, opts ...request.Option) error

ListTrackersPagesWithContext same as ListTrackersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) ListTrackersRequest 

func (c *LocationService) ListTrackersRequest(input *ListTrackersInput) (req *request.Request, output *ListTrackersOutput)

ListTrackersRequest generates a "aws/request.Request" representing the client's request for the ListTrackers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTrackers for more information on using the ListTrackers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTrackersRequest method.
req, resp := client.ListTrackersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTrackers

func (*LocationService) ListTrackersWithContext 

func (c *LocationService) ListTrackersWithContext(ctx aws.Context, input *ListTrackersInput, opts ...request.Option) (*ListTrackersOutput, error)

ListTrackersWithContext is the same as ListTrackers with the addition of the ability to pass a context and additional request options.

See ListTrackers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) PutGeofence 

func (c *LocationService) PutGeofence(input *PutGeofenceInput) (*PutGeofenceOutput, error)

PutGeofence API operation for Amazon Location Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation PutGeofence for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • ConflictException The request was unsuccessful because of a conflict.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/PutGeofence

func (*LocationService) PutGeofenceRequest 

func (c *LocationService) PutGeofenceRequest(input *PutGeofenceInput) (req *request.Request, output *PutGeofenceOutput)

PutGeofenceRequest generates a "aws/request.Request" representing the client's request for the PutGeofence operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutGeofence for more information on using the PutGeofence API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutGeofenceRequest method.
req, resp := client.PutGeofenceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/PutGeofence

func (*LocationService) PutGeofenceWithContext 

func (c *LocationService) PutGeofenceWithContext(ctx aws.Context, input *PutGeofenceInput, opts ...request.Option) (*PutGeofenceOutput, error)

PutGeofenceWithContext is the same as PutGeofence with the addition of the ability to pass a context and additional request options.

See PutGeofence for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) SearchPlaceIndexForPosition 

func (c *LocationService) SearchPlaceIndexForPosition(input *SearchPlaceIndexForPositionInput) (*SearchPlaceIndexForPositionOutput, error)

SearchPlaceIndexForPosition API operation for Amazon Location Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation SearchPlaceIndexForPosition for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPosition

func (*LocationService) SearchPlaceIndexForPositionRequest 

func (c *LocationService) SearchPlaceIndexForPositionRequest(input *SearchPlaceIndexForPositionInput) (req *request.Request, output *SearchPlaceIndexForPositionOutput)

SearchPlaceIndexForPositionRequest generates a "aws/request.Request" representing the client's request for the SearchPlaceIndexForPosition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchPlaceIndexForPosition for more information on using the SearchPlaceIndexForPosition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SearchPlaceIndexForPositionRequest method.
req, resp := client.SearchPlaceIndexForPositionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPosition

func (*LocationService) SearchPlaceIndexForPositionWithContext 

func (c *LocationService) SearchPlaceIndexForPositionWithContext(ctx aws.Context, input *SearchPlaceIndexForPositionInput, opts ...request.Option) (*SearchPlaceIndexForPositionOutput, error)

SearchPlaceIndexForPositionWithContext is the same as SearchPlaceIndexForPosition with the addition of the ability to pass a context and additional request options.

See SearchPlaceIndexForPosition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) SearchPlaceIndexForSuggestions added in v1.42.20 

func (c *LocationService) SearchPlaceIndexForSuggestions(input *SearchPlaceIndexForSuggestionsInput) (*SearchPlaceIndexForSuggestionsOutput, error)

SearchPlaceIndexForSuggestions API operation for Amazon Location Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation SearchPlaceIndexForSuggestions for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestions

func (*LocationService) SearchPlaceIndexForSuggestionsRequest added in v1.42.20 

func (c *LocationService) SearchPlaceIndexForSuggestionsRequest(input *SearchPlaceIndexForSuggestionsInput) (req *request.Request, output *SearchPlaceIndexForSuggestionsOutput)

SearchPlaceIndexForSuggestionsRequest generates a "aws/request.Request" representing the client's request for the SearchPlaceIndexForSuggestions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchPlaceIndexForSuggestions for more information on using the SearchPlaceIndexForSuggestions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SearchPlaceIndexForSuggestionsRequest method.
req, resp := client.SearchPlaceIndexForSuggestionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestions

func (*LocationService) SearchPlaceIndexForSuggestionsWithContext added in v1.42.20 

func (c *LocationService) SearchPlaceIndexForSuggestionsWithContext(ctx aws.Context, input *SearchPlaceIndexForSuggestionsInput, opts ...request.Option) (*SearchPlaceIndexForSuggestionsOutput, error)

SearchPlaceIndexForSuggestionsWithContext is the same as SearchPlaceIndexForSuggestions with the addition of the ability to pass a context and additional request options.

See SearchPlaceIndexForSuggestions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) SearchPlaceIndexForText 

func (c *LocationService) SearchPlaceIndexForText(input *SearchPlaceIndexForTextInput) (*SearchPlaceIndexForTextOutput, error)

SearchPlaceIndexForText API operation for Amazon Location Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation SearchPlaceIndexForText for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForText

func (*LocationService) SearchPlaceIndexForTextRequest 

func (c *LocationService) SearchPlaceIndexForTextRequest(input *SearchPlaceIndexForTextInput) (req *request.Request, output *SearchPlaceIndexForTextOutput)

SearchPlaceIndexForTextRequest generates a "aws/request.Request" representing the client's request for the SearchPlaceIndexForText operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchPlaceIndexForText for more information on using the SearchPlaceIndexForText API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SearchPlaceIndexForTextRequest method.
req, resp := client.SearchPlaceIndexForTextRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForText

func (*LocationService) SearchPlaceIndexForTextWithContext 

func (c *LocationService) SearchPlaceIndexForTextWithContext(ctx aws.Context, input *SearchPlaceIndexForTextInput, opts ...request.Option) (*SearchPlaceIndexForTextOutput, error)

SearchPlaceIndexForTextWithContext is the same as SearchPlaceIndexForText with the addition of the ability to pass a context and additional request options.

See SearchPlaceIndexForText for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) TagResource added in v1.38.51 

func (c *LocationService) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Location Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation TagResource for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TagResource

func (*LocationService) TagResourceRequest added in v1.38.51 

func (c *LocationService) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TagResource

func (*LocationService) TagResourceWithContext added in v1.38.51 

func (c *LocationService) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) UntagResource added in v1.38.51 

func (c *LocationService) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Location Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation UntagResource for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UntagResource

func (*LocationService) UntagResourceRequest added in v1.38.51 

func (c *LocationService) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UntagResource

func (*LocationService) UntagResourceWithContext added in v1.38.51 

func (c *LocationService) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) UpdateGeofenceCollection added in v1.40.3 

func (c *LocationService) UpdateGeofenceCollection(input *UpdateGeofenceCollectionInput) (*UpdateGeofenceCollectionOutput, error)

UpdateGeofenceCollection API operation for Amazon Location Service.

Updates the specified properties of a given geofence collection.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation UpdateGeofenceCollection for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateGeofenceCollection

func (*LocationService) UpdateGeofenceCollectionRequest added in v1.40.3 

func (c *LocationService) UpdateGeofenceCollectionRequest(input *UpdateGeofenceCollectionInput) (req *request.Request, output *UpdateGeofenceCollectionOutput)

UpdateGeofenceCollectionRequest generates a "aws/request.Request" representing the client's request for the UpdateGeofenceCollection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateGeofenceCollection for more information on using the UpdateGeofenceCollection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateGeofenceCollectionRequest method.
req, resp := client.UpdateGeofenceCollectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateGeofenceCollection

func (*LocationService) UpdateGeofenceCollectionWithContext added in v1.40.3 

func (c *LocationService) UpdateGeofenceCollectionWithContext(ctx aws.Context, input *UpdateGeofenceCollectionInput, opts ...request.Option) (*UpdateGeofenceCollectionOutput, error)

UpdateGeofenceCollectionWithContext is the same as UpdateGeofenceCollection with the addition of the ability to pass a context and additional request options.

See UpdateGeofenceCollection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) UpdateKey added in v1.44.208 

func (c *LocationService) UpdateKey(input *UpdateKeyInput) (*UpdateKeyOutput, error)

UpdateKey API operation for Amazon Location Service.

Updates the specified properties of a given API key resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation UpdateKey for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateKey

func (*LocationService) UpdateKeyRequest added in v1.44.208 

func (c *LocationService) UpdateKeyRequest(input *UpdateKeyInput) (req *request.Request, output *UpdateKeyOutput)

UpdateKeyRequest generates a "aws/request.Request" representing the client's request for the UpdateKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateKey for more information on using the UpdateKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateKeyRequest method.
req, resp := client.UpdateKeyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateKey

func (*LocationService) UpdateKeyWithContext added in v1.44.208 

func (c *LocationService) UpdateKeyWithContext(ctx aws.Context, input *UpdateKeyInput, opts ...request.Option) (*UpdateKeyOutput, error)

UpdateKeyWithContext is the same as UpdateKey with the addition of the ability to pass a context and additional request options.

See UpdateKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) UpdateMap added in v1.40.3 

func (c *LocationService) UpdateMap(input *UpdateMapInput) (*UpdateMapOutput, error)

UpdateMap API operation for Amazon Location Service.

Updates the specified properties of a given map resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation UpdateMap for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateMap

func (*LocationService) UpdateMapRequest added in v1.40.3 

func (c *LocationService) UpdateMapRequest(input *UpdateMapInput) (req *request.Request, output *UpdateMapOutput)

UpdateMapRequest generates a "aws/request.Request" representing the client's request for the UpdateMap operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateMap for more information on using the UpdateMap API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateMapRequest method.
req, resp := client.UpdateMapRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateMap

func (*LocationService) UpdateMapWithContext added in v1.40.3 

func (c *LocationService) UpdateMapWithContext(ctx aws.Context, input *UpdateMapInput, opts ...request.Option) (*UpdateMapOutput, error)

UpdateMapWithContext is the same as UpdateMap with the addition of the ability to pass a context and additional request options.

See UpdateMap for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) UpdatePlaceIndex added in v1.40.3 

func (c *LocationService) UpdatePlaceIndex(input *UpdatePlaceIndexInput) (*UpdatePlaceIndexOutput, error)

UpdatePlaceIndex API operation for Amazon Location Service.

Updates the specified properties of a given place index resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation UpdatePlaceIndex for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdatePlaceIndex

func (*LocationService) UpdatePlaceIndexRequest added in v1.40.3 

func (c *LocationService) UpdatePlaceIndexRequest(input *UpdatePlaceIndexInput) (req *request.Request, output *UpdatePlaceIndexOutput)

UpdatePlaceIndexRequest generates a "aws/request.Request" representing the client's request for the UpdatePlaceIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdatePlaceIndex for more information on using the UpdatePlaceIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdatePlaceIndexRequest method.
req, resp := client.UpdatePlaceIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdatePlaceIndex

func (*LocationService) UpdatePlaceIndexWithContext added in v1.40.3 

func (c *LocationService) UpdatePlaceIndexWithContext(ctx aws.Context, input *UpdatePlaceIndexInput, opts ...request.Option) (*UpdatePlaceIndexOutput, error)

UpdatePlaceIndexWithContext is the same as UpdatePlaceIndex with the addition of the ability to pass a context and additional request options.

See UpdatePlaceIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) UpdateRouteCalculator added in v1.40.3 

func (c *LocationService) UpdateRouteCalculator(input *UpdateRouteCalculatorInput) (*UpdateRouteCalculatorOutput, error)

UpdateRouteCalculator API operation for Amazon Location Service.

Updates the specified properties for a given route calculator resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation UpdateRouteCalculator for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateRouteCalculator

func (*LocationService) UpdateRouteCalculatorRequest added in v1.40.3 

func (c *LocationService) UpdateRouteCalculatorRequest(input *UpdateRouteCalculatorInput) (req *request.Request, output *UpdateRouteCalculatorOutput)

UpdateRouteCalculatorRequest generates a "aws/request.Request" representing the client's request for the UpdateRouteCalculator operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateRouteCalculator for more information on using the UpdateRouteCalculator API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateRouteCalculatorRequest method.
req, resp := client.UpdateRouteCalculatorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateRouteCalculator

func (*LocationService) UpdateRouteCalculatorWithContext added in v1.40.3 

func (c *LocationService) UpdateRouteCalculatorWithContext(ctx aws.Context, input *UpdateRouteCalculatorInput, opts ...request.Option) (*UpdateRouteCalculatorOutput, error)

UpdateRouteCalculatorWithContext is the same as UpdateRouteCalculator with the addition of the ability to pass a context and additional request options.

See UpdateRouteCalculator for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) UpdateTracker added in v1.40.3 

func (c *LocationService) UpdateTracker(input *UpdateTrackerInput) (*UpdateTrackerOutput, error)

UpdateTracker API operation for Amazon Location Service.

Updates the specified properties of a given tracker resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation UpdateTracker for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateTracker

func (*LocationService) UpdateTrackerRequest added in v1.40.3 

func (c *LocationService) UpdateTrackerRequest(input *UpdateTrackerInput) (req *request.Request, output *UpdateTrackerOutput)

UpdateTrackerRequest generates a "aws/request.Request" representing the client's request for the UpdateTracker operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateTracker for more information on using the UpdateTracker API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateTrackerRequest method.
req, resp := client.UpdateTrackerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateTracker

func (*LocationService) UpdateTrackerWithContext added in v1.40.3 

func (c *LocationService) UpdateTrackerWithContext(ctx aws.Context, input *UpdateTrackerInput, opts ...request.Option) (*UpdateTrackerOutput, error)

UpdateTrackerWithContext is the same as UpdateTracker with the addition of the ability to pass a context and additional request options.

See UpdateTracker for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LocationService) VerifyDevicePosition added in v1.53.18 

func (c *LocationService) VerifyDevicePosition(input *VerifyDevicePositionInput) (*VerifyDevicePositionOutput, error)

VerifyDevicePosition API operation for Amazon Location Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Location Service's API operation VerifyDevicePosition for usage and error information.

Returned Error Types:

  • InternalServerException The request has failed to process because of an unknown server error, exception, or failure.

  • ResourceNotFoundException The resource that you've entered was not found in your AWS account.

  • AccessDeniedException The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

  • ValidationException The input failed to meet the constraints specified by the AWS service.

  • ThrottlingException The request was denied because of request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/VerifyDevicePosition

func (*LocationService) VerifyDevicePositionRequest added in v1.53.18 

func (c *LocationService) VerifyDevicePositionRequest(input *VerifyDevicePositionInput) (req *request.Request, output *VerifyDevicePositionOutput)

VerifyDevicePositionRequest generates a "aws/request.Request" representing the client's request for the VerifyDevicePosition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See VerifyDevicePosition for more information on using the VerifyDevicePosition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the VerifyDevicePositionRequest method.
req, resp := client.VerifyDevicePositionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/VerifyDevicePosition

func (*LocationService) VerifyDevicePositionWithContext added in v1.53.18 

func (c *LocationService) VerifyDevicePositionWithContext(ctx aws.Context, input *VerifyDevicePositionInput, opts ...request.Option) (*VerifyDevicePositionOutput, error)

VerifyDevicePositionWithContext is the same as VerifyDevicePosition with the addition of the ability to pass a context and additional request options.

See VerifyDevicePosition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type LteCellDetails added in v1.53.18 

type LteCellDetails struct {

	// The E-UTRAN Cell Identifier (ECI).
	//
	// CellId is a required field
	CellId *int64 `type:"integer" required:"true"`

	// The LTE local identification information (local ID).
	LocalId *LteLocalId `type:"structure"`

	// The Mobile Country Code (MCC).
	//
	// Mcc is a required field
	Mcc *int64 `min:"200" type:"integer" required:"true"`

	// The Mobile Network Code (MNC)
	//
	// Mnc is a required field
	Mnc *int64 `type:"integer" required:"true"`

	// The network measurements.
	NetworkMeasurements []*LteNetworkMeasurements `min:"1" type:"list"`

	// Indicates whether the LTE object is capable of supporting NR (new radio).
	NrCapable *bool `type:"boolean"`

	// Signal power of the reference signal received, measured in decibel-milliwatts
	// (dBm).
	Rsrp *int64 `type:"integer"`

	// Signal quality of the reference Signal received, measured in decibels (dB).
	Rsrq *float64 `type:"float"`

	// LTE Tracking Area Code (TAC).
	Tac *int64 `type:"integer"`

	// Timing Advance (TA).
	TimingAdvance *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Details about the Long-Term Evolution (LTE) network.

func (LteCellDetails) GoString added in v1.53.18 

func (s LteCellDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LteCellDetails) SetCellId added in v1.53.18 

func (s *LteCellDetails) SetCellId(v int64) *LteCellDetails

SetCellId sets the CellId field's value.

func (*LteCellDetails) SetLocalId added in v1.53.18 

func (s *LteCellDetails) SetLocalId(v *LteLocalId) *LteCellDetails

SetLocalId sets the LocalId field's value.

func (*LteCellDetails) SetMcc added in v1.53.18 

func (s *LteCellDetails) SetMcc(v int64) *LteCellDetails

SetMcc sets the Mcc field's value.

func (*LteCellDetails) SetMnc added in v1.53.18 

func (s *LteCellDetails) SetMnc(v int64) *LteCellDetails

SetMnc sets the Mnc field's value.

func (*LteCellDetails) SetNetworkMeasurements added in v1.53.18 

func (s *LteCellDetails) SetNetworkMeasurements(v []*LteNetworkMeasurements) *LteCellDetails

SetNetworkMeasurements sets the NetworkMeasurements field's value.

func (*LteCellDetails) SetNrCapable added in v1.53.18 

func (s *LteCellDetails) SetNrCapable(v bool) *LteCellDetails

SetNrCapable sets the NrCapable field's value.

func (*LteCellDetails) SetRsrp added in v1.53.18 

func (s *LteCellDetails) SetRsrp(v int64) *LteCellDetails

SetRsrp sets the Rsrp field's value.

func (*LteCellDetails) SetRsrq added in v1.53.18 

func (s *LteCellDetails) SetRsrq(v float64) *LteCellDetails

SetRsrq sets the Rsrq field's value.

func (*LteCellDetails) SetTac added in v1.53.18 

func (s *LteCellDetails) SetTac(v int64) *LteCellDetails

SetTac sets the Tac field's value.

func (*LteCellDetails) SetTimingAdvance added in v1.53.18 

func (s *LteCellDetails) SetTimingAdvance(v int64) *LteCellDetails

SetTimingAdvance sets the TimingAdvance field's value.

func (LteCellDetails) String added in v1.53.18 

func (s LteCellDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LteCellDetails) Validate added in v1.53.18 

func (s *LteCellDetails) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LteLocalId added in v1.53.18 

type LteLocalId struct {

	// E-UTRA (Evolved Universal Terrestrial Radio Access) absolute radio frequency
	// channel number (EARFCN).
	//
	// Earfcn is a required field
	Earfcn *int64 `type:"integer" required:"true"`

	// Physical Cell ID (PCI).
	//
	// Pci is a required field
	Pci *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

LTE local identification information (local ID).

func (LteLocalId) GoString added in v1.53.18 

func (s LteLocalId) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LteLocalId) SetEarfcn added in v1.53.18 

func (s *LteLocalId) SetEarfcn(v int64) *LteLocalId

SetEarfcn sets the Earfcn field's value.

func (*LteLocalId) SetPci added in v1.53.18 

func (s *LteLocalId) SetPci(v int64) *LteLocalId

SetPci sets the Pci field's value.

func (LteLocalId) String added in v1.53.18 

func (s LteLocalId) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LteLocalId) Validate added in v1.53.18 

func (s *LteLocalId) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LteNetworkMeasurements added in v1.53.18 

type LteNetworkMeasurements struct {

	// E-UTRAN Cell Identifier (ECI).
	//
	// CellId is a required field
	CellId *int64 `type:"integer" required:"true"`

	// E-UTRA (Evolved Universal Terrestrial Radio Access) absolute radio frequency
	// channel number (EARFCN).
	//
	// Earfcn is a required field
	Earfcn *int64 `type:"integer" required:"true"`

	// Physical Cell ID (PCI).
	//
	// Pci is a required field
	Pci *int64 `type:"integer" required:"true"`

	// Signal power of the reference signal received, measured in dBm (decibel-milliwatts).
	Rsrp *int64 `type:"integer"`

	// Signal quality of the reference Signal received, measured in decibels (dB).
	Rsrq *float64 `type:"float"`
	// contains filtered or unexported fields
}

LTE network measurements.

func (LteNetworkMeasurements) GoString added in v1.53.18 

func (s LteNetworkMeasurements) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LteNetworkMeasurements) SetCellId added in v1.53.18 

func (s *LteNetworkMeasurements) SetCellId(v int64) *LteNetworkMeasurements

SetCellId sets the CellId field's value.

func (*LteNetworkMeasurements) SetEarfcn added in v1.53.18 

func (s *LteNetworkMeasurements) SetEarfcn(v int64) *LteNetworkMeasurements

SetEarfcn sets the Earfcn field's value.

func (*LteNetworkMeasurements) SetPci added in v1.53.18 

func (s *LteNetworkMeasurements) SetPci(v int64) *LteNetworkMeasurements

SetPci sets the Pci field's value.

func (*LteNetworkMeasurements) SetRsrp added in v1.53.18 

func (s *LteNetworkMeasurements) SetRsrp(v int64) *LteNetworkMeasurements

SetRsrp sets the Rsrp field's value.

func (*LteNetworkMeasurements) SetRsrq added in v1.53.18 

func (s *LteNetworkMeasurements) SetRsrq(v float64) *LteNetworkMeasurements

SetRsrq sets the Rsrq field's value.

func (LteNetworkMeasurements) String added in v1.53.18 

func (s LteNetworkMeasurements) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LteNetworkMeasurements) Validate added in v1.53.18 

func (s *LteNetworkMeasurements) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MapConfiguration 

type MapConfiguration struct {

	// Specifies the custom layers for the style. Leave unset to not enable any
	// custom layer, or, for styles that support custom layers, you can enable layer(s),
	// such as POI layer for the VectorEsriNavigation style. Default is unset.
	//
	// Not all map resources or styles support custom layers. See Custom Layers
	// for more information.
	CustomLayers []*string `type:"list"`

	// Specifies the political view for the style. Leave unset to not use a political
	// view, or, for styles that support specific political views, you can choose
	// a view, such as IND for the Indian view.
	//
	// Default is unset.
	//
	// Not all map resources or styles support political view styles. See Political
	// views (https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html#political-views)
	// for more information.
	PoliticalView *string `min:"3" type:"string"`

	// Specifies the map style selected from an available data provider.
	//
	// Valid Esri map styles (https://docs.aws.amazon.com/location/latest/developerguide/esri.html):
	//
	//    * VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A
	//    vector basemap with a dark gray, neutral background with minimal colors,
	//    labels, and features that's designed to draw attention to your thematic
	//    content.
	//
	//    * RasterEsriImagery – The Esri Imagery map style. A raster basemap that
	//    provides one meter or better satellite and aerial imagery in many parts
	//    of the world and lower resolution satellite imagery worldwide.
	//
	//    * VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style,
	//    which provides a detailed vector basemap with a light gray, neutral background
	//    style with minimal colors, labels, and features that's designed to draw
	//    attention to your thematic content.
	//
	//    * VectorEsriTopographic – The Esri Light map style, which provides a
	//    detailed vector basemap with a classic Esri map style.
	//
	//    * VectorEsriStreets – The Esri Street Map style, which provides a detailed
	//    vector basemap for the world symbolized with a classic Esri street map
	//    style. The vector tile layer is similar in content and style to the World
	//    Street Map raster map.
	//
	//    * VectorEsriNavigation – The Esri Navigation map style, which provides
	//    a detailed basemap for the world symbolized with a custom navigation map
	//    style that's designed for use during the day in mobile devices.
	//
	// Valid HERE Technologies map styles (https://docs.aws.amazon.com/location/latest/developerguide/HERE.html):
	//
	//    * VectorHereContrast – The HERE Contrast (Berlin) map style is a high
	//    contrast detailed base map of the world that blends 3D and 2D rendering.
	//    The VectorHereContrast style has been renamed from VectorHereBerlin. VectorHereBerlin
	//    has been deprecated, but will continue to work in applications that use
	//    it.
	//
	//    * VectorHereExplore – A default HERE map style containing a neutral,
	//    global map and its features including roads, buildings, landmarks, and
	//    water features. It also now includes a fully designed map of Japan.
	//
	//    * VectorHereExploreTruck – A global map containing truck restrictions
	//    and attributes (e.g. width / height / HAZMAT) symbolized with highlighted
	//    segments and icons on top of HERE Explore to support use cases within
	//    transport and logistics.
	//
	//    * RasterHereExploreSatellite – A global map containing high resolution
	//    satellite imagery.
	//
	//    * HybridHereExploreSatellite – A global map displaying the road network,
	//    street names, and city labels over satellite imagery. This style will
	//    automatically retrieve both raster and vector tiles, and your charges
	//    will be based on total tiles retrieved. Hybrid styles use both vector
	//    and raster tiles when rendering the map that you see. This means that
	//    more tiles are retrieved than when using either vector or raster tiles
	//    alone. Your charges will include all tiles retrieved.
	//
	// Valid GrabMaps map styles (https://docs.aws.amazon.com/location/latest/developerguide/grab.html):
	//
	//    * VectorGrabStandardLight – The Grab Standard Light map style provides
	//    a basemap with detailed land use coloring, area names, roads, landmarks,
	//    and points of interest covering Southeast Asia.
	//
	//    * VectorGrabStandardDark – The Grab Standard Dark map style provides
	//    a dark variation of the standard basemap covering Southeast Asia.
	//
	// Grab provides maps only for countries in Southeast Asia, and is only available
	// in the Asia Pacific (Singapore) Region (ap-southeast-1). For more information,
	// see GrabMaps countries and area covered (https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area).
	//
	// Valid Open Data map styles (https://docs.aws.amazon.com/location/latest/developerguide/open-data.html):
	//
	//    * VectorOpenDataStandardLight – The Open Data Standard Light map style
	//    provides a detailed basemap for the world suitable for website and mobile
	//    application use. The map includes highways major roads, minor roads, railways,
	//    water features, cities, parks, landmarks, building footprints, and administrative
	//    boundaries.
	//
	//    * VectorOpenDataStandardDark – Open Data Standard Dark is a dark-themed
	//    map style that provides a detailed basemap for the world suitable for
	//    website and mobile application use. The map includes highways major roads,
	//    minor roads, railways, water features, cities, parks, landmarks, building
	//    footprints, and administrative boundaries.
	//
	//    * VectorOpenDataVisualizationLight – The Open Data Visualization Light
	//    map style is a light-themed style with muted colors and fewer features
	//    that aids in understanding overlaid data.
	//
	//    * VectorOpenDataVisualizationDark – The Open Data Visualization Dark
	//    map style is a dark-themed style with muted colors and fewer features
	//    that aids in understanding overlaid data.
	//
	// Style is a required field
	Style *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies the map tile style selected from an available provider.

func (MapConfiguration) GoString 

func (s MapConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MapConfiguration) SetCustomLayers added in v1.49.18 

func (s *MapConfiguration) SetCustomLayers(v []*string) *MapConfiguration

SetCustomLayers sets the CustomLayers field's value.

func (*MapConfiguration) SetPoliticalView added in v1.44.272 

func (s *MapConfiguration) SetPoliticalView(v string) *MapConfiguration

SetPoliticalView sets the PoliticalView field's value.

func (*MapConfiguration) SetStyle 

func (s *MapConfiguration) SetStyle(v string) *MapConfiguration

SetStyle sets the Style field's value.

func (MapConfiguration) String 

func (s MapConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MapConfiguration) Validate 

func (s *MapConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MapConfigurationUpdate added in v1.44.272 

type MapConfigurationUpdate struct {

	// Specifies the custom layers for the style. Leave unset to not enable any
	// custom layer, or, for styles that support custom layers, you can enable layer(s),
	// such as POI layer for the VectorEsriNavigation style. Default is unset.
	//
	// Not all map resources or styles support custom layers. See Custom Layers
	// for more information.
	CustomLayers []*string `type:"list"`

	// Specifies the political view for the style. Set to an empty string to not
	// use a political view, or, for styles that support specific political views,
	// you can choose a view, such as IND for the Indian view.
	//
	// Not all map resources or styles support political view styles. See Political
	// views (https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html#political-views)
	// for more information.
	PoliticalView *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the political view for the style.

func (MapConfigurationUpdate) GoString added in v1.44.272 

func (s MapConfigurationUpdate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MapConfigurationUpdate) SetCustomLayers added in v1.49.18 

func (s *MapConfigurationUpdate) SetCustomLayers(v []*string) *MapConfigurationUpdate

SetCustomLayers sets the CustomLayers field's value.

func (*MapConfigurationUpdate) SetPoliticalView added in v1.44.272 

func (s *MapConfigurationUpdate) SetPoliticalView(v string) *MapConfigurationUpdate

SetPoliticalView sets the PoliticalView field's value.

func (MapConfigurationUpdate) String added in v1.44.272 

func (s MapConfigurationUpdate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Place 

type Place struct {

	// The numerical portion of an address, such as a building number.
	AddressNumber *string `type:"string"`

	// The Amazon Location categories that describe this Place.
	//
	// For more information about using categories, including a list of Amazon Location
	// categories, see Categories and filtering (https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html),
	// in the Amazon Location Service Developer Guide.
	Categories []*string `min:"1" type:"list"`

	// A country/region specified using ISO 3166 (https://www.iso.org/iso-3166-country-codes.html)
	// 3-digit country/region code. For example, CAN.
	Country *string `type:"string"`

	// Places uses a point geometry to specify a location or a Place.
	//
	// Geometry is a required field
	Geometry *PlaceGeometry `type:"structure" required:"true"`

	// True if the result is interpolated from other known places.
	//
	// False if the Place is a known place.
	//
	// Not returned when the partner does not provide the information.
	//
	// For example, returns False for an address location that is found in the partner
	// data, but returns True if an address does not exist in the partner data and
	// its location is calculated by interpolating between other known addresses.
	Interpolated *bool `type:"boolean"`

	// The full name and address of the point of interest such as a city, region,
	// or country. For example, 123 Any Street, Any Town, USA.
	Label *string `type:"string"`

	// A name for a local area, such as a city or town name. For example, Toronto.
	Municipality *string `type:"string"`

	// The name of a community district. For example, Downtown.
	Neighborhood *string `type:"string"`

	// A group of numbers and letters in a country-specific format, which accompanies
	// the address for the purpose of identifying a location.
	PostalCode *string `type:"string"`

	// A name for an area or geographical division, such as a province or state
	// name. For example, British Columbia.
	Region *string `type:"string"`

	// The name for a street or a road to identify a location. For example, Main
	// Street.
	Street *string `type:"string"`

	// An area that's part of a larger municipality. For example, Blissville is
	// a submunicipality in the Queen County in New York.
	//
	// This property supported by Esri and OpenData. The Esri property is district,
	// and the OpenData property is borough.
	SubMunicipality *string `type:"string"`

	// A county, or an area that's part of a larger region. For example, Metro Vancouver.
	SubRegion *string `type:"string"`

	// Categories from the data provider that describe the Place that are not mapped
	// to any Amazon Location categories.
	SupplementalCategories []*string `min:"1" type:"list"`

	// The time zone in which the Place is located. Returned only when using HERE
	// or Grab as the selected partner.
	TimeZone *TimeZone `type:"structure"`

	// For addresses with multiple units, the unit identifier. Can include numbers
	// and letters, for example 3B or Unit 123.
	//
	// Returned only for a place index that uses Esri or Grab as a data provider.
	// Is not returned for SearchPlaceIndexForPosition.
	UnitNumber *string `type:"string"`

	// For addresses with a UnitNumber, the type of unit. For example, Apartment.
	//
	// Returned only for a place index that uses Esri as a data provider.
	UnitType *string `type:"string"`
	// contains filtered or unexported fields
}

Contains details about addresses or points of interest that match the search criteria.

Not all details are included with all responses. Some details may only be returned by specific data partners.

func (Place) GoString 

func (s Place) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Place) SetAddressNumber 

func (s *Place) SetAddressNumber(v string) *Place

SetAddressNumber sets the AddressNumber field's value.

func (*Place) SetCategories added in v1.44.283 

func (s *Place) SetCategories(v []*string) *Place

SetCategories sets the Categories field's value.

func (*Place) SetCountry 

func (s *Place) SetCountry(v string) *Place

SetCountry sets the Country field's value.

func (*Place) SetGeometry 

func (s *Place) SetGeometry(v *PlaceGeometry) *Place

SetGeometry sets the Geometry field's value.

func (*Place) SetInterpolated added in v1.42.6 

func (s *Place) SetInterpolated(v bool) *Place

SetInterpolated sets the Interpolated field's value.

func (*Place) SetLabel 

func (s *Place) SetLabel(v string) *Place

SetLabel sets the Label field's value.

func (*Place) SetMunicipality 

func (s *Place) SetMunicipality(v string) *Place

SetMunicipality sets the Municipality field's value.

func (*Place) SetNeighborhood 

func (s *Place) SetNeighborhood(v string) *Place

SetNeighborhood sets the Neighborhood field's value.

func (*Place) SetPostalCode 

func (s *Place) SetPostalCode(v string) *Place

SetPostalCode sets the PostalCode field's value.

func (*Place) SetRegion 

func (s *Place) SetRegion(v string) *Place

SetRegion sets the Region field's value.

func (*Place) SetStreet 

func (s *Place) SetStreet(v string) *Place

SetStreet sets the Street field's value.

func (*Place) SetSubMunicipality added in v1.49.1 

func (s *Place) SetSubMunicipality(v string) *Place

SetSubMunicipality sets the SubMunicipality field's value.

func (*Place) SetSubRegion 

func (s *Place) SetSubRegion(v string) *Place

SetSubRegion sets the SubRegion field's value.

func (*Place) SetSupplementalCategories added in v1.44.283 

func (s *Place) SetSupplementalCategories(v []*string) *Place

SetSupplementalCategories sets the SupplementalCategories field's value.

func (*Place) SetTimeZone added in v1.42.6 

func (s *Place) SetTimeZone(v *TimeZone) *Place

SetTimeZone sets the TimeZone field's value.

func (*Place) SetUnitNumber added in v1.44.107 

func (s *Place) SetUnitNumber(v string) *Place

SetUnitNumber sets the UnitNumber field's value.

func (*Place) SetUnitType added in v1.44.107 

func (s *Place) SetUnitType(v string) *Place

SetUnitType sets the UnitType field's value.

func (Place) String 

func (s Place) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PlaceGeometry 

type PlaceGeometry struct {

	// A single point geometry specifies a location for a Place using WGS 84 (https://gisgeography.com/wgs84-world-geodetic-system/)
	// coordinates:
	//
	//    * x — Specifies the x coordinate or longitude.
	//
	//    * y — Specifies the y coordinate or latitude.
	//
	// Point is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PlaceGeometry's
	// String and GoString methods.
	Point []*float64 `min:"2" type:"list" sensitive:"true"`
	// contains filtered or unexported fields
}

Places uses a point geometry to specify a location or a Place.

func (PlaceGeometry) GoString 

func (s PlaceGeometry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PlaceGeometry) SetPoint 

func (s *PlaceGeometry) SetPoint(v []*float64) *PlaceGeometry

SetPoint sets the Point field's value.

func (PlaceGeometry) String 

func (s PlaceGeometry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PositionalAccuracy added in v1.42.20 

type PositionalAccuracy struct {

	// Estimated maximum distance, in meters, between the measured position and
	// the true position of a device, along the Earth's surface.
	//
	// Horizontal is a required field
	Horizontal *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

Defines the level of certainty of the position.

func (PositionalAccuracy) GoString added in v1.42.20 

func (s PositionalAccuracy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PositionalAccuracy) SetHorizontal added in v1.42.20 

func (s *PositionalAccuracy) SetHorizontal(v float64) *PositionalAccuracy

SetHorizontal sets the Horizontal field's value.

func (PositionalAccuracy) String added in v1.42.20 

func (s PositionalAccuracy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PositionalAccuracy) Validate added in v1.42.20 

func (s *PositionalAccuracy) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutGeofenceInput 

type PutGeofenceInput struct {

	// The geofence collection to store the geofence in.
	//
	// CollectionName is a required field
	CollectionName *string `location:"uri" locationName:"CollectionName" min:"1" type:"string" required:"true"`

	// An identifier for the geofence. For example, ExampleGeofence-1.
	//
	// GeofenceId is a required field
	GeofenceId *string `location:"uri" locationName:"GeofenceId" min:"1" type:"string" required:"true"`

	// 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PutGeofenceInput's
	// String and GoString methods.
	GeofenceProperties map[string]*string `type:"map" sensitive:"true"`

	// 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 (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html)
	// format supports a maximum of 1,000 vertices. The Geofence Geobuf (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html)
	// format supports a maximum of 100,000 vertices.
	//
	// Geometry is a required field
	Geometry *GeofenceGeometry `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutGeofenceInput) GoString 

func (s PutGeofenceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutGeofenceInput) SetCollectionName 

func (s *PutGeofenceInput) SetCollectionName(v string) *PutGeofenceInput

SetCollectionName sets the CollectionName field's value.

func (*PutGeofenceInput) SetGeofenceId 

func (s *PutGeofenceInput) SetGeofenceId(v string) *PutGeofenceInput

SetGeofenceId sets the GeofenceId field's value.

func (*PutGeofenceInput) SetGeofenceProperties added in v1.44.283 

func (s *PutGeofenceInput) SetGeofenceProperties(v map[string]*string) *PutGeofenceInput

SetGeofenceProperties sets the GeofenceProperties field's value.

func (*PutGeofenceInput) SetGeometry 

func (s *PutGeofenceInput) SetGeometry(v *GeofenceGeometry) *PutGeofenceInput

SetGeometry sets the Geometry field's value.

func (PutGeofenceInput) String 

func (s PutGeofenceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutGeofenceInput) Validate 

func (s *PutGeofenceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The geofence identifier entered in the request.
	//
	// GeofenceId is a required field
	GeofenceId *string `min:"1" type:"string" required:"true"`

	// 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
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (PutGeofenceOutput) GoString 

func (s PutGeofenceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutGeofenceOutput) SetCreateTime 

func (s *PutGeofenceOutput) SetCreateTime(v time.Time) *PutGeofenceOutput

SetCreateTime sets the CreateTime field's value.

func (*PutGeofenceOutput) SetGeofenceId 

func (s *PutGeofenceOutput) SetGeofenceId(v string) *PutGeofenceOutput

SetGeofenceId sets the GeofenceId field's value.

func (*PutGeofenceOutput) SetUpdateTime 

func (s *PutGeofenceOutput) SetUpdateTime(v time.Time) *PutGeofenceOutput

SetUpdateTime sets the UpdateTime field's value.

func (PutGeofenceOutput) String 

func (s PutGeofenceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resource that you've entered was not found in your AWS account.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RouteMatrixEntry added in v1.42.36 

type RouteMatrixEntry struct {

	// The total distance of travel for the route.
	Distance *float64 `type:"double"`

	// The expected duration of travel for the route.
	DurationSeconds *float64 `type:"double"`

	// An error corresponding to the calculation of a route between the DeparturePosition
	// and DestinationPosition.
	Error *RouteMatrixEntryError `type:"structure"`
	// contains filtered or unexported fields
}

The result for the calculated route of one DeparturePosition DestinationPosition pair.

func (RouteMatrixEntry) GoString added in v1.42.36 

func (s RouteMatrixEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RouteMatrixEntry) SetDistance added in v1.42.36 

func (s *RouteMatrixEntry) SetDistance(v float64) *RouteMatrixEntry

SetDistance sets the Distance field's value.

func (*RouteMatrixEntry) SetDurationSeconds added in v1.42.36 

func (s *RouteMatrixEntry) SetDurationSeconds(v float64) *RouteMatrixEntry

SetDurationSeconds sets the DurationSeconds field's value.

func (*RouteMatrixEntry) SetError added in v1.42.36 

func (s *RouteMatrixEntry) SetError(v *RouteMatrixEntryError) *RouteMatrixEntry

SetError sets the Error field's value.

func (RouteMatrixEntry) String added in v1.42.36 

func (s RouteMatrixEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RouteMatrixEntryError added in v1.42.36 

type RouteMatrixEntryError struct {

	// The type of error which occurred for the route calculation.
	//
	// Code is a required field
	Code *string `type:"string" required:"true" enum:"RouteMatrixErrorCode"`

	// A message about the error that occurred for the route calculation.
	Message *string `type:"string"`
	// contains filtered or unexported fields
}

An error corresponding to the calculation of a route between the DeparturePosition and DestinationPosition.

The error code can be one of the following:

  • RouteNotFound - Unable to find a valid route with the given parameters.

  • RouteTooLong - Route calculation went beyond the maximum size of a route and was terminated before completion.

  • PositionsNotFound - One or more of the input positions were not found on the route network.

  • DestinationPositionNotFound - The destination position was not found on the route network.

  • DeparturePositionNotFound - The departure position was not found on the route network.

  • OtherValidationError - The given inputs were not valid or a route was not found. More information is given in the error Message

func (RouteMatrixEntryError) GoString added in v1.42.36 

func (s RouteMatrixEntryError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RouteMatrixEntryError) SetCode added in v1.42.36 

func (s *RouteMatrixEntryError) SetCode(v string) *RouteMatrixEntryError

SetCode sets the Code field's value.

func (*RouteMatrixEntryError) SetMessage added in v1.42.36 

func (s *RouteMatrixEntryError) SetMessage(v string) *RouteMatrixEntryError

SetMessage sets the Message field's value.

func (RouteMatrixEntryError) String added in v1.42.36 

func (s RouteMatrixEntryError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchForPositionResult 

type SearchForPositionResult struct {

	// The distance in meters of a great-circle arc between the query position and
	// the result.
	//
	// A great-circle arc is the shortest path on a sphere, in this case the Earth.
	// This returns the shortest distance between two locations.
	//
	// Distance is a required field
	Distance *float64 `type:"double" required:"true"`

	// Details about the search result, such as its address and position.
	//
	// Place is a required field
	Place *Place `type:"structure" required:"true"`

	// The unique identifier of the place. You can use this with the GetPlace operation
	// to find the place again later.
	//
	// For SearchPlaceIndexForPosition operations, the PlaceId is returned only
	// by place indexes that use HERE or Grab as a data provider.
	PlaceId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains a search result from a position search query that is run on a place index resource.

func (SearchForPositionResult) GoString 

func (s SearchForPositionResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchForPositionResult) SetDistance added in v1.42.6 

func (s *SearchForPositionResult) SetDistance(v float64) *SearchForPositionResult

SetDistance sets the Distance field's value.

func (*SearchForPositionResult) SetPlace 

func (s *SearchForPositionResult) SetPlace(v *Place) *SearchForPositionResult

SetPlace sets the Place field's value.

func (*SearchForPositionResult) SetPlaceId added in v1.44.107 

func (s *SearchForPositionResult) SetPlaceId(v string) *SearchForPositionResult

SetPlaceId sets the PlaceId field's value.

func (SearchForPositionResult) String 

func (s SearchForPositionResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchForSuggestionsResult added in v1.42.20 

type SearchForSuggestionsResult struct {

	// The Amazon Location categories that describe the Place.
	//
	// For more information about using categories, including a list of Amazon Location
	// categories, see Categories and filtering (https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html),
	// in the Amazon Location Service Developer Guide.
	Categories []*string `min:"1" type:"list"`

	// The unique identifier of the Place. You can use this with the GetPlace operation
	// to find the place again later, or to get full information for the Place.
	//
	// The GetPlace request must use the same PlaceIndex resource as the SearchPlaceIndexForSuggestions
	// that generated the Place ID.
	//
	// For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by
	// place indexes that use Esri, Grab, or HERE as data providers.
	PlaceId *string `type:"string"`

	// Categories from the data provider that describe the Place that are not mapped
	// to any Amazon Location categories.
	SupplementalCategories []*string `min:"1" type:"list"`

	// The text of the place suggestion, typically formatted as an address string.
	//
	// Text is a required field
	Text *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.

func (SearchForSuggestionsResult) GoString added in v1.42.20 

func (s SearchForSuggestionsResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchForSuggestionsResult) SetCategories added in v1.44.283 

func (s *SearchForSuggestionsResult) SetCategories(v []*string) *SearchForSuggestionsResult

SetCategories sets the Categories field's value.

func (*SearchForSuggestionsResult) SetPlaceId added in v1.44.107 

func (s *SearchForSuggestionsResult) SetPlaceId(v string) *SearchForSuggestionsResult

SetPlaceId sets the PlaceId field's value.

func (*SearchForSuggestionsResult) SetSupplementalCategories added in v1.44.283 

func (s *SearchForSuggestionsResult) SetSupplementalCategories(v []*string) *SearchForSuggestionsResult

SetSupplementalCategories sets the SupplementalCategories field's value.

func (*SearchForSuggestionsResult) SetText added in v1.42.20 

func (s *SearchForSuggestionsResult) SetText(v string) *SearchForSuggestionsResult

SetText sets the Text field's value.

func (SearchForSuggestionsResult) String added in v1.42.20 

func (s SearchForSuggestionsResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchForTextResult 

type SearchForTextResult struct {

	// The distance in meters of a great-circle arc between the bias position specified
	// and the result. Distance will be returned only if a bias position was specified
	// in the query.
	//
	// A great-circle arc is the shortest path on a sphere, in this case the Earth.
	// This returns the shortest distance between two locations.
	Distance *float64 `type:"double"`

	// Details about the search result, such as its address and position.
	//
	// Place is a required field
	Place *Place `type:"structure" required:"true"`

	// The unique identifier of the place. You can use this with the GetPlace operation
	// to find the place again later.
	//
	// For SearchPlaceIndexForText operations, the PlaceId is returned only by place
	// indexes that use HERE or Grab as a data provider.
	PlaceId *string `type:"string"`

	// The relative confidence in the match for a result among the results returned.
	// For example, if more fields for an address match (including house number,
	// street, city, country/region, and postal code), the relevance score is closer
	// to 1.
	//
	// Returned only when the partner selected is Esri or Grab.
	Relevance *float64 `type:"double"`
	// contains filtered or unexported fields
}

Contains a search result from a text search query that is run on a place index resource.

func (SearchForTextResult) GoString 

func (s SearchForTextResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchForTextResult) SetDistance added in v1.42.6 

func (s *SearchForTextResult) SetDistance(v float64) *SearchForTextResult

SetDistance sets the Distance field's value.

func (*SearchForTextResult) SetPlace 

func (s *SearchForTextResult) SetPlace(v *Place) *SearchForTextResult

SetPlace sets the Place field's value.

func (*SearchForTextResult) SetPlaceId added in v1.44.107 

func (s *SearchForTextResult) SetPlaceId(v string) *SearchForTextResult

SetPlaceId sets the PlaceId field's value.

func (*SearchForTextResult) SetRelevance added in v1.42.6 

func (s *SearchForTextResult) SetRelevance(v float64) *SearchForTextResult

SetRelevance sets the Relevance field's value.

func (SearchForTextResult) String 

func (s SearchForTextResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchPlaceIndexForPositionInput 

type SearchPlaceIndexForPositionInput struct {

	// The name of the place index resource you want to use for the search.
	//
	// IndexName is a required field
	IndexName *string `location:"uri" locationName:"IndexName" min:"1" type:"string" required:"true"`

	// The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html)
	// to authorize the request.
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForPositionInput's
	// String and GoString methods.
	Key *string `location:"querystring" locationName:"key" type:"string" sensitive:"true"`

	// The preferred language used to return results. The value must be a valid
	// BCP 47 (https://tools.ietf.org/search/bcp47) 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.
	Language *string `min:"2" type:"string"`

	// An optional parameter. The maximum number of results returned per request.
	//
	// Default value: 50
	MaxResults *int64 `min:"1" type:"integer"`

	// 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.
	//
	// Position is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForPositionInput's
	// String and GoString methods.
	//
	// Position is a required field
	Position []*float64 `min:"2" type:"list" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (SearchPlaceIndexForPositionInput) GoString 

func (s SearchPlaceIndexForPositionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchPlaceIndexForPositionInput) SetIndexName 

func (s *SearchPlaceIndexForPositionInput) SetIndexName(v string) *SearchPlaceIndexForPositionInput

SetIndexName sets the IndexName field's value.

func (*SearchPlaceIndexForPositionInput) SetKey added in v1.44.297 

func (s *SearchPlaceIndexForPositionInput) SetKey(v string) *SearchPlaceIndexForPositionInput

SetKey sets the Key field's value.

func (*SearchPlaceIndexForPositionInput) SetLanguage added in v1.42.6 

func (s *SearchPlaceIndexForPositionInput) SetLanguage(v string) *SearchPlaceIndexForPositionInput

SetLanguage sets the Language field's value.

func (*SearchPlaceIndexForPositionInput) SetMaxResults 

func (s *SearchPlaceIndexForPositionInput) SetMaxResults(v int64) *SearchPlaceIndexForPositionInput

SetMaxResults sets the MaxResults field's value.

func (*SearchPlaceIndexForPositionInput) SetPosition 

func (s *SearchPlaceIndexForPositionInput) SetPosition(v []*float64) *SearchPlaceIndexForPositionInput

SetPosition sets the Position field's value.

func (SearchPlaceIndexForPositionInput) String 

func (s SearchPlaceIndexForPositionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchPlaceIndexForPositionInput) Validate 

func (s *SearchPlaceIndexForPositionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchPlaceIndexForPositionOutput 

type SearchPlaceIndexForPositionOutput struct {

	// Returns a list of Places closest to the specified position. Each result contains
	// additional information about the Places returned.
	//
	// Results is a required field
	Results []*SearchForPositionResult `type:"list" required:"true"`

	// Contains a summary of the request. Echoes the input values for Position,
	// Language, MaxResults, and the DataSource of the place index.
	//
	// Summary is a required field
	Summary *SearchPlaceIndexForPositionSummary `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SearchPlaceIndexForPositionOutput) GoString 

func (s SearchPlaceIndexForPositionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchPlaceIndexForPositionOutput) SetResults 

func (s *SearchPlaceIndexForPositionOutput) SetResults(v []*SearchForPositionResult) *SearchPlaceIndexForPositionOutput

SetResults sets the Results field's value.

func (*SearchPlaceIndexForPositionOutput) SetSummary 

func (s *SearchPlaceIndexForPositionOutput) SetSummary(v *SearchPlaceIndexForPositionSummary) *SearchPlaceIndexForPositionOutput

SetSummary sets the Summary field's value.

func (SearchPlaceIndexForPositionOutput) String 

func (s SearchPlaceIndexForPositionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchPlaceIndexForPositionSummary 

type SearchPlaceIndexForPositionSummary struct {

	// The geospatial data provider attached to the place index resource specified
	// in the request. Values can be one of the following:
	//
	//    * Esri
	//
	//    * Grab
	//
	//    * Here
	//
	// For more information about data providers, see Amazon Location Service data
	// providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html).
	//
	// DataSource is a required field
	DataSource *string `type:"string" required:"true"`

	// The preferred language used to return results. Matches the language in the
	// request. The value is a valid BCP 47 (https://tools.ietf.org/search/bcp47)
	// language tag, for example, en for English.
	Language *string `min:"2" type:"string"`

	// Contains the optional result count limit that is specified in the request.
	//
	// Default value: 50
	MaxResults *int64 `min:"1" type:"integer"`

	// The position specified in the request.
	//
	// Position is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForPositionSummary's
	// String and GoString methods.
	//
	// Position is a required field
	Position []*float64 `min:"2" type:"list" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

A summary of the request sent by using SearchPlaceIndexForPosition.

func (SearchPlaceIndexForPositionSummary) GoString 

func (s SearchPlaceIndexForPositionSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchPlaceIndexForPositionSummary) SetDataSource 

func (s *SearchPlaceIndexForPositionSummary) SetDataSource(v string) *SearchPlaceIndexForPositionSummary

SetDataSource sets the DataSource field's value.

func (*SearchPlaceIndexForPositionSummary) SetLanguage added in v1.42.6 

func (s *SearchPlaceIndexForPositionSummary) SetLanguage(v string) *SearchPlaceIndexForPositionSummary

SetLanguage sets the Language field's value.

func (*SearchPlaceIndexForPositionSummary) SetMaxResults 

func (s *SearchPlaceIndexForPositionSummary) SetMaxResults(v int64) *SearchPlaceIndexForPositionSummary

SetMaxResults sets the MaxResults field's value.

func (*SearchPlaceIndexForPositionSummary) SetPosition 

func (s *SearchPlaceIndexForPositionSummary) SetPosition(v []*float64) *SearchPlaceIndexForPositionSummary

SetPosition sets the Position field's value.

func (SearchPlaceIndexForPositionSummary) String 

func (s SearchPlaceIndexForPositionSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchPlaceIndexForSuggestionsInput added in v1.42.20 

type SearchPlaceIndexForSuggestionsInput struct {

	// 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForSuggestionsInput's
	// String and GoString methods.
	BiasPosition []*float64 `min:"2" type:"list" sensitive:"true"`

	// 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForSuggestionsInput's
	// String and GoString methods.
	FilterBBox []*float64 `min:"4" type:"list" sensitive:"true"`

	// 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 (https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html),
	// in the Amazon Location Service Developer Guide.
	FilterCategories []*string `min:"1" type:"list"`

	// An optional parameter that limits the search results by returning only suggestions
	// within the provided list of countries.
	//
	//    * 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 `min:"1" type:"list"`

	// The name of the place index resource you want to use for the search.
	//
	// IndexName is a required field
	IndexName *string `location:"uri" locationName:"IndexName" min:"1" type:"string" required:"true"`

	// The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html)
	// to authorize the request.
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForSuggestionsInput's
	// String and GoString methods.
	Key *string `location:"querystring" locationName:"key" type:"string" sensitive:"true"`

	// The preferred language used to return results. The value must be a valid
	// BCP 47 (https://tools.ietf.org/search/bcp47) 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.
	Language *string `min:"2" type:"string"`

	// An optional parameter. The maximum number of results returned per request.
	//
	// The default: 5
	MaxResults *int64 `min:"1" type:"integer"`

	// The free-form partial text to use to generate place suggestions. For example,
	// eiffel tow.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForSuggestionsInput's
	// String and GoString methods.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (SearchPlaceIndexForSuggestionsInput) GoString added in v1.42.20 

func (s SearchPlaceIndexForSuggestionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchPlaceIndexForSuggestionsInput) SetBiasPosition added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsInput) SetBiasPosition(v []*float64) *SearchPlaceIndexForSuggestionsInput

SetBiasPosition sets the BiasPosition field's value.

func (*SearchPlaceIndexForSuggestionsInput) SetFilterBBox added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsInput) SetFilterBBox(v []*float64) *SearchPlaceIndexForSuggestionsInput

SetFilterBBox sets the FilterBBox field's value.

func (*SearchPlaceIndexForSuggestionsInput) SetFilterCategories added in v1.44.283 

func (s *SearchPlaceIndexForSuggestionsInput) SetFilterCategories(v []*string) *SearchPlaceIndexForSuggestionsInput

SetFilterCategories sets the FilterCategories field's value.

func (*SearchPlaceIndexForSuggestionsInput) SetFilterCountries added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsInput) SetFilterCountries(v []*string) *SearchPlaceIndexForSuggestionsInput

SetFilterCountries sets the FilterCountries field's value.

func (*SearchPlaceIndexForSuggestionsInput) SetIndexName added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsInput) SetIndexName(v string) *SearchPlaceIndexForSuggestionsInput

SetIndexName sets the IndexName field's value.

func (*SearchPlaceIndexForSuggestionsInput) SetKey added in v1.44.297 

func (s *SearchPlaceIndexForSuggestionsInput) SetKey(v string) *SearchPlaceIndexForSuggestionsInput

SetKey sets the Key field's value.

func (*SearchPlaceIndexForSuggestionsInput) SetLanguage added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsInput) SetLanguage(v string) *SearchPlaceIndexForSuggestionsInput

SetLanguage sets the Language field's value.

func (*SearchPlaceIndexForSuggestionsInput) SetMaxResults added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsInput) SetMaxResults(v int64) *SearchPlaceIndexForSuggestionsInput

SetMaxResults sets the MaxResults field's value.

func (*SearchPlaceIndexForSuggestionsInput) SetText added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsInput) SetText(v string) *SearchPlaceIndexForSuggestionsInput

SetText sets the Text field's value.

func (SearchPlaceIndexForSuggestionsInput) String added in v1.42.20 

func (s SearchPlaceIndexForSuggestionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchPlaceIndexForSuggestionsInput) Validate added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchPlaceIndexForSuggestionsOutput added in v1.42.20 

type SearchPlaceIndexForSuggestionsOutput struct {

	// A list of place suggestions that best match the search text.
	//
	// Results is a required field
	Results []*SearchForSuggestionsResult `type:"list" required:"true"`

	// 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.
	//
	// Summary is a required field
	Summary *SearchPlaceIndexForSuggestionsSummary `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SearchPlaceIndexForSuggestionsOutput) GoString added in v1.42.20 

func (s SearchPlaceIndexForSuggestionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchPlaceIndexForSuggestionsOutput) SetResults added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsOutput) SetResults(v []*SearchForSuggestionsResult) *SearchPlaceIndexForSuggestionsOutput

SetResults sets the Results field's value.

func (*SearchPlaceIndexForSuggestionsOutput) SetSummary added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsOutput) SetSummary(v *SearchPlaceIndexForSuggestionsSummary) *SearchPlaceIndexForSuggestionsOutput

SetSummary sets the Summary field's value.

func (SearchPlaceIndexForSuggestionsOutput) String added in v1.42.20 

func (s SearchPlaceIndexForSuggestionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchPlaceIndexForSuggestionsSummary added in v1.42.20 

type SearchPlaceIndexForSuggestionsSummary struct {

	// Contains the coordinates for the optional bias position specified in the
	// request.
	//
	// This parameter contains 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForSuggestionsSummary's
	// String and GoString methods.
	BiasPosition []*float64 `min:"2" type:"list" sensitive:"true"`

	// The geospatial data provider attached to the place index resource specified
	// in the request. Values can be one of the following:
	//
	//    * Esri
	//
	//    * Grab
	//
	//    * Here
	//
	// For more information about data providers, see Amazon Location Service data
	// providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html).
	//
	// DataSource is a required field
	DataSource *string `type:"string" required:"true"`

	// Contains the coordinates for the optional bounding box specified in the request.
	//
	// FilterBBox is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForSuggestionsSummary's
	// String and GoString methods.
	FilterBBox []*float64 `min:"4" type:"list" sensitive:"true"`

	// The optional category filter specified in the request.
	FilterCategories []*string `min:"1" type:"list"`

	// Contains the optional country filter specified in the request.
	FilterCountries []*string `min:"1" type:"list"`

	// The preferred language used to return results. Matches the language in the
	// request. The value is a valid BCP 47 (https://tools.ietf.org/search/bcp47)
	// language tag, for example, en for English.
	Language *string `min:"2" type:"string"`

	// Contains the optional result count limit specified in the request.
	MaxResults *int64 `type:"integer"`

	// The free-form partial text input specified in the request.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForSuggestionsSummary's
	// String and GoString methods.
	//
	// Text is a required field
	Text *string `type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

A summary of the request sent by using SearchPlaceIndexForSuggestions.

func (SearchPlaceIndexForSuggestionsSummary) GoString added in v1.42.20 

func (s SearchPlaceIndexForSuggestionsSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchPlaceIndexForSuggestionsSummary) SetBiasPosition added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsSummary) SetBiasPosition(v []*float64) *SearchPlaceIndexForSuggestionsSummary

SetBiasPosition sets the BiasPosition field's value.

func (*SearchPlaceIndexForSuggestionsSummary) SetDataSource added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsSummary) SetDataSource(v string) *SearchPlaceIndexForSuggestionsSummary

SetDataSource sets the DataSource field's value.

func (*SearchPlaceIndexForSuggestionsSummary) SetFilterBBox added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsSummary) SetFilterBBox(v []*float64) *SearchPlaceIndexForSuggestionsSummary

SetFilterBBox sets the FilterBBox field's value.

func (*SearchPlaceIndexForSuggestionsSummary) SetFilterCategories added in v1.44.283 

func (s *SearchPlaceIndexForSuggestionsSummary) SetFilterCategories(v []*string) *SearchPlaceIndexForSuggestionsSummary

SetFilterCategories sets the FilterCategories field's value.

func (*SearchPlaceIndexForSuggestionsSummary) SetFilterCountries added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsSummary) SetFilterCountries(v []*string) *SearchPlaceIndexForSuggestionsSummary

SetFilterCountries sets the FilterCountries field's value.

func (*SearchPlaceIndexForSuggestionsSummary) SetLanguage added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsSummary) SetLanguage(v string) *SearchPlaceIndexForSuggestionsSummary

SetLanguage sets the Language field's value.

func (*SearchPlaceIndexForSuggestionsSummary) SetMaxResults added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsSummary) SetMaxResults(v int64) *SearchPlaceIndexForSuggestionsSummary

SetMaxResults sets the MaxResults field's value.

func (*SearchPlaceIndexForSuggestionsSummary) SetText added in v1.42.20 

func (s *SearchPlaceIndexForSuggestionsSummary) SetText(v string) *SearchPlaceIndexForSuggestionsSummary

SetText sets the Text field's value.

func (SearchPlaceIndexForSuggestionsSummary) String added in v1.42.20 

func (s SearchPlaceIndexForSuggestionsSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchPlaceIndexForTextInput 

type SearchPlaceIndexForTextInput struct {

	// 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForTextInput's
	// String and GoString methods.
	BiasPosition []*float64 `min:"2" type:"list" sensitive:"true"`

	// 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForTextInput's
	// String and GoString methods.
	FilterBBox []*float64 `min:"4" type:"list" sensitive:"true"`

	// 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 (https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html),
	// in the Amazon Location Service Developer Guide.
	FilterCategories []*string `min:"1" type:"list"`

	// 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 (https://www.iso.org/iso-3166-country-codes.html)
	//    3-digit country codes. For example, Australia uses three upper-case characters:
	//    AUS.
	FilterCountries []*string `min:"1" type:"list"`

	// The name of the place index resource you want to use for the search.
	//
	// IndexName is a required field
	IndexName *string `location:"uri" locationName:"IndexName" min:"1" type:"string" required:"true"`

	// The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html)
	// to authorize the request.
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForTextInput's
	// String and GoString methods.
	Key *string `location:"querystring" locationName:"key" type:"string" sensitive:"true"`

	// The preferred language used to return results. The value must be a valid
	// BCP 47 (https://tools.ietf.org/search/bcp47) 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.
	Language *string `min:"2" type:"string"`

	// An optional parameter. The maximum number of results returned per request.
	//
	// The default: 50
	MaxResults *int64 `min:"1" type:"integer"`

	// The address, name, city, or region to be used in the search in free-form
	// text format. For example, 123 Any Street.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForTextInput's
	// String and GoString methods.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (SearchPlaceIndexForTextInput) GoString 

func (s SearchPlaceIndexForTextInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchPlaceIndexForTextInput) SetBiasPosition 

func (s *SearchPlaceIndexForTextInput) SetBiasPosition(v []*float64) *SearchPlaceIndexForTextInput

SetBiasPosition sets the BiasPosition field's value.

func (*SearchPlaceIndexForTextInput) SetFilterBBox 

func (s *SearchPlaceIndexForTextInput) SetFilterBBox(v []*float64) *SearchPlaceIndexForTextInput

SetFilterBBox sets the FilterBBox field's value.

func (*SearchPlaceIndexForTextInput) SetFilterCategories added in v1.44.283 

func (s *SearchPlaceIndexForTextInput) SetFilterCategories(v []*string) *SearchPlaceIndexForTextInput

SetFilterCategories sets the FilterCategories field's value.

func (*SearchPlaceIndexForTextInput) SetFilterCountries 

func (s *SearchPlaceIndexForTextInput) SetFilterCountries(v []*string) *SearchPlaceIndexForTextInput

SetFilterCountries sets the FilterCountries field's value.

func (*SearchPlaceIndexForTextInput) SetIndexName 

func (s *SearchPlaceIndexForTextInput) SetIndexName(v string) *SearchPlaceIndexForTextInput

SetIndexName sets the IndexName field's value.

func (*SearchPlaceIndexForTextInput) SetKey added in v1.44.297 

func (s *SearchPlaceIndexForTextInput) SetKey(v string) *SearchPlaceIndexForTextInput

SetKey sets the Key field's value.

func (*SearchPlaceIndexForTextInput) SetLanguage added in v1.42.6 

func (s *SearchPlaceIndexForTextInput) SetLanguage(v string) *SearchPlaceIndexForTextInput

SetLanguage sets the Language field's value.

func (*SearchPlaceIndexForTextInput) SetMaxResults 

func (s *SearchPlaceIndexForTextInput) SetMaxResults(v int64) *SearchPlaceIndexForTextInput

SetMaxResults sets the MaxResults field's value.

func (*SearchPlaceIndexForTextInput) SetText 

func (s *SearchPlaceIndexForTextInput) SetText(v string) *SearchPlaceIndexForTextInput

SetText sets the Text field's value.

func (SearchPlaceIndexForTextInput) String 

func (s SearchPlaceIndexForTextInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchPlaceIndexForTextInput) Validate 

func (s *SearchPlaceIndexForTextInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.
	//
	// Results is a required field
	Results []*SearchForTextResult `type:"list" required:"true"`

	// 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.
	//
	// Summary is a required field
	Summary *SearchPlaceIndexForTextSummary `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SearchPlaceIndexForTextOutput) GoString 

func (s SearchPlaceIndexForTextOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchPlaceIndexForTextOutput) SetResults 

func (s *SearchPlaceIndexForTextOutput) SetResults(v []*SearchForTextResult) *SearchPlaceIndexForTextOutput

SetResults sets the Results field's value.

func (*SearchPlaceIndexForTextOutput) SetSummary 

func (s *SearchPlaceIndexForTextOutput) SetSummary(v *SearchPlaceIndexForTextSummary) *SearchPlaceIndexForTextOutput

SetSummary sets the Summary field's value.

func (SearchPlaceIndexForTextOutput) String 

func (s SearchPlaceIndexForTextOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchPlaceIndexForTextSummary 

type SearchPlaceIndexForTextSummary struct {

	// Contains the coordinates for the optional bias position specified in the
	// request.
	//
	// This parameter contains 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForTextSummary's
	// String and GoString methods.
	BiasPosition []*float64 `min:"2" type:"list" sensitive:"true"`

	// The geospatial data provider attached to the place index resource specified
	// in the request. Values can be one of the following:
	//
	//    * Esri
	//
	//    * Grab
	//
	//    * Here
	//
	// For more information about data providers, see Amazon Location Service data
	// providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html).
	//
	// DataSource is a required field
	DataSource *string `type:"string" required:"true"`

	// Contains the coordinates for the optional bounding box specified in the request.
	//
	// FilterBBox is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForTextSummary's
	// String and GoString methods.
	FilterBBox []*float64 `min:"4" type:"list" sensitive:"true"`

	// The optional category filter specified in the request.
	FilterCategories []*string `min:"1" type:"list"`

	// Contains the optional country filter specified in the request.
	FilterCountries []*string `min:"1" type:"list"`

	// The preferred language used to return results. Matches the language in the
	// request. The value is a valid BCP 47 (https://tools.ietf.org/search/bcp47)
	// language tag, for example, en for English.
	Language *string `min:"2" type:"string"`

	// Contains the optional result count limit specified in the request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The bounding box that fully contains all search results.
	//
	// If you specified the optional FilterBBox parameter in the request, ResultBBox
	// is contained within FilterBBox.
	//
	// ResultBBox is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForTextSummary's
	// String and GoString methods.
	ResultBBox []*float64 `min:"4" type:"list" sensitive:"true"`

	// The search text specified in the request.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchPlaceIndexForTextSummary's
	// String and GoString methods.
	//
	// Text is a required field
	Text *string `type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

A summary of the request sent by using SearchPlaceIndexForText.

func (SearchPlaceIndexForTextSummary) GoString 

func (s SearchPlaceIndexForTextSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchPlaceIndexForTextSummary) SetBiasPosition 

func (s *SearchPlaceIndexForTextSummary) SetBiasPosition(v []*float64) *SearchPlaceIndexForTextSummary

SetBiasPosition sets the BiasPosition field's value.

func (*SearchPlaceIndexForTextSummary) SetDataSource 

func (s *SearchPlaceIndexForTextSummary) SetDataSource(v string) *SearchPlaceIndexForTextSummary

SetDataSource sets the DataSource field's value.

func (*SearchPlaceIndexForTextSummary) SetFilterBBox 

func (s *SearchPlaceIndexForTextSummary) SetFilterBBox(v []*float64) *SearchPlaceIndexForTextSummary

SetFilterBBox sets the FilterBBox field's value.

func (*SearchPlaceIndexForTextSummary) SetFilterCategories added in v1.44.283 

func (s *SearchPlaceIndexForTextSummary) SetFilterCategories(v []*string) *SearchPlaceIndexForTextSummary

SetFilterCategories sets the FilterCategories field's value.

func (*SearchPlaceIndexForTextSummary) SetFilterCountries 

func (s *SearchPlaceIndexForTextSummary) SetFilterCountries(v []*string) *SearchPlaceIndexForTextSummary

SetFilterCountries sets the FilterCountries field's value.

func (*SearchPlaceIndexForTextSummary) SetLanguage added in v1.42.6 

func (s *SearchPlaceIndexForTextSummary) SetLanguage(v string) *SearchPlaceIndexForTextSummary

SetLanguage sets the Language field's value.

func (*SearchPlaceIndexForTextSummary) SetMaxResults 

func (s *SearchPlaceIndexForTextSummary) SetMaxResults(v int64) *SearchPlaceIndexForTextSummary

SetMaxResults sets the MaxResults field's value.

func (*SearchPlaceIndexForTextSummary) SetResultBBox 

func (s *SearchPlaceIndexForTextSummary) SetResultBBox(v []*float64) *SearchPlaceIndexForTextSummary

SetResultBBox sets the ResultBBox field's value.

func (*SearchPlaceIndexForTextSummary) SetText 

func (s *SearchPlaceIndexForTextSummary) SetText(v string) *SearchPlaceIndexForTextSummary

SetText sets the Text field's value.

func (SearchPlaceIndexForTextSummary) String 

func (s SearchPlaceIndexForTextSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException added in v1.40.3 

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message with the reason for the service quota exceeded exception error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The operation was denied because the request would exceed the maximum quota (https://docs.aws.amazon.com/location/latest/developerguide/location-quotas.html) set for Amazon Location Service.

func (*ServiceQuotaExceededException) Code added in v1.40.3 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error added in v1.40.3 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString added in v1.40.3 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message added in v1.40.3 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr added in v1.40.3 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID added in v1.40.3 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode added in v1.40.3 

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String added in v1.40.3 

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Step added in v1.38.51 

type Step struct {

	// The travel distance between the step's StartPosition and EndPosition.
	//
	// Distance is a required field
	Distance *float64 `type:"double" required:"true"`

	// The estimated travel time, in seconds, from the step's StartPosition to the
	// EndPosition. . The travel mode and departure time that you specify in the
	// request determines the calculated time.
	//
	// DurationSeconds is a required field
	DurationSeconds *float64 `type:"double" required:"true"`

	// The end position of a step. If the position the last step in the leg, this
	// position is the same as the end position of the leg.
	//
	// EndPosition is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Step's
	// String and GoString methods.
	//
	// EndPosition is a required field
	EndPosition []*float64 `min:"2" type:"list" required:"true" sensitive:"true"`

	// Represents the start position, or index, in a sequence of steps within the
	// leg's line string geometry. For example, the index of the first step in a
	// leg geometry is 0.
	//
	// Included in the response for queries that set IncludeLegGeometry to True.
	GeometryOffset *int64 `type:"integer"`

	// The starting position of a step. If the position is the first step in the
	// leg, this position is the same as the start position of the leg.
	//
	// StartPosition is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Step's
	// String and GoString methods.
	//
	// StartPosition is a required field
	StartPosition []*float64 `min:"2" type:"list" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

Represents an element of a leg within a route. A step contains instructions for how to move to the next step in the leg.

func (Step) GoString added in v1.38.51 

func (s Step) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Step) SetDistance added in v1.38.51 

func (s *Step) SetDistance(v float64) *Step

SetDistance sets the Distance field's value.

func (*Step) SetDurationSeconds added in v1.38.51 

func (s *Step) SetDurationSeconds(v float64) *Step

SetDurationSeconds sets the DurationSeconds field's value.

func (*Step) SetEndPosition added in v1.38.51 

func (s *Step) SetEndPosition(v []*float64) *Step

SetEndPosition sets the EndPosition field's value.

func (*Step) SetGeometryOffset added in v1.38.51 

func (s *Step) SetGeometryOffset(v int64) *Step

SetGeometryOffset sets the GeometryOffset field's value.

func (*Step) SetStartPosition added in v1.38.51 

func (s *Step) SetStartPosition(v []*float64) *Step

SetStartPosition sets the StartPosition field's value.

func (Step) String added in v1.38.51 

func (s Step) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput added in v1.38.51 

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
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`

	// 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.
	//
	// Tags is a required field
	Tags map[string]*string `type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.38.51 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn added in v1.38.51 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.38.51 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.38.51 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.38.51 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.38.51 

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

func (TagResourceOutput) GoString added in v1.38.51 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.38.51 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request was denied because of request throttling.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TimeZone added in v1.42.6 

type TimeZone struct {

	// The name of the time zone, following the IANA time zone standard (https://www.iana.org/time-zones).
	// For example, America/Los_Angeles.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The time zone's offset, in seconds, from UTC.
	Offset *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Information about a time zone. Includes the name of the time zone and the offset from UTC in seconds.

func (TimeZone) GoString added in v1.42.6 

func (s TimeZone) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeZone) SetName added in v1.42.6 

func (s *TimeZone) SetName(v string) *TimeZone

SetName sets the Name field's value.

func (*TimeZone) SetOffset added in v1.42.6 

func (s *TimeZone) SetOffset(v int64) *TimeZone

SetOffset sets the Offset field's value.

func (TimeZone) String added in v1.42.6 

func (s TimeZone) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TrackingFilterGeometry added in v1.45.21 

type TrackingFilterGeometry struct {

	// The set of arrays which define the polygon. A polygon can have between 4
	// and 1000 vertices.
	Polygon [][][]*float64 `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The geomerty used to filter device positions.

func (TrackingFilterGeometry) GoString added in v1.45.21 

func (s TrackingFilterGeometry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrackingFilterGeometry) SetPolygon added in v1.45.21 

func (s *TrackingFilterGeometry) SetPolygon(v [][][]*float64) *TrackingFilterGeometry

SetPolygon sets the Polygon field's value.

func (TrackingFilterGeometry) String added in v1.45.21 

func (s TrackingFilterGeometry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrackingFilterGeometry) Validate added in v1.45.21 

func (s *TrackingFilterGeometry) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TruckDimensions added in v1.38.51 

type TruckDimensions struct {

	// The height of the truck.
	//
	//    * For example, 4.5.
	//
	// For routes calculated with a HERE resource, this value must be between 0
	// and 50 meters.
	Height *float64 `type:"double"`

	// The length of the truck.
	//
	//    * For example, 15.5.
	//
	// For routes calculated with a HERE resource, this value must be between 0
	// and 300 meters.
	Length *float64 `type:"double"`

	// Specifies the unit of measurement for the truck dimensions.
	//
	// Default Value: Meters
	Unit *string `type:"string" enum:"DimensionUnit"`

	// The width of the truck.
	//
	//    * For example, 4.5.
	//
	// For routes calculated with a HERE resource, this value must be between 0
	// and 50 meters.
	Width *float64 `type:"double"`
	// contains filtered or unexported fields
}

Contains details about the truck dimensions in the unit of measurement that you specify. Used to filter out roads that can't support or allow the specified dimensions for requests that specify TravelMode as Truck.

func (TruckDimensions) GoString added in v1.38.51 

func (s TruckDimensions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TruckDimensions) SetHeight added in v1.38.51 

func (s *TruckDimensions) SetHeight(v float64) *TruckDimensions

SetHeight sets the Height field's value.

func (*TruckDimensions) SetLength added in v1.38.51 

func (s *TruckDimensions) SetLength(v float64) *TruckDimensions

SetLength sets the Length field's value.

func (*TruckDimensions) SetUnit added in v1.38.51 

func (s *TruckDimensions) SetUnit(v string) *TruckDimensions

SetUnit sets the Unit field's value.

func (*TruckDimensions) SetWidth added in v1.38.51 

func (s *TruckDimensions) SetWidth(v float64) *TruckDimensions

SetWidth sets the Width field's value.

func (TruckDimensions) String added in v1.38.51 

func (s TruckDimensions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TruckWeight added in v1.38.51 

type TruckWeight struct {

	// The total weight of the truck.
	//
	//    * For example, 3500.
	Total *float64 `type:"double"`

	// The unit of measurement to use for the truck weight.
	//
	// Default Value: Kilograms
	Unit *string `type:"string" enum:"VehicleWeightUnit"`
	// contains filtered or unexported fields
}

Contains details about the truck's weight specifications. Used to avoid roads that can't support or allow the total weight for requests that specify TravelMode as Truck.

func (TruckWeight) GoString added in v1.38.51 

func (s TruckWeight) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TruckWeight) SetTotal added in v1.38.51 

func (s *TruckWeight) SetTotal(v float64) *TruckWeight

SetTotal sets the Total field's value.

func (*TruckWeight) SetUnit added in v1.38.51 

func (s *TruckWeight) SetUnit(v string) *TruckWeight

SetUnit sets the Unit field's value.

func (TruckWeight) String added in v1.38.51 

func (s TruckWeight) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.38.51 

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
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`

	// The list of tag keys to remove from the specified resource.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.38.51 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn added in v1.38.51 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.38.51 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.38.51 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.38.51 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.38.51 

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

func (UntagResourceOutput) GoString added in v1.38.51 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.38.51 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateGeofenceCollectionInput added in v1.40.3 

type UpdateGeofenceCollectionInput struct {

	// The name of the geofence collection to update.
	//
	// CollectionName is a required field
	CollectionName *string `location:"uri" locationName:"CollectionName" min:"1" type:"string" required:"true"`

	// Updates the description for the geofence collection.
	Description *string `type:"string"`

	// No longer used. If included, the only allowed value is RequestBasedUsage.
	//
	// Deprecated: Deprecated. If included, the only allowed value is RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"`

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

func (UpdateGeofenceCollectionInput) GoString added in v1.40.3 

func (s UpdateGeofenceCollectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGeofenceCollectionInput) SetCollectionName added in v1.40.3 

func (s *UpdateGeofenceCollectionInput) SetCollectionName(v string) *UpdateGeofenceCollectionInput

SetCollectionName sets the CollectionName field's value.

func (*UpdateGeofenceCollectionInput) SetDescription added in v1.40.3 

func (s *UpdateGeofenceCollectionInput) SetDescription(v string) *UpdateGeofenceCollectionInput

SetDescription sets the Description field's value.

func (*UpdateGeofenceCollectionInput) SetPricingPlan added in v1.40.3 

func (s *UpdateGeofenceCollectionInput) SetPricingPlan(v string) *UpdateGeofenceCollectionInput

SetPricingPlan sets the PricingPlan field's value.

func (*UpdateGeofenceCollectionInput) SetPricingPlanDataSource added in v1.40.3 

func (s *UpdateGeofenceCollectionInput) SetPricingPlanDataSource(v string) *UpdateGeofenceCollectionInput

SetPricingPlanDataSource sets the PricingPlanDataSource field's value.

func (UpdateGeofenceCollectionInput) String added in v1.40.3 

func (s UpdateGeofenceCollectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGeofenceCollectionInput) Validate added in v1.40.3 

func (s *UpdateGeofenceCollectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateGeofenceCollectionOutput added in v1.40.3 

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
	//
	// CollectionArn is a required field
	CollectionArn *string `type:"string" required:"true"`

	// The name of the updated geofence collection.
	//
	// CollectionName is a required field
	CollectionName *string `min:"1" type:"string" required:"true"`

	// The time 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
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateGeofenceCollectionOutput) GoString added in v1.40.3 

func (s UpdateGeofenceCollectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGeofenceCollectionOutput) SetCollectionArn added in v1.40.3 

func (s *UpdateGeofenceCollectionOutput) SetCollectionArn(v string) *UpdateGeofenceCollectionOutput

SetCollectionArn sets the CollectionArn field's value.

func (*UpdateGeofenceCollectionOutput) SetCollectionName added in v1.40.3 

func (s *UpdateGeofenceCollectionOutput) SetCollectionName(v string) *UpdateGeofenceCollectionOutput

SetCollectionName sets the CollectionName field's value.

func (*UpdateGeofenceCollectionOutput) SetUpdateTime added in v1.40.3 

func (s *UpdateGeofenceCollectionOutput) SetUpdateTime(v time.Time) *UpdateGeofenceCollectionOutput

SetUpdateTime sets the UpdateTime field's value.

func (UpdateGeofenceCollectionOutput) String added in v1.40.3 

func (s UpdateGeofenceCollectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateKeyInput added in v1.44.208 

type UpdateKeyInput struct {

	// Updates the description for the API key resource.
	Description *string `type:"string"`

	// Updates the timestamp for when the API key resource will expire in ISO 8601
	// (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ.
	ExpireTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// 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 `type:"boolean"`

	// The name of the API key resource to update.
	//
	// KeyName is a required field
	KeyName *string `location:"uri" locationName:"KeyName" min:"1" type:"string" required:"true"`

	// Whether the API key should expire. Set to true to set the API key to have
	// no expiration time.
	NoExpiry *bool `type:"boolean"`

	// Updates the API key restrictions for the API key resource.
	Restrictions *ApiKeyRestrictions `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateKeyInput) GoString added in v1.44.208 

func (s UpdateKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateKeyInput) SetDescription added in v1.44.208 

func (s *UpdateKeyInput) SetDescription(v string) *UpdateKeyInput

SetDescription sets the Description field's value.

func (*UpdateKeyInput) SetExpireTime added in v1.44.208 

func (s *UpdateKeyInput) SetExpireTime(v time.Time) *UpdateKeyInput

SetExpireTime sets the ExpireTime field's value.

func (*UpdateKeyInput) SetForceUpdate added in v1.44.208 

func (s *UpdateKeyInput) SetForceUpdate(v bool) *UpdateKeyInput

SetForceUpdate sets the ForceUpdate field's value.

func (*UpdateKeyInput) SetKeyName added in v1.44.208 

func (s *UpdateKeyInput) SetKeyName(v string) *UpdateKeyInput

SetKeyName sets the KeyName field's value.

func (*UpdateKeyInput) SetNoExpiry added in v1.44.208 

func (s *UpdateKeyInput) SetNoExpiry(v bool) *UpdateKeyInput

SetNoExpiry sets the NoExpiry field's value.

func (*UpdateKeyInput) SetRestrictions added in v1.44.208 

func (s *UpdateKeyInput) SetRestrictions(v *ApiKeyRestrictions) *UpdateKeyInput

SetRestrictions sets the Restrictions field's value.

func (UpdateKeyInput) String added in v1.44.208 

func (s UpdateKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateKeyInput) Validate added in v1.44.208 

func (s *UpdateKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateKeyOutput added in v1.44.208 

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
	//
	// KeyArn is a required field
	KeyArn *string `type:"string" required:"true"`

	// The name of the API key resource.
	//
	// KeyName is a required field
	KeyName *string `min:"1" type:"string" required:"true"`

	// The timestamp for when the API key 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.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateKeyOutput) GoString added in v1.44.208 

func (s UpdateKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateKeyOutput) SetKeyArn added in v1.44.208 

func (s *UpdateKeyOutput) SetKeyArn(v string) *UpdateKeyOutput

SetKeyArn sets the KeyArn field's value.

func (*UpdateKeyOutput) SetKeyName added in v1.44.208 

func (s *UpdateKeyOutput) SetKeyName(v string) *UpdateKeyOutput

SetKeyName sets the KeyName field's value.

func (*UpdateKeyOutput) SetUpdateTime added in v1.44.208 

func (s *UpdateKeyOutput) SetUpdateTime(v time.Time) *UpdateKeyOutput

SetUpdateTime sets the UpdateTime field's value.

func (UpdateKeyOutput) String added in v1.44.208 

func (s UpdateKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateMapInput added in v1.40.3 

type UpdateMapInput struct {

	// Updates the parts of the map configuration that can be updated, including
	// the political view.
	ConfigurationUpdate *MapConfigurationUpdate `type:"structure"`

	// Updates the description for the map resource.
	Description *string `type:"string"`

	// The name of the map resource to update.
	//
	// MapName is a required field
	MapName *string `location:"uri" locationName:"MapName" min:"1" type:"string" required:"true"`

	// No longer used. If included, the only allowed value is RequestBasedUsage.
	//
	// Deprecated: Deprecated. If included, the only allowed value is RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"`
	// contains filtered or unexported fields
}

func (UpdateMapInput) GoString added in v1.40.3 

func (s UpdateMapInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMapInput) SetConfigurationUpdate added in v1.44.272 

func (s *UpdateMapInput) SetConfigurationUpdate(v *MapConfigurationUpdate) *UpdateMapInput

SetConfigurationUpdate sets the ConfigurationUpdate field's value.

func (*UpdateMapInput) SetDescription added in v1.40.3 

func (s *UpdateMapInput) SetDescription(v string) *UpdateMapInput

SetDescription sets the Description field's value.

func (*UpdateMapInput) SetMapName added in v1.40.3 

func (s *UpdateMapInput) SetMapName(v string) *UpdateMapInput

SetMapName sets the MapName field's value.

func (*UpdateMapInput) SetPricingPlan added in v1.40.3 

func (s *UpdateMapInput) SetPricingPlan(v string) *UpdateMapInput

SetPricingPlan sets the PricingPlan field's value.

func (UpdateMapInput) String added in v1.40.3 

func (s UpdateMapInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMapInput) Validate added in v1.40.3 

func (s *UpdateMapInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateMapOutput added in v1.40.3 

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
	//
	// MapArn is a required field
	MapArn *string `type:"string" required:"true"`

	// The name of the updated map resource.
	//
	// MapName is a required field
	MapName *string `min:"1" type:"string" required:"true"`

	// The timestamp for when the map 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.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateMapOutput) GoString added in v1.40.3 

func (s UpdateMapOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMapOutput) SetMapArn added in v1.40.3 

func (s *UpdateMapOutput) SetMapArn(v string) *UpdateMapOutput

SetMapArn sets the MapArn field's value.

func (*UpdateMapOutput) SetMapName added in v1.40.3 

func (s *UpdateMapOutput) SetMapName(v string) *UpdateMapOutput

SetMapName sets the MapName field's value.

func (*UpdateMapOutput) SetUpdateTime added in v1.40.3 

func (s *UpdateMapOutput) SetUpdateTime(v time.Time) *UpdateMapOutput

SetUpdateTime sets the UpdateTime field's value.

func (UpdateMapOutput) String added in v1.40.3 

func (s UpdateMapOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdatePlaceIndexInput added in v1.40.3 

type UpdatePlaceIndexInput struct {

	// Updates the data storage option for the place index resource.
	DataSourceConfiguration *DataSourceConfiguration `type:"structure"`

	// Updates the description for the place index resource.
	Description *string `type:"string"`

	// The name of the place index resource to update.
	//
	// IndexName is a required field
	IndexName *string `location:"uri" locationName:"IndexName" min:"1" type:"string" required:"true"`

	// No longer used. If included, the only allowed value is RequestBasedUsage.
	//
	// Deprecated: Deprecated. If included, the only allowed value is RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"`
	// contains filtered or unexported fields
}

func (UpdatePlaceIndexInput) GoString added in v1.40.3 

func (s UpdatePlaceIndexInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePlaceIndexInput) SetDataSourceConfiguration added in v1.40.3 

func (s *UpdatePlaceIndexInput) SetDataSourceConfiguration(v *DataSourceConfiguration) *UpdatePlaceIndexInput

SetDataSourceConfiguration sets the DataSourceConfiguration field's value.

func (*UpdatePlaceIndexInput) SetDescription added in v1.40.3 

func (s *UpdatePlaceIndexInput) SetDescription(v string) *UpdatePlaceIndexInput

SetDescription sets the Description field's value.

func (*UpdatePlaceIndexInput) SetIndexName added in v1.40.3 

func (s *UpdatePlaceIndexInput) SetIndexName(v string) *UpdatePlaceIndexInput

SetIndexName sets the IndexName field's value.

func (*UpdatePlaceIndexInput) SetPricingPlan added in v1.40.3 

func (s *UpdatePlaceIndexInput) SetPricingPlan(v string) *UpdatePlaceIndexInput

SetPricingPlan sets the PricingPlan field's value.

func (UpdatePlaceIndexInput) String added in v1.40.3 

func (s UpdatePlaceIndexInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePlaceIndexInput) Validate added in v1.40.3 

func (s *UpdatePlaceIndexInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdatePlaceIndexOutput added in v1.40.3 

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
	//
	// IndexArn is a required field
	IndexArn *string `type:"string" required:"true"`

	// The name of the updated place index resource.
	//
	// IndexName is a required field
	IndexName *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (UpdatePlaceIndexOutput) GoString added in v1.40.3 

func (s UpdatePlaceIndexOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePlaceIndexOutput) SetIndexArn added in v1.40.3 

func (s *UpdatePlaceIndexOutput) SetIndexArn(v string) *UpdatePlaceIndexOutput

SetIndexArn sets the IndexArn field's value.

func (*UpdatePlaceIndexOutput) SetIndexName added in v1.40.3 

func (s *UpdatePlaceIndexOutput) SetIndexName(v string) *UpdatePlaceIndexOutput

SetIndexName sets the IndexName field's value.

func (*UpdatePlaceIndexOutput) SetUpdateTime added in v1.40.3 

func (s *UpdatePlaceIndexOutput) SetUpdateTime(v time.Time) *UpdatePlaceIndexOutput

SetUpdateTime sets the UpdateTime field's value.

func (UpdatePlaceIndexOutput) String added in v1.40.3 

func (s UpdatePlaceIndexOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateRouteCalculatorInput added in v1.40.3 

type UpdateRouteCalculatorInput struct {

	// The name of the route calculator resource to update.
	//
	// CalculatorName is a required field
	CalculatorName *string `location:"uri" locationName:"CalculatorName" min:"1" type:"string" required:"true"`

	// Updates the description for the route calculator resource.
	Description *string `type:"string"`

	// No longer used. If included, the only allowed value is RequestBasedUsage.
	//
	// Deprecated: Deprecated. If included, the only allowed value is RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"`
	// contains filtered or unexported fields
}

func (UpdateRouteCalculatorInput) GoString added in v1.40.3 

func (s UpdateRouteCalculatorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRouteCalculatorInput) SetCalculatorName added in v1.40.3 

func (s *UpdateRouteCalculatorInput) SetCalculatorName(v string) *UpdateRouteCalculatorInput

SetCalculatorName sets the CalculatorName field's value.

func (*UpdateRouteCalculatorInput) SetDescription added in v1.40.3 

func (s *UpdateRouteCalculatorInput) SetDescription(v string) *UpdateRouteCalculatorInput

SetDescription sets the Description field's value.

func (*UpdateRouteCalculatorInput) SetPricingPlan added in v1.40.3 

func (s *UpdateRouteCalculatorInput) SetPricingPlan(v string) *UpdateRouteCalculatorInput

SetPricingPlan sets the PricingPlan field's value.

func (UpdateRouteCalculatorInput) String added in v1.40.3 

func (s UpdateRouteCalculatorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRouteCalculatorInput) Validate added in v1.40.3 

func (s *UpdateRouteCalculatorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateRouteCalculatorOutput added in v1.40.3 

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
	//
	// CalculatorArn is a required field
	CalculatorArn *string `type:"string" required:"true"`

	// The name of the updated route calculator resource.
	//
	// CalculatorName is a required field
	CalculatorName *string `min:"1" type:"string" required:"true"`

	// The timestamp for when the route calculator was last updated in ISO 8601
	// (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateRouteCalculatorOutput) GoString added in v1.40.3 

func (s UpdateRouteCalculatorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRouteCalculatorOutput) SetCalculatorArn added in v1.40.3 

func (s *UpdateRouteCalculatorOutput) SetCalculatorArn(v string) *UpdateRouteCalculatorOutput

SetCalculatorArn sets the CalculatorArn field's value.

func (*UpdateRouteCalculatorOutput) SetCalculatorName added in v1.40.3 

func (s *UpdateRouteCalculatorOutput) SetCalculatorName(v string) *UpdateRouteCalculatorOutput

SetCalculatorName sets the CalculatorName field's value.

func (*UpdateRouteCalculatorOutput) SetUpdateTime added in v1.40.3 

func (s *UpdateRouteCalculatorOutput) SetUpdateTime(v time.Time) *UpdateRouteCalculatorOutput

SetUpdateTime sets the UpdateTime field's value.

func (UpdateRouteCalculatorOutput) String added in v1.40.3 

func (s UpdateRouteCalculatorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateTrackerInput added in v1.40.3 

type UpdateTrackerInput struct {

	// Updates the description for the tracker resource.
	Description *string `type:"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 `type:"boolean"`

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

	// 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 *string `type:"string" enum:"PositionFiltering"`

	// No longer used. If included, the only allowed value is RequestBasedUsage.
	//
	// Deprecated: Deprecated. If included, the only allowed value is RequestBasedUsage.
	PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"`

	// This parameter is no longer used.
	//
	// Deprecated: Deprecated. No longer allowed.
	PricingPlanDataSource *string `deprecated:"true" type:"string"`

	// The name of the tracker resource to update.
	//
	// TrackerName is a required field
	TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateTrackerInput) GoString added in v1.40.3 

func (s UpdateTrackerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTrackerInput) SetDescription added in v1.40.3 

func (s *UpdateTrackerInput) SetDescription(v string) *UpdateTrackerInput

SetDescription sets the Description field's value.

func (*UpdateTrackerInput) SetEventBridgeEnabled added in v1.44.297 

func (s *UpdateTrackerInput) SetEventBridgeEnabled(v bool) *UpdateTrackerInput

SetEventBridgeEnabled sets the EventBridgeEnabled field's value.

func (*UpdateTrackerInput) SetKmsKeyEnableGeospatialQueries added in v1.45.21 

func (s *UpdateTrackerInput) SetKmsKeyEnableGeospatialQueries(v bool) *UpdateTrackerInput

SetKmsKeyEnableGeospatialQueries sets the KmsKeyEnableGeospatialQueries field's value.

func (*UpdateTrackerInput) SetPositionFiltering added in v1.40.56 

func (s *UpdateTrackerInput) SetPositionFiltering(v string) *UpdateTrackerInput

SetPositionFiltering sets the PositionFiltering field's value.

func (*UpdateTrackerInput) SetPricingPlan added in v1.40.3 

func (s *UpdateTrackerInput) SetPricingPlan(v string) *UpdateTrackerInput

SetPricingPlan sets the PricingPlan field's value.

func (*UpdateTrackerInput) SetPricingPlanDataSource added in v1.40.3 

func (s *UpdateTrackerInput) SetPricingPlanDataSource(v string) *UpdateTrackerInput

SetPricingPlanDataSource sets the PricingPlanDataSource field's value.

func (*UpdateTrackerInput) SetTrackerName added in v1.40.3 

func (s *UpdateTrackerInput) SetTrackerName(v string) *UpdateTrackerInput

SetTrackerName sets the TrackerName field's value.

func (UpdateTrackerInput) String added in v1.40.3 

func (s UpdateTrackerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTrackerInput) Validate added in v1.40.3 

func (s *UpdateTrackerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateTrackerOutput added in v1.40.3 

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
	//
	// TrackerArn is a required field
	TrackerArn *string `type:"string" required:"true"`

	// The name of the updated tracker resource.
	//
	// TrackerName is a required field
	TrackerName *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateTrackerOutput) GoString added in v1.40.3 

func (s UpdateTrackerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTrackerOutput) SetTrackerArn added in v1.40.3 

func (s *UpdateTrackerOutput) SetTrackerArn(v string) *UpdateTrackerOutput

SetTrackerArn sets the TrackerArn field's value.

func (*UpdateTrackerOutput) SetTrackerName added in v1.40.3 

func (s *UpdateTrackerOutput) SetTrackerName(v string) *UpdateTrackerOutput

SetTrackerName sets the TrackerName field's value.

func (*UpdateTrackerOutput) SetUpdateTime added in v1.40.3 

func (s *UpdateTrackerOutput) SetUpdateTime(v time.Time) *UpdateTrackerOutput

SetUpdateTime sets the UpdateTime field's value.

func (UpdateTrackerOutput) String added in v1.40.3 

func (s UpdateTrackerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The field where the invalid entry was detected.
	//
	// FieldList is a required field
	FieldList []*ValidationExceptionField `locationName:"fieldList" type:"list" required:"true"`

	Message_ *string `locationName:"message" type:"string"`

	// A message with the reason for the validation exception error.
	//
	// Reason is a required field
	Reason *string `locationName:"reason" type:"string" required:"true" enum:"ValidationExceptionReason"`
	// contains filtered or unexported fields
}

The input failed to meet the constraints specified by the AWS service.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationExceptionField 

type ValidationExceptionField struct {

	// A message with the reason for the validation exception error.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`

	// The field name where the invalid entry was detected.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input failed to meet the constraints specified by the AWS service in a specified field.

func (ValidationExceptionField) GoString 

func (s ValidationExceptionField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationExceptionField) SetMessage 

func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName 

func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField

SetName sets the Name field's value.

func (ValidationExceptionField) String 

func (s ValidationExceptionField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VerifyDevicePositionInput added in v1.53.18 

type VerifyDevicePositionInput struct {

	// The device's state, including position, IP address, cell signals and Wi-Fi
	// access points.
	//
	// DeviceState is a required field
	DeviceState *DeviceState `type:"structure" required:"true"`

	// The distance unit for the verification request.
	//
	// Default Value: Kilometers
	DistanceUnit *string `type:"string" enum:"DistanceUnit"`

	// The name of the tracker resource to be associated with verification request.
	//
	// TrackerName is a required field
	TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (VerifyDevicePositionInput) GoString added in v1.53.18 

func (s VerifyDevicePositionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VerifyDevicePositionInput) SetDeviceState added in v1.53.18 

func (s *VerifyDevicePositionInput) SetDeviceState(v *DeviceState) *VerifyDevicePositionInput

SetDeviceState sets the DeviceState field's value.

func (*VerifyDevicePositionInput) SetDistanceUnit added in v1.53.18 

func (s *VerifyDevicePositionInput) SetDistanceUnit(v string) *VerifyDevicePositionInput

SetDistanceUnit sets the DistanceUnit field's value.

func (*VerifyDevicePositionInput) SetTrackerName added in v1.53.18 

func (s *VerifyDevicePositionInput) SetTrackerName(v string) *VerifyDevicePositionInput

SetTrackerName sets the TrackerName field's value.

func (VerifyDevicePositionInput) String added in v1.53.18 

func (s VerifyDevicePositionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VerifyDevicePositionInput) Validate added in v1.53.18 

func (s *VerifyDevicePositionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type VerifyDevicePositionOutput added in v1.53.18 

type VerifyDevicePositionOutput struct {

	// The device identifier.
	//
	// DeviceId is a required field
	DeviceId *string `min:"1" type:"string" required:"true"`

	// The distance unit for the verification response.
	//
	// DistanceUnit is a required field
	DistanceUnit *string `type:"string" required:"true" enum:"DistanceUnit"`

	// The inferred state of the device, given the provided position, IP address,
	// cellular signals, and Wi-Fi- access points.
	//
	// InferredState is a required field
	InferredState *InferredState `type:"structure" required:"true"`

	// 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.
	//
	// ReceivedTime is a required field
	ReceivedTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// 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.
	//
	// SampleTime is a required field
	SampleTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (VerifyDevicePositionOutput) GoString added in v1.53.18 

func (s VerifyDevicePositionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VerifyDevicePositionOutput) SetDeviceId added in v1.53.18 

func (s *VerifyDevicePositionOutput) SetDeviceId(v string) *VerifyDevicePositionOutput

SetDeviceId sets the DeviceId field's value.

func (*VerifyDevicePositionOutput) SetDistanceUnit added in v1.53.18 

func (s *VerifyDevicePositionOutput) SetDistanceUnit(v string) *VerifyDevicePositionOutput

SetDistanceUnit sets the DistanceUnit field's value.

func (*VerifyDevicePositionOutput) SetInferredState added in v1.53.18 

func (s *VerifyDevicePositionOutput) SetInferredState(v *InferredState) *VerifyDevicePositionOutput

SetInferredState sets the InferredState field's value.

func (*VerifyDevicePositionOutput) SetReceivedTime added in v1.53.18 

func (s *VerifyDevicePositionOutput) SetReceivedTime(v time.Time) *VerifyDevicePositionOutput

SetReceivedTime sets the ReceivedTime field's value.

func (*VerifyDevicePositionOutput) SetSampleTime added in v1.53.18 

func (s *VerifyDevicePositionOutput) SetSampleTime(v time.Time) *VerifyDevicePositionOutput

SetSampleTime sets the SampleTime field's value.

func (VerifyDevicePositionOutput) String added in v1.53.18 

func (s VerifyDevicePositionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WiFiAccessPoint added in v1.53.18 

type WiFiAccessPoint struct {

	// Medium access control address (Mac).
	//
	// MacAddress is a required field
	MacAddress *string `min:"12" type:"string" required:"true"`

	// Received signal strength (dBm) of the WLAN measurement data.
	//
	// Rss is a required field
	Rss *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Wi-Fi access point.

func (WiFiAccessPoint) GoString added in v1.53.18 

func (s WiFiAccessPoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WiFiAccessPoint) SetMacAddress added in v1.53.18 

func (s *WiFiAccessPoint) SetMacAddress(v string) *WiFiAccessPoint

SetMacAddress sets the MacAddress field's value.

func (*WiFiAccessPoint) SetRss added in v1.53.18 

func (s *WiFiAccessPoint) SetRss(v int64) *WiFiAccessPoint

SetRss sets the Rss field's value.

func (WiFiAccessPoint) String added in v1.53.18 

func (s WiFiAccessPoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WiFiAccessPoint) Validate added in v1.53.18 

func (s *WiFiAccessPoint) Validate() error

Validate inspects the fields of the type to determine if they are valid.

Source Files

View all Source files

Directories

Path Synopsis
Package locationserviceiface provides an interface to enable mocking the Amazon Location Service service client for testing your code.
 Package locationserviceiface provides an interface to enable mocking the Amazon Location Service service client for testing your code.

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.