// // Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. // // Licensed under the Apache License, Version 2.0 (the "License"). // You may not use this file except in compliance with the License. // A copy of the License is located at // // http://aws.amazon.com/apache2.0 // // or in the "license" file accompanying this file. This file is distributed // on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either // express or implied. See the License for the specific language governing // permissions and limitations under the License. // #import #import #import NS_ASSUME_NONNULL_BEGIN FOUNDATION_EXPORT NSString *const AWSLocationErrorDomain; typedef NS_ENUM(NSInteger, AWSLocationErrorType) { AWSLocationErrorUnknown, AWSLocationErrorAccessDenied, AWSLocationErrorConflict, AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorServiceQuotaExceeded, AWSLocationErrorThrottling, AWSLocationErrorValidation, }; typedef NS_ENUM(NSInteger, AWSLocationBatchItemErrorCode) { AWSLocationBatchItemErrorCodeUnknown, AWSLocationBatchItemErrorCodeAccessDeniedError, AWSLocationBatchItemErrorCodeConflictError, AWSLocationBatchItemErrorCodeInternalServerError, AWSLocationBatchItemErrorCodeResourceNotFoundError, AWSLocationBatchItemErrorCodeThrottlingError, AWSLocationBatchItemErrorCodeValidationError, }; typedef NS_ENUM(NSInteger, AWSLocationDimensionUnit) { AWSLocationDimensionUnitUnknown, AWSLocationDimensionUnitMeters, AWSLocationDimensionUnitFeet, }; typedef NS_ENUM(NSInteger, AWSLocationDistanceUnit) { AWSLocationDistanceUnitUnknown, AWSLocationDistanceUnitKilometers, AWSLocationDistanceUnitMiles, }; typedef NS_ENUM(NSInteger, AWSLocationIntendedUse) { AWSLocationIntendedUseUnknown, AWSLocationIntendedUseSingleUse, AWSLocationIntendedUseStorage, }; typedef NS_ENUM(NSInteger, AWSLocationPositionFiltering) { AWSLocationPositionFilteringUnknown, AWSLocationPositionFilteringTimeBased, AWSLocationPositionFilteringDistanceBased, AWSLocationPositionFilteringAccuracyBased, }; typedef NS_ENUM(NSInteger, AWSLocationPricingPlan) { AWSLocationPricingPlanUnknown, AWSLocationPricingPlanRequestBasedUsage, AWSLocationPricingPlanMobileAssetTracking, AWSLocationPricingPlanMobileAssetManagement, }; typedef NS_ENUM(NSInteger, AWSLocationRouteMatrixErrorCode) { AWSLocationRouteMatrixErrorCodeUnknown, AWSLocationRouteMatrixErrorCodeRouteNotFound, AWSLocationRouteMatrixErrorCodeRouteTooLong, AWSLocationRouteMatrixErrorCodePositionsNotFound, AWSLocationRouteMatrixErrorCodeDestinationPositionNotFound, AWSLocationRouteMatrixErrorCodeDeparturePositionNotFound, AWSLocationRouteMatrixErrorCodeOtherValidationError, }; typedef NS_ENUM(NSInteger, AWSLocationStatus) { AWSLocationStatusUnknown, AWSLocationStatusActive, AWSLocationStatusExpired, }; typedef NS_ENUM(NSInteger, AWSLocationTravelMode) { AWSLocationTravelModeUnknown, AWSLocationTravelModeCar, AWSLocationTravelModeTruck, AWSLocationTravelModeWalking, AWSLocationTravelModeBicycle, AWSLocationTravelModeMotorcycle, }; typedef NS_ENUM(NSInteger, AWSLocationValidationExceptionReason) { AWSLocationValidationExceptionReasonUnknown, AWSLocationValidationExceptionReasonUnknownOperation, AWSLocationValidationExceptionReasonMissing, AWSLocationValidationExceptionReasonCannotParse, AWSLocationValidationExceptionReasonFieldValidationFailed, AWSLocationValidationExceptionReasonOther, }; typedef NS_ENUM(NSInteger, AWSLocationVehicleWeightUnit) { AWSLocationVehicleWeightUnitUnknown, AWSLocationVehicleWeightUnitKilograms, AWSLocationVehicleWeightUnitPounds, }; @class AWSLocationApiKeyFilter; @class AWSLocationApiKeyRestrictions; @class AWSLocationAssociateTrackerConsumerRequest; @class AWSLocationAssociateTrackerConsumerResponse; @class AWSLocationBatchDeleteDevicePositionHistoryError; @class AWSLocationBatchDeleteDevicePositionHistoryRequest; @class AWSLocationBatchDeleteDevicePositionHistoryResponse; @class AWSLocationBatchDeleteGeofenceError; @class AWSLocationBatchDeleteGeofenceRequest; @class AWSLocationBatchDeleteGeofenceResponse; @class AWSLocationBatchEvaluateGeofencesError; @class AWSLocationBatchEvaluateGeofencesRequest; @class AWSLocationBatchEvaluateGeofencesResponse; @class AWSLocationBatchGetDevicePositionError; @class AWSLocationBatchGetDevicePositionRequest; @class AWSLocationBatchGetDevicePositionResponse; @class AWSLocationBatchItemError; @class AWSLocationBatchPutGeofenceError; @class AWSLocationBatchPutGeofenceRequest; @class AWSLocationBatchPutGeofenceRequestEntry; @class AWSLocationBatchPutGeofenceResponse; @class AWSLocationBatchPutGeofenceSuccess; @class AWSLocationBatchUpdateDevicePositionError; @class AWSLocationBatchUpdateDevicePositionRequest; @class AWSLocationBatchUpdateDevicePositionResponse; @class AWSLocationCalculateRouteCarModeOptions; @class AWSLocationCalculateRouteMatrixRequest; @class AWSLocationCalculateRouteMatrixResponse; @class AWSLocationCalculateRouteMatrixSummary; @class AWSLocationCalculateRouteRequest; @class AWSLocationCalculateRouteResponse; @class AWSLocationCalculateRouteSummary; @class AWSLocationCalculateRouteTruckModeOptions; @class AWSLocationCircle; @class AWSLocationCreateGeofenceCollectionRequest; @class AWSLocationCreateGeofenceCollectionResponse; @class AWSLocationCreateKeyRequest; @class AWSLocationCreateKeyResponse; @class AWSLocationCreateMapRequest; @class AWSLocationCreateMapResponse; @class AWSLocationCreatePlaceIndexRequest; @class AWSLocationCreatePlaceIndexResponse; @class AWSLocationCreateRouteCalculatorRequest; @class AWSLocationCreateRouteCalculatorResponse; @class AWSLocationCreateTrackerRequest; @class AWSLocationCreateTrackerResponse; @class AWSLocationDataSourceConfiguration; @class AWSLocationDeleteGeofenceCollectionRequest; @class AWSLocationDeleteGeofenceCollectionResponse; @class AWSLocationDeleteKeyRequest; @class AWSLocationDeleteKeyResponse; @class AWSLocationDeleteMapRequest; @class AWSLocationDeleteMapResponse; @class AWSLocationDeletePlaceIndexRequest; @class AWSLocationDeletePlaceIndexResponse; @class AWSLocationDeleteRouteCalculatorRequest; @class AWSLocationDeleteRouteCalculatorResponse; @class AWSLocationDeleteTrackerRequest; @class AWSLocationDeleteTrackerResponse; @class AWSLocationDescribeGeofenceCollectionRequest; @class AWSLocationDescribeGeofenceCollectionResponse; @class AWSLocationDescribeKeyRequest; @class AWSLocationDescribeKeyResponse; @class AWSLocationDescribeMapRequest; @class AWSLocationDescribeMapResponse; @class AWSLocationDescribePlaceIndexRequest; @class AWSLocationDescribePlaceIndexResponse; @class AWSLocationDescribeRouteCalculatorRequest; @class AWSLocationDescribeRouteCalculatorResponse; @class AWSLocationDescribeTrackerRequest; @class AWSLocationDescribeTrackerResponse; @class AWSLocationDevicePosition; @class AWSLocationDevicePositionUpdate; @class AWSLocationDisassociateTrackerConsumerRequest; @class AWSLocationDisassociateTrackerConsumerResponse; @class AWSLocationGeofenceGeometry; @class AWSLocationGetDevicePositionHistoryRequest; @class AWSLocationGetDevicePositionHistoryResponse; @class AWSLocationGetDevicePositionRequest; @class AWSLocationGetDevicePositionResponse; @class AWSLocationGetGeofenceRequest; @class AWSLocationGetGeofenceResponse; @class AWSLocationGetMapGlyphsRequest; @class AWSLocationGetMapGlyphsResponse; @class AWSLocationGetMapSpritesRequest; @class AWSLocationGetMapSpritesResponse; @class AWSLocationGetMapStyleDescriptorRequest; @class AWSLocationGetMapStyleDescriptorResponse; @class AWSLocationGetMapTileRequest; @class AWSLocationGetMapTileResponse; @class AWSLocationGetPlaceRequest; @class AWSLocationGetPlaceResponse; @class AWSLocationLeg; @class AWSLocationLegGeometry; @class AWSLocationListDevicePositionsRequest; @class AWSLocationListDevicePositionsResponse; @class AWSLocationListDevicePositionsResponseEntry; @class AWSLocationListGeofenceCollectionsRequest; @class AWSLocationListGeofenceCollectionsResponse; @class AWSLocationListGeofenceCollectionsResponseEntry; @class AWSLocationListGeofenceResponseEntry; @class AWSLocationListGeofencesRequest; @class AWSLocationListGeofencesResponse; @class AWSLocationListKeysRequest; @class AWSLocationListKeysResponse; @class AWSLocationListKeysResponseEntry; @class AWSLocationListMapsRequest; @class AWSLocationListMapsResponse; @class AWSLocationListMapsResponseEntry; @class AWSLocationListPlaceIndexesRequest; @class AWSLocationListPlaceIndexesResponse; @class AWSLocationListPlaceIndexesResponseEntry; @class AWSLocationListRouteCalculatorsRequest; @class AWSLocationListRouteCalculatorsResponse; @class AWSLocationListRouteCalculatorsResponseEntry; @class AWSLocationListTagsForResourceRequest; @class AWSLocationListTagsForResourceResponse; @class AWSLocationListTrackerConsumersRequest; @class AWSLocationListTrackerConsumersResponse; @class AWSLocationListTrackersRequest; @class AWSLocationListTrackersResponse; @class AWSLocationListTrackersResponseEntry; @class AWSLocationMapConfiguration; @class AWSLocationMapConfigurationUpdate; @class AWSLocationPlace; @class AWSLocationPlaceGeometry; @class AWSLocationPositionalAccuracy; @class AWSLocationPutGeofenceRequest; @class AWSLocationPutGeofenceResponse; @class AWSLocationRouteMatrixEntry; @class AWSLocationRouteMatrixEntryError; @class AWSLocationSearchForPositionResult; @class AWSLocationSearchForSuggestionsResult; @class AWSLocationSearchForTextResult; @class AWSLocationSearchPlaceIndexForPositionRequest; @class AWSLocationSearchPlaceIndexForPositionResponse; @class AWSLocationSearchPlaceIndexForPositionSummary; @class AWSLocationSearchPlaceIndexForSuggestionsRequest; @class AWSLocationSearchPlaceIndexForSuggestionsResponse; @class AWSLocationSearchPlaceIndexForSuggestionsSummary; @class AWSLocationSearchPlaceIndexForTextRequest; @class AWSLocationSearchPlaceIndexForTextResponse; @class AWSLocationSearchPlaceIndexForTextSummary; @class AWSLocationStep; @class AWSLocationTagResourceRequest; @class AWSLocationTagResourceResponse; @class AWSLocationTimeZone; @class AWSLocationTruckDimensions; @class AWSLocationTruckWeight; @class AWSLocationUntagResourceRequest; @class AWSLocationUntagResourceResponse; @class AWSLocationUpdateGeofenceCollectionRequest; @class AWSLocationUpdateGeofenceCollectionResponse; @class AWSLocationUpdateKeyRequest; @class AWSLocationUpdateKeyResponse; @class AWSLocationUpdateMapRequest; @class AWSLocationUpdateMapResponse; @class AWSLocationUpdatePlaceIndexRequest; @class AWSLocationUpdatePlaceIndexResponse; @class AWSLocationUpdateRouteCalculatorRequest; @class AWSLocationUpdateRouteCalculatorResponse; @class AWSLocationUpdateTrackerRequest; @class AWSLocationUpdateTrackerResponse; @class AWSLocationValidationExceptionField; /**

Options for filtering API keys.

*/ @interface AWSLocationApiKeyFilter : AWSModel /**

Filter on Active or Expired API keys.

*/ @property (nonatomic, assign) AWSLocationStatus keyStatus; @end /**

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

Required parameters: [AllowActions, AllowResources] */ @interface AWSLocationApiKeyRestrictions : AWSModel /**

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.

 */ @property (nonatomic, strong) NSArray * _Nullable allowActions; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable allowReferers; /**

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

*/ @property (nonatomic, strong) NSArray * _Nullable allowResources; @end /** */ @interface AWSLocationAssociateTrackerConsumerRequest : AWSRequest /**

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

*/ @property (nonatomic, strong) NSString * _Nullable consumerArn; /**

The name of the tracker resource to be associated with a geofence collection.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; @end /** */ @interface AWSLocationAssociateTrackerConsumerResponse : AWSModel @end /**

Contains the tracker resource details.

Required parameters: [DeviceId, Error] */ @interface AWSLocationBatchDeleteDevicePositionHistoryError : AWSModel /**

The ID of the device for this position.

*/ @property (nonatomic, strong) NSString * _Nullable deviceId; /**

Contains the batch request error details associated with the request.

*/ @property (nonatomic, strong) AWSLocationBatchItemError * _Nullable error; @end /** */ @interface AWSLocationBatchDeleteDevicePositionHistoryRequest : AWSRequest /**

Devices whose position history you want to delete.

  • For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]

*/ @property (nonatomic, strong) NSArray * _Nullable deviceIds; /**

The name of the tracker resource to delete the device position history from.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; @end /** */ @interface AWSLocationBatchDeleteDevicePositionHistoryResponse : AWSModel /**

Contains error details for each device history that failed to delete.

*/ @property (nonatomic, strong) NSArray * _Nullable errors; @end /**

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

Required parameters: [Error, GeofenceId] */ @interface AWSLocationBatchDeleteGeofenceError : AWSModel /**

Contains details associated to the batch error.

*/ @property (nonatomic, strong) AWSLocationBatchItemError * _Nullable error; /**

The geofence associated with the error message.

*/ @property (nonatomic, strong) NSString * _Nullable geofenceId; @end /** */ @interface AWSLocationBatchDeleteGeofenceRequest : AWSRequest /**

The geofence collection storing the geofences to be deleted.

*/ @property (nonatomic, strong) NSString * _Nullable collectionName; /**

The batch of geofences to be deleted.

*/ @property (nonatomic, strong) NSArray * _Nullable geofenceIds; @end /** */ @interface AWSLocationBatchDeleteGeofenceResponse : AWSModel /**

Contains error details for each geofence that failed to delete.

*/ @property (nonatomic, strong) NSArray * _Nullable errors; @end /**

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

Required parameters: [DeviceId, Error, SampleTime] */ @interface AWSLocationBatchEvaluateGeofencesError : AWSModel /**

The device associated with the position evaluation error.

*/ @property (nonatomic, strong) NSString * _Nullable deviceId; /**

Contains details associated to the batch error.

*/ @property (nonatomic, strong) AWSLocationBatchItemError * _Nullable error; /**

Specifies a timestamp for when the error occurred in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

*/ @property (nonatomic, strong) NSDate * _Nullable sampleTime; @end /** */ @interface AWSLocationBatchEvaluateGeofencesRequest : AWSRequest /**

The geofence collection used in evaluating the position of devices against its geofences.

*/ @property (nonatomic, strong) NSString * _Nullable collectionName; /**

Contains device details for each device to be evaluated against the given geofence collection.

*/ @property (nonatomic, strong) NSArray * _Nullable devicePositionUpdates; @end /** */ @interface AWSLocationBatchEvaluateGeofencesResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSArray * _Nullable errors; @end /**

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

Required parameters: [DeviceId, Error] */ @interface AWSLocationBatchGetDevicePositionError : AWSModel /**

The ID of the device that didn't return a position.

*/ @property (nonatomic, strong) NSString * _Nullable deviceId; /**

Contains details related to the error code.

*/ @property (nonatomic, strong) AWSLocationBatchItemError * _Nullable error; @end /** */ @interface AWSLocationBatchGetDevicePositionRequest : AWSRequest /**

Devices whose position you want to retrieve.

  • For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2

*/ @property (nonatomic, strong) NSArray * _Nullable deviceIds; /**

The tracker resource retrieving the device position.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; @end /** */ @interface AWSLocationBatchGetDevicePositionResponse : AWSModel /**

Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled.

*/ @property (nonatomic, strong) NSArray * _Nullable devicePositions; /**

Contains error details for each device that failed to send its position to the tracker resource.

*/ @property (nonatomic, strong) NSArray * _Nullable errors; @end /**

Contains the batch request error details associated with the request.

*/ @interface AWSLocationBatchItemError : AWSModel /**

The error code associated with the batch request error.

*/ @property (nonatomic, assign) AWSLocationBatchItemErrorCode code; /**

A message with the reason for the batch request error.

*/ @property (nonatomic, strong) NSString * _Nullable message; @end /**

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

Required parameters: [Error, GeofenceId] */ @interface AWSLocationBatchPutGeofenceError : AWSModel /**

Contains details associated to the batch error.

*/ @property (nonatomic, strong) AWSLocationBatchItemError * _Nullable error; /**

The geofence associated with the error message.

*/ @property (nonatomic, strong) NSString * _Nullable geofenceId; @end /** */ @interface AWSLocationBatchPutGeofenceRequest : AWSRequest /**

The geofence collection storing the geofences.

*/ @property (nonatomic, strong) NSString * _Nullable collectionName; /**

The batch of geofences to be stored in a geofence collection.

*/ @property (nonatomic, strong) NSArray * _Nullable entries; @end /**

Contains geofence geometry details.

Required parameters: [GeofenceId, Geometry] */ @interface AWSLocationBatchPutGeofenceRequestEntry : AWSModel /**

The identifier for the geofence to be stored in a given geofence collection.

*/ @property (nonatomic, strong) NSString * _Nullable geofenceId; /**

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"

*/ @property (nonatomic, strong) NSDictionary * _Nullable geofenceProperties; /**

Contains the details of the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.

Each geofence polygon can have a maximum of 1,000 vertices.

 */ @property (nonatomic, strong) AWSLocationGeofenceGeometry * _Nullable geometry; @end /** */ @interface AWSLocationBatchPutGeofenceResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSArray * _Nullable errors; /**

Contains each geofence that was successfully stored in a geofence collection.

*/ @property (nonatomic, strong) NSArray * _Nullable successes; @end /**

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

Required parameters: [CreateTime, GeofenceId, UpdateTime] */ @interface AWSLocationBatchPutGeofenceSuccess : AWSModel /**

The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

The geofence successfully stored in a geofence collection.

*/ @property (nonatomic, strong) NSString * _Nullable geofenceId; /**

The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /**

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

Required parameters: [DeviceId, Error, SampleTime] */ @interface AWSLocationBatchUpdateDevicePositionError : AWSModel /**

The device associated with the failed location update.

*/ @property (nonatomic, strong) NSString * _Nullable deviceId; /**

Contains details related to the error code such as the error code and error message.

*/ @property (nonatomic, strong) AWSLocationBatchItemError * _Nullable error; /**

The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable sampleTime; @end /** */ @interface AWSLocationBatchUpdateDevicePositionRequest : AWSRequest /**

The name of the tracker resource to update.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; /**

Contains the position update details for each device, up to 10 devices.

*/ @property (nonatomic, strong) NSArray * _Nullable updates; @end /** */ @interface AWSLocationBatchUpdateDevicePositionResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSArray * _Nullable errors; @end /**

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

*/ @interface AWSLocationCalculateRouteCarModeOptions : AWSModel /**

Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

*/ @property (nonatomic, strong) NSNumber * _Nullable avoidFerries; /**

Avoids tolls when calculating routes.

Default Value: false

Valid Values: false | true

*/ @property (nonatomic, strong) NSNumber * _Nullable avoidTolls; @end /** */ @interface AWSLocationCalculateRouteMatrixRequest : AWSRequest /**

The name of the route calculator resource that you want to use to calculate the route matrix.

*/ @property (nonatomic, strong) NSString * _Nullable calculatorName; /**

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

*/ @property (nonatomic, strong) AWSLocationCalculateRouteCarModeOptions * _Nullable carModeOptions; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable departNow; /**

The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285].

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.

Valid Values: [-180 to 180,-90 to 90]

*/ @property (nonatomic, strong) NSArray *> * _Nullable departurePositions; /**

Specifies the desired time of departure. Uses the given time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

Setting a departure time in the past returns a 400 ValidationException error.

  • In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

*/ @property (nonatomic, strong) NSDate * _Nullable departureTime; /**

The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615]

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.

Valid Values: [-180 to 180,-90 to 90]

*/ @property (nonatomic, strong) NSArray *> * _Nullable destinationPositions; /**

Set the unit system to specify the distance.

Default Value: Kilometers

*/ @property (nonatomic, assign) AWSLocationDistanceUnit distanceUnit; /**

The optional API key to authorize the request.

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

The TravelMode you specify also determines how you specify route preferences:

  • If traveling by Car use the CarModeOptions parameter.

  • If traveling by Truck use the TruckModeOptions parameter.

Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

Truck is not available for Grab.

For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

Default Value: Car

*/ @property (nonatomic, assign) AWSLocationTravelMode 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.

*/ @property (nonatomic, strong) AWSLocationCalculateRouteTruckModeOptions * _Nullable truckModeOptions; @end /**

Returns the result of the route matrix calculation.

Required parameters: [RouteMatrix, Summary] */ @interface AWSLocationCalculateRouteMatrixResponse : AWSModel /**

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.

*/ @property (nonatomic, strong) NSArray *> * _Nullable routeMatrix; /**

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.

*/ @property (nonatomic, strong) NSArray *> * _Nullable snappedDeparturePositions; /**

The list of destination positions for the route matrix used for calculation of the RouteMatrix.

*/ @property (nonatomic, strong) NSArray *> * _Nullable snappedDestinationPositions; /**

Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.

*/ @property (nonatomic, strong) AWSLocationCalculateRouteMatrixSummary * _Nullable summary; @end /**

A summary of the calculated route matrix.

Required parameters: [DataSource, DistanceUnit, ErrorCount, RouteCount] */ @interface AWSLocationCalculateRouteMatrixSummary : AWSModel /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable dataSource; /**

The unit of measurement for route distances.

*/ @property (nonatomic, assign) AWSLocationDistanceUnit distanceUnit; /**

The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

*/ @property (nonatomic, strong) NSNumber * _Nullable errorCount; /**

The count of cells in the route matrix. Equal to the number of DeparturePositions multiplied by the number of DestinationPositions.

*/ @property (nonatomic, strong) NSNumber * _Nullable routeCount; @end /** */ @interface AWSLocationCalculateRouteRequest : AWSRequest /**

The name of the route calculator resource that you want to use to calculate the route.

*/ @property (nonatomic, strong) NSString * _Nullable calculatorName; /**

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

*/ @property (nonatomic, strong) AWSLocationCalculateRouteCarModeOptions * _Nullable carModeOptions; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable departNow; /**

The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

  • For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

*/ @property (nonatomic, strong) NSArray * _Nullable departurePosition; /**

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.

Setting a departure time in the past returns a 400 ValidationException error.

  • In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

*/ @property (nonatomic, strong) NSDate * _Nullable departureTime; /**

The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

  • For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

*/ @property (nonatomic, strong) NSArray * _Nullable destinationPosition; /**

Set the unit system to specify the distance.

Default Value: Kilometers

*/ @property (nonatomic, assign) AWSLocationDistanceUnit 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

*/ @property (nonatomic, strong) NSNumber * _Nullable includeLegGeometry; /**

The optional API key to authorize the request.

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, Walking, Bicycle or Motorcycle as options for the TravelMode.

Bicycle and Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

Truck is not available for Grab.

For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide.

The TravelMode you specify also determines how you specify route preferences:

  • If traveling by Car use the CarModeOptions parameter.

  • If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

*/ @property (nonatomic, assign) AWSLocationTravelMode 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.

*/ @property (nonatomic, strong) AWSLocationCalculateRouteTruckModeOptions * _Nullable truckModeOptions; /**

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

  • For example, from the DeparturePosition[-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

*/ @property (nonatomic, strong) NSArray *> * _Nullable waypointPositions; @end /**

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

Required parameters: [Legs, Summary] */ @interface AWSLocationCalculateRouteResponse : AWSModel /**

Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.

For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:

  • The StartPosition is the departure position.

  • The EndPosition is the destination position.

A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

  • Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.

  • Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.

*/ @property (nonatomic, strong) NSArray * _Nullable legs; /**

Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.

*/ @property (nonatomic, strong) AWSLocationCalculateRouteSummary * _Nullable summary; @end /**

A summary of the calculated route.

Required parameters: [DataSource, Distance, DistanceUnit, DurationSeconds, RouteBBox] */ @interface AWSLocationCalculateRouteSummary : AWSModel /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable dataSource; /**

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.

 */ @property (nonatomic, strong) NSNumber * _Nullable distance; /**

The unit of measurement for route distances.

*/ @property (nonatomic, assign) AWSLocationDistanceUnit distanceUnit; /**

The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

*/ @property (nonatomic, strong) NSNumber * _Nullable durationSeconds; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable routeBBox; @end /**

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

*/ @interface AWSLocationCalculateRouteTruckModeOptions : AWSModel /**

Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

*/ @property (nonatomic, strong) NSNumber * _Nullable avoidFerries; /**

Avoids tolls when calculating routes.

Default Value: false

Valid Values: false | true

*/ @property (nonatomic, strong) NSNumber * _Nullable avoidTolls; /**

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.

*/ @property (nonatomic, strong) AWSLocationTruckDimensions * _Nullable dimensions; /**

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.

*/ @property (nonatomic, strong) AWSLocationTruckWeight * _Nullable weight; @end /**

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

Required parameters: [Center, Radius] */ @interface AWSLocationCircle : AWSModel /**

A single point geometry, specifying the center of the circle, using WGS 84 coordinates, in the form [longitude, latitude].

*/ @property (nonatomic, strong) NSArray * _Nullable center; /**

The radius of the circle in meters. Must be greater than zero and no larger than 100,000 (100 kilometers).

*/ @property (nonatomic, strong) NSNumber * _Nullable radius; @end /** */ @interface AWSLocationCreateGeofenceCollectionRequest : AWSRequest /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable collectionName; /**

An optional description for the geofence collection.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

*/ @property (nonatomic, strong) NSString * _Nullable kmsKeyId; /**

No longer used. If included, the only allowed value is RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; /**

This parameter is no longer used.

*/ @property (nonatomic, strong) NSString * _Nullable pricingPlanDataSource; /**

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.

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; @end /** */ @interface AWSLocationCreateGeofenceCollectionResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable collectionArn; /**

The name for the geofence collection.

*/ @property (nonatomic, strong) NSString * _Nullable collectionName; /**

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; @end /** */ @interface AWSLocationCreateKeyRequest : AWSRequest /**

An optional description for the API key resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.

*/ @property (nonatomic, strong) NSDate * _Nullable expireTime; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable keyName; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable noExpiry; /**

The API key restrictions for the API key resource.

*/ @property (nonatomic, strong) AWSLocationApiKeyRestrictions * _Nullable restrictions; /**

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.

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; @end /** */ @interface AWSLocationCreateKeyResponse : AWSModel /**

The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

The key value/string of an API key. This value is used when making API calls to authorize the call. For example, see GetMapGlyphs.

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable keyArn; /**

The name of the API key resource.

*/ @property (nonatomic, strong) NSString * _Nullable keyName; @end /** */ @interface AWSLocationCreateMapRequest : AWSRequest /**

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.

*/ @property (nonatomic, strong) AWSLocationMapConfiguration * _Nullable configuration; /**

An optional description for the map resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable mapName; /**

No longer used. If included, the only allowed value is RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan 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.

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; @end /** */ @interface AWSLocationCreateMapResponse : AWSModel /**

The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable mapArn; /**

The name of the map resource.

*/ @property (nonatomic, strong) NSString * _Nullable mapName; @end /** */ @interface AWSLocationCreatePlaceIndexRequest : AWSRequest /**

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:

For additional information , see Data providers on the Amazon Location Service Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable dataSource; /**

Specifies the data storage option requesting Places.

*/ @property (nonatomic, strong) AWSLocationDataSourceConfiguration * _Nullable dataSourceConfiguration; /**

The optional description for the place index resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

No longer used. If included, the only allowed value is RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan 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.

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; @end /** */ @interface AWSLocationCreatePlaceIndexResponse : AWSModel /**

The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable indexArn; /**

The name for the place index resource.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; @end /** */ @interface AWSLocationCreateRouteCalculatorRequest : AWSRequest /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable calculatorName; /**

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:

For additional information , see Data providers on the Amazon Location Service Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable dataSource; /**

The optional description for the route calculator resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

No longer used. If included, the only allowed value is RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan 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.

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; @end /** */ @interface AWSLocationCreateRouteCalculatorResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable calculatorArn; /**

The name of the route calculator resource.

  • For example, ExampleRouteCalculator.

*/ @property (nonatomic, strong) NSString * _Nullable calculatorName; /**

The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • For example, 2020–07-2T12:15:20.000Z+01:00

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; @end /** */ @interface AWSLocationCreateTrackerRequest : AWSRequest /**

An optional description for the tracker resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

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.

 */ @property (nonatomic, strong) NSNumber * _Nullable eventBridgeEnabled; /**

A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

*/ @property (nonatomic, strong) NSString * _Nullable kmsKeyId; /**

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.

*/ @property (nonatomic, assign) AWSLocationPositionFiltering positionFiltering; /**

No longer used. If included, the only allowed value is RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; /**

This parameter is no longer used.

*/ @property (nonatomic, strong) NSString * _Nullable pricingPlanDataSource; /**

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.

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; @end /** */ @interface AWSLocationCreateTrackerResponse : AWSModel /**

The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable trackerArn; /**

The name of the tracker resource.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; @end /**

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 for Amazon Location Service.

 */ @interface AWSLocationDataSourceConfiguration : AWSModel /**

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

*/ @property (nonatomic, assign) AWSLocationIntendedUse intendedUse; @end /** */ @interface AWSLocationDeleteGeofenceCollectionRequest : AWSRequest /**

The name of the geofence collection to be deleted.

*/ @property (nonatomic, strong) NSString * _Nullable collectionName; @end /** */ @interface AWSLocationDeleteGeofenceCollectionResponse : AWSModel @end /** */ @interface AWSLocationDeleteKeyRequest : AWSRequest /**

The name of the API key to delete.

*/ @property (nonatomic, strong) NSString * _Nullable keyName; @end /** */ @interface AWSLocationDeleteKeyResponse : AWSModel @end /** */ @interface AWSLocationDeleteMapRequest : AWSRequest /**

The name of the map resource to be deleted.

*/ @property (nonatomic, strong) NSString * _Nullable mapName; @end /** */ @interface AWSLocationDeleteMapResponse : AWSModel @end /** */ @interface AWSLocationDeletePlaceIndexRequest : AWSRequest /**

The name of the place index resource to be deleted.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; @end /** */ @interface AWSLocationDeletePlaceIndexResponse : AWSModel @end /** */ @interface AWSLocationDeleteRouteCalculatorRequest : AWSRequest /**

The name of the route calculator resource to be deleted.

*/ @property (nonatomic, strong) NSString * _Nullable calculatorName; @end /** */ @interface AWSLocationDeleteRouteCalculatorResponse : AWSModel @end /** */ @interface AWSLocationDeleteTrackerRequest : AWSRequest /**

The name of the tracker resource to be deleted.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; @end /** */ @interface AWSLocationDeleteTrackerResponse : AWSModel @end /** */ @interface AWSLocationDescribeGeofenceCollectionRequest : AWSRequest /**

The name of the geofence collection.

*/ @property (nonatomic, strong) NSString * _Nullable collectionName; @end /** */ @interface AWSLocationDescribeGeofenceCollectionResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable collectionArn; /**

The name of the geofence collection.

*/ @property (nonatomic, strong) NSString * _Nullable collectionName; /**

The timestamp for when the geofence resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

The optional description for the geofence collection.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource

*/ @property (nonatomic, strong) NSString * _Nullable kmsKeyId; /**

No longer used. Always returns RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; /**

No longer used. Always returns an empty string.

*/ @property (nonatomic, strong) NSString * _Nullable pricingPlanDataSource; /**

Displays the key, value pairs of tags associated with this resource.

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; /**

The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /** */ @interface AWSLocationDescribeKeyRequest : AWSRequest /**

The name of the API key resource.

*/ @property (nonatomic, strong) NSString * _Nullable keyName; @end /** */ @interface AWSLocationDescribeKeyResponse : AWSModel /**

The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

The optional description for the API key resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

The timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable expireTime; /**

The key value/string of an API key.

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable keyArn; /**

The name of the API key resource.

*/ @property (nonatomic, strong) NSString * _Nullable keyName; /**

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

*/ @property (nonatomic, strong) AWSLocationApiKeyRestrictions * _Nullable restrictions; /**

Tags associated with the API key resource.

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; /**

The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /** */ @interface AWSLocationDescribeMapRequest : AWSRequest /**

The name of the map resource.

*/ @property (nonatomic, strong) NSString * _Nullable mapName; @end /** */ @interface AWSLocationDescribeMapResponse : AWSModel /**

Specifies the map tile style selected from a partner data provider.

*/ @property (nonatomic, strong) AWSLocationMapConfiguration * _Nullable configuration; /**

The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

Specifies the data provider for the associated map tiles.

*/ @property (nonatomic, strong) NSString * _Nullable dataSource; /**

The optional description for the map resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable mapArn; /**

The map style selected from an available provider.

*/ @property (nonatomic, strong) NSString * _Nullable mapName; /**

No longer used. Always returns RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; /**

Tags associated with the map resource.

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; /**

The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /** */ @interface AWSLocationDescribePlaceIndexRequest : AWSRequest /**

The name of the place index resource.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; @end /** */ @interface AWSLocationDescribePlaceIndexResponse : AWSModel /**

The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable dataSource; /**

The specified data storage option for requesting Places.

*/ @property (nonatomic, strong) AWSLocationDataSourceConfiguration * _Nullable dataSourceConfiguration; /**

The optional description for the place index resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable indexArn; /**

The name of the place index resource being described.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

No longer used. Always returns RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; /**

Tags associated with place index resource.

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; /**

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /** */ @interface AWSLocationDescribeRouteCalculatorRequest : AWSRequest /**

The name of the route calculator resource.

*/ @property (nonatomic, strong) NSString * _Nullable calculatorName; @end /** */ @interface AWSLocationDescribeRouteCalculatorResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable calculatorArn; /**

The name of the route calculator resource being described.

*/ @property (nonatomic, strong) NSString * _Nullable calculatorName; /**

The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • For example, 2020–07-2T12:15:20.000Z+01:00

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable dataSource; /**

The optional description of the route calculator resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

Always returns RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; /**

Tags associated with route calculator resource.

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; /**

The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • For example, 2020–07-2T12:15:20.000Z+01:00

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /** */ @interface AWSLocationDescribeTrackerRequest : AWSRequest /**

The name of the tracker resource.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; @end /** */ @interface AWSLocationDescribeTrackerResponse : AWSModel /**

The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

The optional description for the tracker resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable eventBridgeEnabled; /**

A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource.

*/ @property (nonatomic, strong) NSString * _Nullable kmsKeyId; /**

The position filtering method of the tracker resource.

*/ @property (nonatomic, assign) AWSLocationPositionFiltering positionFiltering; /**

Always returns RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; /**

No longer used. Always returns an empty string.

*/ @property (nonatomic, strong) NSString * _Nullable pricingPlanDataSource; /**

The tags associated with the tracker resource.

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable trackerArn; /**

The name of the tracker resource.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; /**

The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /**

Contains the device position details.

Required parameters: [Position, ReceivedTime, SampleTime] */ @interface AWSLocationDevicePosition : AWSModel /**

The accuracy of the device position.

*/ @property (nonatomic, strong) AWSLocationPositionalAccuracy * _Nullable accuracy; /**

The device whose position you retrieved.

*/ @property (nonatomic, strong) NSString * _Nullable deviceId; /**

The last known device position.

*/ @property (nonatomic, strong) NSArray * _Nullable position; /**

The properties associated with the position.

*/ @property (nonatomic, strong) NSDictionary * _Nullable positionProperties; /**

The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable receivedTime; /**

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable sampleTime; @end /**

Contains the position update details for a device.

Required parameters: [DeviceId, Position, SampleTime] */ @interface AWSLocationDevicePositionUpdate : AWSModel /**

The accuracy of the device position.

*/ @property (nonatomic, strong) AWSLocationPositionalAccuracy * _Nullable accuracy; /**

The device associated to the position update.

*/ @property (nonatomic, strong) NSString * _Nullable deviceId; /**

The latest device position defined in WGS 84 format: [X or longitude, Y or latitude].

*/ @property (nonatomic, strong) NSArray * _Nullable position; /**

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"

*/ @property (nonatomic, strong) NSDictionary * _Nullable positionProperties; /**

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

*/ @property (nonatomic, strong) NSDate * _Nullable sampleTime; @end /** */ @interface AWSLocationDisassociateTrackerConsumerRequest : AWSRequest /**

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

*/ @property (nonatomic, strong) NSString * _Nullable consumerArn; /**

The name of the tracker resource to be dissociated from the consumer.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; @end /** */ @interface AWSLocationDisassociateTrackerConsumerResponse : AWSModel @end /**

Contains the geofence geometry details.

A geofence geometry is made up of either a polygon or a circle. Can be either a polygon or a circle. Including both 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.

*/ @interface AWSLocationGeofenceGeometry : AWSModel /**

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

*/ @property (nonatomic, strong) AWSLocationCircle * _Nullable circle; /**

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.

*/ @property (nonatomic, strong) NSArray *> *> * _Nullable polygon; @end /** */ @interface AWSLocationGetDevicePositionHistoryRequest : AWSRequest /**

The device whose position history you want to retrieve.

*/ @property (nonatomic, strong) NSString * _Nullable deviceId; /**

Specify the end time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the request is made.

Requirement:

  • The time specified for EndTimeExclusive must be after the time for StartTimeInclusive.

*/ @property (nonatomic, strong) NSDate * _Nullable endTimeExclusive; /**

An optional limit for the number of device positions returned in a single call.

Default value: 100

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

Specify the start time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours prior to the time that the request is made.

Requirement:

  • The time specified for StartTimeInclusive must be before EndTimeExclusive.

*/ @property (nonatomic, strong) NSDate * _Nullable startTimeInclusive; /**

The tracker resource receiving the request for the device position history.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; @end /** */ @interface AWSLocationGetDevicePositionHistoryResponse : AWSModel /**

Contains the position history details for the requested device.

*/ @property (nonatomic, strong) NSArray * _Nullable devicePositions; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSLocationGetDevicePositionRequest : AWSRequest /**

The device whose position you want to retrieve.

*/ @property (nonatomic, strong) NSString * _Nullable deviceId; /**

The tracker resource receiving the position update.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; @end /** */ @interface AWSLocationGetDevicePositionResponse : AWSModel /**

The accuracy of the device position.

*/ @property (nonatomic, strong) AWSLocationPositionalAccuracy * _Nullable accuracy; /**

The device whose position you retrieved.

*/ @property (nonatomic, strong) NSString * _Nullable deviceId; /**

The last known device position.

*/ @property (nonatomic, strong) NSArray * _Nullable position; /**

The properties associated with the position.

*/ @property (nonatomic, strong) NSDictionary * _Nullable positionProperties; /**

The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable receivedTime; /**

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable sampleTime; @end /** */ @interface AWSLocationGetGeofenceRequest : AWSRequest /**

The geofence collection storing the target geofence.

*/ @property (nonatomic, strong) NSString * _Nullable collectionName; /**

The geofence you're retrieving details for.

*/ @property (nonatomic, strong) NSString * _Nullable geofenceId; @end /** */ @interface AWSLocationGetGeofenceResponse : AWSModel /**

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

The geofence identifier.

*/ @property (nonatomic, strong) NSString * _Nullable geofenceId; /**

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"

*/ @property (nonatomic, strong) NSDictionary * _Nullable geofenceProperties; /**

Contains the geofence geometry details describing a polygon or a circle.

*/ @property (nonatomic, strong) AWSLocationGeofenceGeometry * _Nullable geometry; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable status; /**

The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /** */ @interface AWSLocationGetMapGlyphsRequest : AWSRequest /**

A comma-separated list of fonts to load glyphs from in order of preference. For example, Noto Sans Regular, Arial Unicode.

Valid fonts stacks for Esri styles:

  • VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu Regular | Ubuntu Bold

  • VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu Bold

  • VectorEsriTopographic – Noto Sans Italic | Noto Sans Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light Italic

  • VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold

  • VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold

Valid font stacks for HERE Technologies styles:

  • VectorHereContrast – Fira GO Regular | Fira GO Bold

  • VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – Fira GO Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold | Noto Sans CJK JP Light | Noto Sans CJK JP Regular

Valid font stacks for GrabMaps styles:

  • VectorGrabStandardLight, VectorGrabStandardDark – Noto Sans Regular | Noto Sans Medium | Noto Sans Bold

Valid font stacks for Open Data styles:

  • VectorOpenDataStandardLight, VectorOpenDataStandardDark, VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – Amazon Ember Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon Ember Medium,Noto Sans Medium | Amazon Ember Regular Italic,Noto Sans Italic | Amazon Ember Condensed RC Regular,Noto Sans Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold | Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold | Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold | Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular | Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular | Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium

The fonts used by the Open Data map styles are combined fonts that use Amazon Ember for most glyphs but Noto Sans for glyphs unsupported by Amazon Ember.

 */ @property (nonatomic, strong) NSString * _Nullable fontStack; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable fontUnicodeRange; /**

The optional API key to authorize the request.

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

The map resource associated with the glyph file.

*/ @property (nonatomic, strong) NSString * _Nullable mapName; @end /** */ @interface AWSLocationGetMapGlyphsResponse : AWSModel /**

The glyph, as binary blob.

*/ @property (nonatomic, strong) NSData * _Nullable blob; /**

The HTTP Cache-Control directive for the value.

*/ @property (nonatomic, strong) NSString * _Nullable cacheControl; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable contentType; @end /** */ @interface AWSLocationGetMapSpritesRequest : AWSRequest /**

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

*/ @property (nonatomic, strong) NSString * _Nullable fileName; /**

The optional API key to authorize the request.

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

The map resource associated with the sprite file.

*/ @property (nonatomic, strong) NSString * _Nullable mapName; @end /** */ @interface AWSLocationGetMapSpritesResponse : AWSModel /**

Contains the body of the sprite sheet or JSON offset file.

*/ @property (nonatomic, strong) NSData * _Nullable blob; /**

The HTTP Cache-Control directive for the value.

*/ @property (nonatomic, strong) NSString * _Nullable cacheControl; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable contentType; @end /** */ @interface AWSLocationGetMapStyleDescriptorRequest : AWSRequest /**

The optional API key to authorize the request.

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

The map resource to retrieve the style descriptor from.

*/ @property (nonatomic, strong) NSString * _Nullable mapName; @end /** */ @interface AWSLocationGetMapStyleDescriptorResponse : AWSModel /**

Contains the body of the style descriptor.

*/ @property (nonatomic, strong) NSData * _Nullable blob; /**

The HTTP Cache-Control directive for the value.

*/ @property (nonatomic, strong) NSString * _Nullable cacheControl; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable contentType; @end /** */ @interface AWSLocationGetMapTileRequest : AWSRequest /**

The optional API key to authorize the request.

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

The map resource to retrieve the map tiles from.

*/ @property (nonatomic, strong) NSString * _Nullable mapName; /**

The X axis value for the map tile.

*/ @property (nonatomic, strong) NSString * _Nullable X; /**

The Y axis value for the map tile.

*/ @property (nonatomic, strong) NSString * _Nullable Y; /**

The zoom value for the map tile.

*/ @property (nonatomic, strong) NSString * _Nullable Z; @end /** */ @interface AWSLocationGetMapTileResponse : AWSModel /**

Contains Mapbox Vector Tile (MVT) data.

*/ @property (nonatomic, strong) NSData * _Nullable blob; /**

The HTTP Cache-Control directive for the value.

*/ @property (nonatomic, strong) NSString * _Nullable cacheControl; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable contentType; @end /** */ @interface AWSLocationGetPlaceRequest : AWSRequest /**

The name of the place index resource that you want to use for the search.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The optional API key to authorize the request.

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

*/ @property (nonatomic, strong) NSString * _Nullable language; /**

The identifier of the place to find.

*/ @property (nonatomic, strong) NSString * _Nullable placeId; @end /** */ @interface AWSLocationGetPlaceResponse : AWSModel /**

Details about the result, such as its address and position.

*/ @property (nonatomic, strong) AWSLocationPlace * _Nullable place; @end /**

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:

  • 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.

Required parameters: [Distance, DurationSeconds, EndPosition, StartPosition, Steps] */ @interface AWSLocationLeg : AWSModel /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable distance; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable durationSeconds; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable endPosition; /**

Contains the calculated route's path as a linestring geometry.

*/ @property (nonatomic, strong) AWSLocationLegGeometry * _Nullable geometry; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable startPosition; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable steps; @end /**

Contains the geometry details for each path between a pair of positions. Used in plotting a route leg on a map.

*/ @interface AWSLocationLegGeometry : AWSModel /**

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

*/ @property (nonatomic, strong) NSArray *> * _Nullable lineString; @end /** */ @interface AWSLocationListDevicePositionsRequest : AWSRequest /**

An optional limit for the number of entries returned in a single call.

Default value: 100

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The tracker resource containing the requested devices.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; @end /** */ @interface AWSLocationListDevicePositionsResponse : AWSModel /**

Contains details about each device's last known position. These details includes the device ID, the time when the position was sampled on the device, the time that the service received the update, and the most recent coordinates.

*/ @property (nonatomic, strong) NSArray * _Nullable entries; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /**

Contains the tracker resource details.

Required parameters: [DeviceId, Position, SampleTime] */ @interface AWSLocationListDevicePositionsResponseEntry : AWSModel /**

The accuracy of the device position.

*/ @property (nonatomic, strong) AWSLocationPositionalAccuracy * _Nullable accuracy; /**

The ID of the device for this position.

*/ @property (nonatomic, strong) NSString * _Nullable deviceId; /**

The last known device position. Empty if no positions currently stored.

*/ @property (nonatomic, strong) NSArray * _Nullable position; /**

The properties associated with the position.

*/ @property (nonatomic, strong) NSDictionary * _Nullable positionProperties; /**

The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable sampleTime; @end /** */ @interface AWSLocationListGeofenceCollectionsRequest : AWSRequest /**

An optional limit for the number of resources returned in a single call.

Default value: 100

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSLocationListGeofenceCollectionsResponse : AWSModel /**

Lists the geofence collections that exist in your Amazon Web Services account.

*/ @property (nonatomic, strong) NSArray * _Nullable entries; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /**

Contains the geofence collection details.

Required parameters: [CollectionName, CreateTime, Description, UpdateTime] */ @interface AWSLocationListGeofenceCollectionsResponseEntry : AWSModel /**

The name of the geofence collection.

*/ @property (nonatomic, strong) NSString * _Nullable collectionName; /**

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

The description for the geofence collection

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

No longer used. Always returns RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; /**

No longer used. Always returns an empty string.

*/ @property (nonatomic, strong) NSString * _Nullable pricingPlanDataSource; /**

Specifies a timestamp for when the resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /**

Contains a list of geofences stored in a given geofence collection.

Required parameters: [CreateTime, GeofenceId, Geometry, Status, UpdateTime] */ @interface AWSLocationListGeofenceResponseEntry : AWSModel /**

The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

The geofence identifier.

*/ @property (nonatomic, strong) NSString * _Nullable geofenceId; /**

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"

*/ @property (nonatomic, strong) NSDictionary * _Nullable geofenceProperties; /**

Contains the geofence geometry details describing a polygon or a circle.

*/ @property (nonatomic, strong) AWSLocationGeofenceGeometry * _Nullable geometry; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable status; /**

The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /** */ @interface AWSLocationListGeofencesRequest : AWSRequest /**

The name of the geofence collection storing the list of geofences.

*/ @property (nonatomic, strong) NSString * _Nullable collectionName; /**

An optional limit for the number of geofences returned in a single call.

Default value: 100

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSLocationListGeofencesResponse : AWSModel /**

Contains a list of geofences stored in the geofence collection.

*/ @property (nonatomic, strong) NSArray * _Nullable entries; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSLocationListKeysRequest : AWSRequest /**

Optionally filter the list to only Active or Expired API keys.

*/ @property (nonatomic, strong) AWSLocationApiKeyFilter * _Nullable filter; /**

An optional limit for the number of resources returned in a single call.

Default value: 100

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSLocationListKeysResponse : AWSModel /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable entries; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /**

An API key resource listed in your Amazon Web Services account.

Required parameters: [CreateTime, ExpireTime, KeyName, Restrictions, UpdateTime] */ @interface AWSLocationListKeysResponseEntry : AWSModel /**

The timestamp of when the API key was created, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

The optional description for the API key resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

The timestamp for when the API key resource will expire, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable expireTime; /**

The name of the API key resource.

*/ @property (nonatomic, strong) NSString * _Nullable keyName; /**

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

*/ @property (nonatomic, strong) AWSLocationApiKeyRestrictions * _Nullable restrictions; /**

The timestamp of when the API key was last updated, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /** */ @interface AWSLocationListMapsRequest : AWSRequest /**

An optional limit for the number of resources returned in a single call.

Default value: 100

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSLocationListMapsResponse : AWSModel /**

Contains a list of maps in your Amazon Web Services account

*/ @property (nonatomic, strong) NSArray * _Nullable entries; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /**

Contains details of an existing map resource in your Amazon Web Services account.

Required parameters: [CreateTime, DataSource, Description, MapName, UpdateTime] */ @interface AWSLocationListMapsResponseEntry : AWSModel /**

The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

Specifies the data provider for the associated map tiles.

*/ @property (nonatomic, strong) NSString * _Nullable dataSource; /**

The description for the map resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

The name of the associated map resource.

*/ @property (nonatomic, strong) NSString * _Nullable mapName; /**

No longer used. Always returns RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; /**

The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /** */ @interface AWSLocationListPlaceIndexesRequest : AWSRequest /**

An optional limit for the maximum number of results returned in a single call.

Default value: 100

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSLocationListPlaceIndexesResponse : AWSModel /**

Lists the place index resources that exist in your Amazon Web Services account

*/ @property (nonatomic, strong) NSArray * _Nullable entries; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /**

A place index resource listed in your Amazon Web Services account.

Required parameters: [CreateTime, DataSource, Description, IndexName, UpdateTime] */ @interface AWSLocationListPlaceIndexesResponseEntry : AWSModel /**

The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable dataSource; /**

The optional description for the place index resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

The name of the place index resource.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

No longer used. Always returns RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; /**

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /** */ @interface AWSLocationListRouteCalculatorsRequest : AWSRequest /**

An optional maximum number of results returned in a single call.

Default Value: 100

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSLocationListRouteCalculatorsResponse : AWSModel /**

Lists the route calculator resources that exist in your Amazon Web Services account

*/ @property (nonatomic, strong) NSArray * _Nullable entries; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /**

A route calculator resource listed in your Amazon Web Services account.

Required parameters: [CalculatorName, CreateTime, DataSource, Description, UpdateTime] */ @interface AWSLocationListRouteCalculatorsResponseEntry : AWSModel /**

The name of the route calculator resource.

*/ @property (nonatomic, strong) NSString * _Nullable calculatorName; /**

The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • For example, 2020–07-2T12:15:20.000Z+01:00

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable dataSource; /**

The optional description of the route calculator resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

Always returns RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; /**

The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • For example, 2020–07-2T12:15:20.000Z+01:00

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /** */ @interface AWSLocationListTagsForResourceRequest : AWSRequest /**

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

  • Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; @end /** */ @interface AWSLocationListTagsForResourceResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; @end /** */ @interface AWSLocationListTrackerConsumersRequest : AWSRequest /**

An optional limit for the number of resources returned in a single call.

Default value: 100

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The tracker resource whose associated geofence collections you want to list.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; @end /** */ @interface AWSLocationListTrackerConsumersResponse : AWSModel /**

Contains the list of geofence collection ARNs associated to the tracker resource.

*/ @property (nonatomic, strong) NSArray * _Nullable consumerArns; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSLocationListTrackersRequest : AWSRequest /**

An optional limit for the number of resources returned in a single call.

Default value: 100

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSLocationListTrackersResponse : AWSModel /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable entries; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /**

Contains the tracker resource details.

Required parameters: [CreateTime, Description, TrackerName, UpdateTime] */ @interface AWSLocationListTrackersResponseEntry : AWSModel /**

The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

The description for the tracker resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

Always returns RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; /**

No longer used. Always returns an empty string.

*/ @property (nonatomic, strong) NSString * _Nullable pricingPlanDataSource; /**

The name of the tracker resource.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; /**

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /**

Specifies the map tile style selected from an available provider.

Required parameters: [Style] */ @interface AWSLocationMapConfiguration : AWSModel /**

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 for more information.

 */ @property (nonatomic, strong) NSString * _Nullable politicalView; /**

Specifies the map style selected from an available data provider.

Valid Esri map styles:

  • 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:

  • 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:

  • 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.

Valid Open Data map styles:

  • 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.

*/ @property (nonatomic, strong) NSString * _Nullable style; @end /**

Specifies the political view for the style.

*/ @interface AWSLocationMapConfigurationUpdate : AWSModel /**

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 for more information.

 */ @property (nonatomic, strong) NSString * _Nullable politicalView; @end /**

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.

Required parameters: [Geometry] */ @interface AWSLocationPlace : AWSModel /**

The numerical portion of an address, such as a building number.

*/ @property (nonatomic, strong) NSString * _Nullable addressNumber; /**

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, in the Amazon Location Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable categories; /**

A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.

*/ @property (nonatomic, strong) NSString * _Nullable country; /**

Places uses a point geometry to specify a location or a Place.

*/ @property (nonatomic, strong) AWSLocationPlaceGeometry * _Nullable geometry; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable interpolated; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable label; /**

A name for a local area, such as a city or town name. For example, Toronto.

*/ @property (nonatomic, strong) NSString * _Nullable municipality; /**

The name of a community district. For example, Downtown.

*/ @property (nonatomic, strong) NSString * _Nullable neighborhood; /**

A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.

*/ @property (nonatomic, strong) NSString * _Nullable postalCode; /**

A name for an area or geographical division, such as a province or state name. For example, British Columbia.

*/ @property (nonatomic, strong) NSString * _Nullable region; /**

The name for a street or a road to identify a location. For example, Main Street.

*/ @property (nonatomic, strong) NSString * _Nullable street; /**

A county, or an area that's part of a larger region. For example, Metro Vancouver.

*/ @property (nonatomic, strong) NSString * _Nullable subRegion; /**

Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.

*/ @property (nonatomic, strong) NSArray * _Nullable supplementalCategories; /**

The time zone in which the Place is located. Returned only when using HERE or Grab as the selected partner.

*/ @property (nonatomic, strong) AWSLocationTimeZone * _Nullable timeZone; /**

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.

 */ @property (nonatomic, strong) NSString * _Nullable unitNumber; /**

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.

 */ @property (nonatomic, strong) NSString * _Nullable unitType; @end /**

Places uses a point geometry to specify a location or a Place.

*/ @interface AWSLocationPlaceGeometry : AWSModel /**

A single point geometry specifies a location for a Place using WGS 84 coordinates:

  • x — Specifies the x coordinate or longitude.

  • y — Specifies the y coordinate or latitude.

*/ @property (nonatomic, strong) NSArray * _Nullable point; @end /**

Defines the level of certainty of the position.

Required parameters: [Horizontal] */ @interface AWSLocationPositionalAccuracy : AWSModel /**

Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.

*/ @property (nonatomic, strong) NSNumber * _Nullable horizontal; @end /** */ @interface AWSLocationPutGeofenceRequest : AWSRequest /**

The geofence collection to store the geofence in.

*/ @property (nonatomic, strong) NSString * _Nullable collectionName; /**

An identifier for the geofence. For example, ExampleGeofence-1.

*/ @property (nonatomic, strong) NSString * _Nullable geofenceId; /**

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"

*/ @property (nonatomic, strong) NSDictionary * _Nullable geofenceProperties; /**

Contains the details to specify the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.

Each geofence polygon can have a maximum of 1,000 vertices.

 */ @property (nonatomic, strong) AWSLocationGeofenceGeometry * _Nullable geometry; @end /** */ @interface AWSLocationPutGeofenceResponse : AWSModel /**

The timestamp for when the geofence was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

The geofence identifier entered in the request.

*/ @property (nonatomic, strong) NSString * _Nullable geofenceId; /**

The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /**

The result for the calculated route of one DeparturePositionDestinationPosition pair.

*/ @interface AWSLocationRouteMatrixEntry : AWSModel /**

The total distance of travel for the route.

*/ @property (nonatomic, strong) NSNumber * _Nullable distance; /**

The expected duration of travel for the route.

*/ @property (nonatomic, strong) NSNumber * _Nullable durationSeconds; /**

An error corresponding to the calculation of a route between the DeparturePosition and DestinationPosition.

*/ @property (nonatomic, strong) AWSLocationRouteMatrixEntryError * _Nullable error; @end /**

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

Required parameters: [Code] */ @interface AWSLocationRouteMatrixEntryError : AWSModel /**

The type of error which occurred for the route calculation.

*/ @property (nonatomic, assign) AWSLocationRouteMatrixErrorCode code; /**

A message about the error that occurred for the route calculation.

*/ @property (nonatomic, strong) NSString * _Nullable message; @end /**

Contains a search result from a position search query that is run on a place index resource.

Required parameters: [Distance, Place] */ @interface AWSLocationSearchForPositionResult : AWSModel /**

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.

 */ @property (nonatomic, strong) NSNumber * _Nullable distance; /**

Details about the search result, such as its address and position.

*/ @property (nonatomic, strong) AWSLocationPlace * _Nullable place; /**

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.

 */ @property (nonatomic, strong) NSString * _Nullable placeId; @end /**

Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.

Required parameters: [Text] */ @interface AWSLocationSearchForSuggestionsResult : AWSModel /**

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, in the Amazon Location Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable categories; /**

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.

 */ @property (nonatomic, strong) NSString * _Nullable placeId; /**

Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.

*/ @property (nonatomic, strong) NSArray * _Nullable supplementalCategories; /**

The text of the place suggestion, typically formatted as an address string.

*/ @property (nonatomic, strong) NSString * _Nullable text; @end /**

Contains a search result from a text search query that is run on a place index resource.

Required parameters: [Place] */ @interface AWSLocationSearchForTextResult : AWSModel /**

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.

 */ @property (nonatomic, strong) NSNumber * _Nullable distance; /**

Details about the search result, such as its address and position.

*/ @property (nonatomic, strong) AWSLocationPlace * _Nullable place; /**

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.

 */ @property (nonatomic, strong) NSString * _Nullable placeId; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable relevance; @end /** */ @interface AWSLocationSearchPlaceIndexForPositionRequest : AWSRequest /**

The name of the place index resource you want to use for the search.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The optional API key to authorize the request.

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

*/ @property (nonatomic, strong) NSString * _Nullable language; /**

An optional parameter. The maximum number of results returned per request.

Default value: 50

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable position; @end /** */ @interface AWSLocationSearchPlaceIndexForPositionResponse : AWSModel /**

Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned.

*/ @property (nonatomic, strong) NSArray * _Nullable results; /**

Contains a summary of the request. Echoes the input values for Position, Language, MaxResults, and the DataSource of the place index.

*/ @property (nonatomic, strong) AWSLocationSearchPlaceIndexForPositionSummary * _Nullable summary; @end /**

A summary of the request sent by using SearchPlaceIndexForPosition.

Required parameters: [DataSource, Position] */ @interface AWSLocationSearchPlaceIndexForPositionSummary : AWSModel /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable dataSource; /**

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

*/ @property (nonatomic, strong) NSString * _Nullable language; /**

Contains the optional result count limit that is specified in the request.

Default value: 50

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

The position specified in the request.

*/ @property (nonatomic, strong) NSArray * _Nullable position; @end /** */ @interface AWSLocationSearchPlaceIndexForSuggestionsRequest : AWSRequest /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable biasPosition; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable filterBBox; /**

A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.

For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable filterCategories; /**

An optional parameter that limits the search results by returning only suggestions within the provided list of countries.

  • Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

*/ @property (nonatomic, strong) NSArray * _Nullable filterCountries; /**

The name of the place index resource you want to use for the search.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The optional API key to authorize the request.

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for Athens, Gr to get suggestions with the language parameter set to en. The results found will most likely be returned as Athens, Greece.

If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα, Ελλάδα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

*/ @property (nonatomic, strong) NSString * _Nullable language; /**

An optional parameter. The maximum number of results returned per request.

The default: 5

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

The free-form partial text to use to generate place suggestions. For example, eiffel tow.

*/ @property (nonatomic, strong) NSString * _Nullable text; @end /** */ @interface AWSLocationSearchPlaceIndexForSuggestionsResponse : AWSModel /**

A list of place suggestions that best match the search text.

*/ @property (nonatomic, strong) NSArray * _Nullable results; /**

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.

*/ @property (nonatomic, strong) AWSLocationSearchPlaceIndexForSuggestionsSummary * _Nullable summary; @end /**

A summary of the request sent by using SearchPlaceIndexForSuggestions.

Required parameters: [DataSource, Text] */ @interface AWSLocationSearchPlaceIndexForSuggestionsSummary : AWSModel /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable biasPosition; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable dataSource; /**

Contains the coordinates for the optional bounding box specified in the request.

*/ @property (nonatomic, strong) NSArray * _Nullable filterBBox; /**

The optional category filter specified in the request.

*/ @property (nonatomic, strong) NSArray * _Nullable filterCategories; /**

Contains the optional country filter specified in the request.

*/ @property (nonatomic, strong) NSArray * _Nullable filterCountries; /**

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

*/ @property (nonatomic, strong) NSString * _Nullable language; /**

Contains the optional result count limit specified in the request.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

The free-form partial text input specified in the request.

*/ @property (nonatomic, strong) NSString * _Nullable text; @end /** */ @interface AWSLocationSearchPlaceIndexForTextRequest : AWSRequest /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable biasPosition; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable filterBBox; /**

A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.

For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable filterCategories; /**

An optional parameter that limits the search results by returning only places that are in a specified list of countries.

  • Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.

*/ @property (nonatomic, strong) NSArray * _Nullable filterCountries; /**

The name of the place index resource you want to use for the search.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The optional API key to authorize the request.

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

*/ @property (nonatomic, strong) NSString * _Nullable language; /**

An optional parameter. The maximum number of results returned per request.

The default: 50

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street.

*/ @property (nonatomic, strong) NSString * _Nullable text; @end /** */ @interface AWSLocationSearchPlaceIndexForTextResponse : AWSModel /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable results; /**

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.

*/ @property (nonatomic, strong) AWSLocationSearchPlaceIndexForTextSummary * _Nullable summary; @end /**

A summary of the request sent by using SearchPlaceIndexForText.

Required parameters: [DataSource, Text] */ @interface AWSLocationSearchPlaceIndexForTextSummary : AWSModel /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable biasPosition; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable dataSource; /**

Contains the coordinates for the optional bounding box specified in the request.

*/ @property (nonatomic, strong) NSArray * _Nullable filterBBox; /**

The optional category filter specified in the request.

*/ @property (nonatomic, strong) NSArray * _Nullable filterCategories; /**

Contains the optional country filter specified in the request.

*/ @property (nonatomic, strong) NSArray * _Nullable filterCountries; /**

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

*/ @property (nonatomic, strong) NSString * _Nullable language; /**

Contains the optional result count limit specified in the request.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

The bounding box that fully contains all search results.

If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

 */ @property (nonatomic, strong) NSArray * _Nullable resultBBox; /**

The search text specified in the request.

*/ @property (nonatomic, strong) NSString * _Nullable text; @end /**

Represents an element of a leg within a route. A step contains instructions for how to move to the next step in the leg.

Required parameters: [Distance, DurationSeconds, EndPosition, StartPosition] */ @interface AWSLocationStep : AWSModel /**

The travel distance between the step's StartPosition and EndPosition.

*/ @property (nonatomic, strong) NSNumber * _Nullable distance; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable durationSeconds; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable endPosition; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable geometryOffset; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable startPosition; @end /** */ @interface AWSLocationTagResourceRequest : AWSRequest /**

The Amazon Resource Name (ARN) of the resource whose tags you want to update.

  • Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; /**

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.

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; @end /** */ @interface AWSLocationTagResourceResponse : AWSModel @end /**

Information about a time zone. Includes the name of the time zone and the offset from UTC in seconds.

Required parameters: [Name] */ @interface AWSLocationTimeZone : AWSModel /**

The name of the time zone, following the IANA time zone standard. For example, America/Los_Angeles.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

The time zone's offset, in seconds, from UTC.

*/ @property (nonatomic, strong) NSNumber * _Nullable offset; @end /**

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.

*/ @interface AWSLocationTruckDimensions : AWSModel /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable height; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable length; /**

Specifies the unit of measurement for the truck dimensions.

Default Value: Meters

*/ @property (nonatomic, assign) AWSLocationDimensionUnit unit; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable width; @end /**

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.

*/ @interface AWSLocationTruckWeight : AWSModel /**

The total weight of the truck.

  • For example, 3500.

*/ @property (nonatomic, strong) NSNumber * _Nullable total; /**

The unit of measurement to use for the truck weight.

Default Value: Kilograms

*/ @property (nonatomic, assign) AWSLocationVehicleWeightUnit unit; @end /** */ @interface AWSLocationUntagResourceRequest : AWSRequest /**

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

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; /**

The list of tag keys to remove from the specified resource.

*/ @property (nonatomic, strong) NSArray * _Nullable tagKeys; @end /** */ @interface AWSLocationUntagResourceResponse : AWSModel @end /** */ @interface AWSLocationUpdateGeofenceCollectionRequest : AWSRequest /**

The name of the geofence collection to update.

*/ @property (nonatomic, strong) NSString * _Nullable collectionName; /**

Updates the description for the geofence collection.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

No longer used. If included, the only allowed value is RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; /**

This parameter is no longer used.

*/ @property (nonatomic, strong) NSString * _Nullable pricingPlanDataSource; @end /** */ @interface AWSLocationUpdateGeofenceCollectionResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable collectionArn; /**

The name of the updated geofence collection.

*/ @property (nonatomic, strong) NSString * _Nullable collectionName; /**

The time when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /** */ @interface AWSLocationUpdateKeyRequest : AWSRequest /**

Updates the description for the API key resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable expireTime; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable forceUpdate; /**

The name of the API key resource to update.

*/ @property (nonatomic, strong) NSString * _Nullable keyName; /**

Whether the API key should expire. Set to true to set the API key to have no expiration time.

*/ @property (nonatomic, strong) NSNumber * _Nullable noExpiry; /**

Updates the API key restrictions for the API key resource.

*/ @property (nonatomic, strong) AWSLocationApiKeyRestrictions * _Nullable restrictions; @end /** */ @interface AWSLocationUpdateKeyResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable keyArn; /**

The name of the API key resource.

*/ @property (nonatomic, strong) NSString * _Nullable keyName; /**

The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /** */ @interface AWSLocationUpdateMapRequest : AWSRequest /**

Updates the parts of the map configuration that can be updated, including the political view.

*/ @property (nonatomic, strong) AWSLocationMapConfigurationUpdate * _Nullable configurationUpdate; /**

Updates the description for the map resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

The name of the map resource to update.

*/ @property (nonatomic, strong) NSString * _Nullable mapName; /**

No longer used. If included, the only allowed value is RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; @end /** */ @interface AWSLocationUpdateMapResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable mapArn; /**

The name of the updated map resource.

*/ @property (nonatomic, strong) NSString * _Nullable mapName; /**

The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /** */ @interface AWSLocationUpdatePlaceIndexRequest : AWSRequest /**

Updates the data storage option for the place index resource.

*/ @property (nonatomic, strong) AWSLocationDataSourceConfiguration * _Nullable dataSourceConfiguration; /**

Updates the description for the place index resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

The name of the place index resource to update.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

No longer used. If included, the only allowed value is RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; @end /** */ @interface AWSLocationUpdatePlaceIndexResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable indexArn; /**

The name of the updated place index resource.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /** */ @interface AWSLocationUpdateRouteCalculatorRequest : AWSRequest /**

The name of the route calculator resource to update.

*/ @property (nonatomic, strong) NSString * _Nullable calculatorName; /**

Updates the description for the route calculator resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

No longer used. If included, the only allowed value is RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; @end /** */ @interface AWSLocationUpdateRouteCalculatorResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable calculatorArn; /**

The name of the updated route calculator resource.

*/ @property (nonatomic, strong) NSString * _Nullable calculatorName; /**

The timestamp for when the route calculator was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /** */ @interface AWSLocationUpdateTrackerRequest : AWSRequest /**

Updates the description for the tracker resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

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.

 */ @property (nonatomic, strong) NSNumber * _Nullable eventBridgeEnabled; /**

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.

*/ @property (nonatomic, assign) AWSLocationPositionFiltering positionFiltering; /**

No longer used. If included, the only allowed value is RequestBasedUsage.

*/ @property (nonatomic, assign) AWSLocationPricingPlan pricingPlan; /**

This parameter is no longer used.

*/ @property (nonatomic, strong) NSString * _Nullable pricingPlanDataSource; /**

The name of the tracker resource to update.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; @end /** */ @interface AWSLocationUpdateTrackerResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable trackerArn; /**

The name of the updated tracker resource.

*/ @property (nonatomic, strong) NSString * _Nullable trackerName; /**

The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

*/ @property (nonatomic, strong) NSDate * _Nullable updateTime; @end /**

The input failed to meet the constraints specified by the AWS service in a specified field.

Required parameters: [Message, Name] */ @interface AWSLocationValidationExceptionField : AWSModel /**

A message with the reason for the validation exception error.

*/ @property (nonatomic, strong) NSString * _Nullable message; /**

The field name where the invalid entry was detected.

*/ @property (nonatomic, strong) NSString * _Nullable name; @end NS_ASSUME_NONNULL_END