AWSLocation

Objective-C

@interface AWSLocation

Swift

class AWSLocation

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

  • The service configuration used to instantiate this service client.

    Warning

    Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

  • Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
   AWSServiceManager.default().defaultServiceConfiguration = configuration

   return true

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                          credentialsProvider:credentialsProvider];
     [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;

     return YES;
 }

    Then call the following to get the default service client:

    Swift

    let Location = AWSLocation.default()

    Objective-C

    AWSLocation *Location = [AWSLocation defaultLocation];

    Declaration

    Objective-C

    + (nonnull instancetype)defaultLocation;

    Swift

    class func `default`() -> Self

    Return Value

    The default service client.

  • Creates a service client with the given service configuration and registers it for the key.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
   AWSLocation.register(with: configuration!, forKey: "USWest2Location")

   return true

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                    identityPoolId:@"YourIdentityPoolId"];
    AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                         credentialsProvider:credentialsProvider];

    [AWSLocation registerLocationWithConfiguration:configuration forKey:@"USWest2Location"];

    return YES;
}

    Then call the following to get the service client:

    Swift

    let Location = AWSLocation(forKey: "USWest2Location")

    Objective-C

    AWSLocation *Location = [AWSLocation LocationForKey:@"USWest2Location"];

    Warning

    After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    + (void)registerLocationWithConfiguration:(id)configuration
                                   forKey:(nonnull NSString *)key;

    Swift

    class func register(withConfiguration configuration: Any!, forKey key: String)

    Parameters

    configuration

    A service configuration object.
    key

    A string to identify the service client.

  • Retrieves the service client associated with the key. You need to call + registerLocationWithConfiguration:forKey: before invoking this method.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
   AWSLocation.register(with: configuration!, forKey: "USWest2Location")

   return true

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                    identityPoolId:@"YourIdentityPoolId"];
    AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                         credentialsProvider:credentialsProvider];

    [AWSLocation registerLocationWithConfiguration:configuration forKey:@"USWest2Location"];

    return YES;
}

    Then call the following to get the service client:

    Swift

    let Location = AWSLocation(forKey: "USWest2Location")

    Objective-C

    AWSLocation *Location = [AWSLocation LocationForKey:@"USWest2Location"];

    Declaration

    Objective-C

    + (nonnull instancetype)LocationForKey:(nonnull NSString *)key;

    Swift

    convenience init(forKey key: String)

    Parameters

    key

    A string to identify the service client.

    Return Value

    An instance of the service client.

  • Removes the service client associated with the key and release it.

    Warning

    Before calling this method, make sure no method is running on this client.

    Declaration

    Objective-C

    + (void)removeLocationForKey:(nonnull NSString *)key;

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

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

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

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

    See

    AWSLocationAssociateTrackerConsumerRequest

    See

    AWSLocationAssociateTrackerConsumerResponse

    Declaration

    Objective-C

    - (id)associateTrackerConsumer:
    (nonnull AWSLocationAssociateTrackerConsumerRequest *)request;

    Swift

    func associateTrackerConsumer(_ request: AWSLocationAssociateTrackerConsumerRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the AssociateTrackerConsumer service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationAssociateTrackerConsumerResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorConflict, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorServiceQuotaExceeded, AWSLocationErrorThrottling.

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

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

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

    See

    AWSLocationAssociateTrackerConsumerRequest

    See

    AWSLocationAssociateTrackerConsumerResponse

    Declaration

    Objective-C

    - (void)associateTrackerConsumer:
            (nonnull AWSLocationAssociateTrackerConsumerRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSLocationAssociateTrackerConsumerResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func associateTrackerConsumer(_ request: AWSLocationAssociateTrackerConsumerRequest) async throws -> AWSLocationAssociateTrackerConsumerResponse

    Parameters

    request

    A container for the necessary parameters to execute the AssociateTrackerConsumer service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorConflict, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorServiceQuotaExceeded, AWSLocationErrorThrottling.

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

    See

    AWSLocationBatchDeleteDevicePositionHistoryRequest

    See

    AWSLocationBatchDeleteDevicePositionHistoryResponse

    Declaration

    Objective-C

    - (id)batchDeleteDevicePositionHistory:
    (nonnull AWSLocationBatchDeleteDevicePositionHistoryRequest *)request;

    Swift

    func batchDeleteDevicePositionHistory(_ request: AWSLocationBatchDeleteDevicePositionHistoryRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the BatchDeleteDevicePositionHistory service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationBatchDeleteDevicePositionHistoryResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationBatchDeleteDevicePositionHistoryRequest

    See

    AWSLocationBatchDeleteDevicePositionHistoryResponse

    Declaration

    Objective-C

    - (void)
    batchDeleteDevicePositionHistory:
        (nonnull AWSLocationBatchDeleteDevicePositionHistoryRequest *)request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSLocationBatchDeleteDevicePositionHistoryResponse
                               *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func batchDeleteDevicePositionHistory(_ request: AWSLocationBatchDeleteDevicePositionHistoryRequest) async throws -> AWSLocationBatchDeleteDevicePositionHistoryResponse

    Parameters

    request

    A container for the necessary parameters to execute the BatchDeleteDevicePositionHistory service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Deletes a batch of geofences from a geofence collection.

    This operation deletes the resource permanently.

    See

    AWSLocationBatchDeleteGeofenceRequest

    See

    AWSLocationBatchDeleteGeofenceResponse

    Declaration

    Objective-C

    - (id)batchDeleteGeofence:
    (nonnull AWSLocationBatchDeleteGeofenceRequest *)request;

    Swift

    func batchDeleteGeofence(_ request: AWSLocationBatchDeleteGeofenceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the BatchDeleteGeofence service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationBatchDeleteGeofenceResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Deletes a batch of geofences from a geofence collection.

    This operation deletes the resource permanently.

    See

    AWSLocationBatchDeleteGeofenceRequest

    See

    AWSLocationBatchDeleteGeofenceResponse

    Declaration

    Objective-C

    - (void)
    batchDeleteGeofence:(nonnull AWSLocationBatchDeleteGeofenceRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSLocationBatchDeleteGeofenceResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func batchDeleteGeofence(_ request: AWSLocationBatchDeleteGeofenceRequest) async throws -> AWSLocationBatchDeleteGeofenceResponse

    Parameters

    request

    A container for the necessary parameters to execute the BatchDeleteGeofence service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

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

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

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

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

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

    See

    AWSLocationBatchEvaluateGeofencesRequest

    See

    AWSLocationBatchEvaluateGeofencesResponse

    Declaration

    Objective-C

    - (id)batchEvaluateGeofences:
    (nonnull AWSLocationBatchEvaluateGeofencesRequest *)request;

    Swift

    func batchEvaluateGeofences(_ request: AWSLocationBatchEvaluateGeofencesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the BatchEvaluateGeofences service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationBatchEvaluateGeofencesResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

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

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

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

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

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

    See

    AWSLocationBatchEvaluateGeofencesRequest

    See

    AWSLocationBatchEvaluateGeofencesResponse

    Declaration

    Objective-C

    - (void)batchEvaluateGeofences:
            (nonnull AWSLocationBatchEvaluateGeofencesRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSLocationBatchEvaluateGeofencesResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func batchEvaluateGeofences(_ request: AWSLocationBatchEvaluateGeofencesRequest) async throws -> AWSLocationBatchEvaluateGeofencesResponse

    Parameters

    request

    A container for the necessary parameters to execute the BatchEvaluateGeofences service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists the latest device positions for requested devices.

    See

    AWSLocationBatchGetDevicePositionRequest

    See

    AWSLocationBatchGetDevicePositionResponse

    Declaration

    Objective-C

    - (id)batchGetDevicePosition:
    (nonnull AWSLocationBatchGetDevicePositionRequest *)request;

    Swift

    func batchGetDevicePosition(_ request: AWSLocationBatchGetDevicePositionRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the BatchGetDevicePosition service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationBatchGetDevicePositionResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists the latest device positions for requested devices.

    See

    AWSLocationBatchGetDevicePositionRequest

    See

    AWSLocationBatchGetDevicePositionResponse

    Declaration

    Objective-C

    - (void)batchGetDevicePosition:
            (nonnull AWSLocationBatchGetDevicePositionRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSLocationBatchGetDevicePositionResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func batchGetDevicePosition(_ request: AWSLocationBatchGetDevicePositionRequest) async throws -> AWSLocationBatchGetDevicePositionResponse

    Parameters

    request

    A container for the necessary parameters to execute the BatchGetDevicePosition service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationBatchPutGeofenceRequest

    See

    AWSLocationBatchPutGeofenceResponse

    Declaration

    Objective-C

    - (id)batchPutGeofence:(nonnull AWSLocationBatchPutGeofenceRequest *)request;

    Swift

    func batchPutGeofence(_ request: AWSLocationBatchPutGeofenceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the BatchPutGeofence service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationBatchPutGeofenceResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationBatchPutGeofenceRequest

    See

    AWSLocationBatchPutGeofenceResponse

    Declaration

    Objective-C

    - (void)batchPutGeofence:(nonnull AWSLocationBatchPutGeofenceRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSLocationBatchPutGeofenceResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func batchPutGeofence(_ request: AWSLocationBatchPutGeofenceRequest) async throws -> AWSLocationBatchPutGeofenceResponse

    Parameters

    request

    A container for the necessary parameters to execute the BatchPutGeofence service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

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

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

    See

    AWSLocationBatchUpdateDevicePositionRequest

    See

    AWSLocationBatchUpdateDevicePositionResponse

    Declaration

    Objective-C

    - (id)batchUpdateDevicePosition:
    (nonnull AWSLocationBatchUpdateDevicePositionRequest *)request;

    Swift

    func batchUpdateDevicePosition(_ request: AWSLocationBatchUpdateDevicePositionRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the BatchUpdateDevicePosition service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationBatchUpdateDevicePositionResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

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

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

    See

    AWSLocationBatchUpdateDevicePositionRequest

    See

    AWSLocationBatchUpdateDevicePositionResponse

    Declaration

    Objective-C

    - (void)batchUpdateDevicePosition:
            (nonnull AWSLocationBatchUpdateDevicePositionRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSLocationBatchUpdateDevicePositionResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func batchUpdateDevicePosition(_ request: AWSLocationBatchUpdateDevicePositionRequest) async throws -> AWSLocationBatchUpdateDevicePositionResponse

    Parameters

    request

    A container for the necessary parameters to execute the BatchUpdateDevicePosition service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

    Additional options include:

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

      You can’t specify both DepartureTime and DepartNow in a single request. Specifying both parameters returns a validation error.

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

      If you specify walking for the travel mode and your data provider is Esri, the start and destination must be within 40km.

    See

    AWSLocationCalculateRouteRequest

    See

    AWSLocationCalculateRouteResponse

    Declaration

    Objective-C

    - (id)calculateRoute:(nonnull AWSLocationCalculateRouteRequest *)request;

    Swift

    func calculateRoute(_ request: AWSLocationCalculateRouteRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CalculateRoute service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationCalculateRouteResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

    Additional options include:

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

      You can’t specify both DepartureTime and DepartNow in a single request. Specifying both parameters returns a validation error.

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

      If you specify walking for the travel mode and your data provider is Esri, the start and destination must be within 40km.

    See

    AWSLocationCalculateRouteRequest

    See

    AWSLocationCalculateRouteResponse

    Declaration

    Objective-C

    - (void)calculateRoute:(nonnull AWSLocationCalculateRouteRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSLocationCalculateRouteResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func calculateRoute(_ request: AWSLocationCalculateRouteRequest) async throws -> AWSLocationCalculateRouteResponse

    Parameters

    request

    A container for the necessary parameters to execute the CalculateRoute service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

    Requires that you first create a route calculator resource.

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

    Additional options include:

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

      You can’t specify both DepartureTime and DepartNow in a single request. Specifying both parameters returns a validation error.

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

    See

    AWSLocationCalculateRouteMatrixRequest

    See

    AWSLocationCalculateRouteMatrixResponse

    Declaration

    Objective-C

    - (id)calculateRouteMatrix:
    (nonnull AWSLocationCalculateRouteMatrixRequest *)request;

    Swift

    func calculateRouteMatrix(_ request: AWSLocationCalculateRouteMatrixRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CalculateRouteMatrix service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationCalculateRouteMatrixResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

    Requires that you first create a route calculator resource.

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

    Additional options include:

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

      You can’t specify both DepartureTime and DepartNow in a single request. Specifying both parameters returns a validation error.

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

    See

    AWSLocationCalculateRouteMatrixRequest

    See

    AWSLocationCalculateRouteMatrixResponse

    Declaration

    Objective-C

    - (void)calculateRouteMatrix:
            (nonnull AWSLocationCalculateRouteMatrixRequest *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSLocationCalculateRouteMatrixResponse *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func calculateRouteMatrix(_ request: AWSLocationCalculateRouteMatrixRequest) async throws -> AWSLocationCalculateRouteMatrixResponse

    Parameters

    request

    A container for the necessary parameters to execute the CalculateRouteMatrix service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Creates a geofence collection, which manages and stores geofences.

    See

    AWSLocationCreateGeofenceCollectionRequest

    See

    AWSLocationCreateGeofenceCollectionResponse

    Declaration

    Objective-C

    - (id)createGeofenceCollection:
    (nonnull AWSLocationCreateGeofenceCollectionRequest *)request;

    Swift

    func createGeofenceCollection(_ request: AWSLocationCreateGeofenceCollectionRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateGeofenceCollection service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationCreateGeofenceCollectionResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorConflict, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorServiceQuotaExceeded, AWSLocationErrorThrottling.

  • Creates a geofence collection, which manages and stores geofences.

    See

    AWSLocationCreateGeofenceCollectionRequest

    See

    AWSLocationCreateGeofenceCollectionResponse

    Declaration

    Objective-C

    - (void)createGeofenceCollection:
            (nonnull AWSLocationCreateGeofenceCollectionRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSLocationCreateGeofenceCollectionResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func createGeofenceCollection(_ request: AWSLocationCreateGeofenceCollectionRequest) async throws -> AWSLocationCreateGeofenceCollectionResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateGeofenceCollection service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorConflict, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorServiceQuotaExceeded, AWSLocationErrorThrottling.

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

    For more information, see Using API keys.

    See

    AWSLocationCreateKeyRequest

    See

    AWSLocationCreateKeyResponse

    Declaration

    Objective-C

    - (id)createKey:(nonnull AWSLocationCreateKeyRequest *)request;

    Swift

    func createKey(_ request: AWSLocationCreateKeyRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateKey service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationCreateKeyResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorConflict, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorServiceQuotaExceeded, AWSLocationErrorThrottling.

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

    For more information, see Using API keys.

    See

    AWSLocationCreateKeyRequest

    See

    AWSLocationCreateKeyResponse

    Declaration

    Objective-C

    - (void)createKey:(nonnull AWSLocationCreateKeyRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationCreateKeyResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func createKey(_ request: AWSLocationCreateKeyRequest) async throws -> AWSLocationCreateKeyResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateKey service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorConflict, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorServiceQuotaExceeded, AWSLocationErrorThrottling.

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

    If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.

    See

    AWSLocationCreateMapRequest

    See

    AWSLocationCreateMapResponse

    Declaration

    Objective-C

    - (id)createMap:(nonnull AWSLocationCreateMapRequest *)request;

    Swift

    func createMap(_ request: AWSLocationCreateMapRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateMap service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationCreateMapResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorConflict, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorServiceQuotaExceeded, AWSLocationErrorThrottling.

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

    If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.

    See

    AWSLocationCreateMapRequest

    See

    AWSLocationCreateMapResponse

    Declaration

    Objective-C

    - (void)createMap:(nonnull AWSLocationCreateMapRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationCreateMapResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func createMap(_ request: AWSLocationCreateMapRequest) async throws -> AWSLocationCreateMapResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateMap service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorConflict, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorServiceQuotaExceeded, AWSLocationErrorThrottling.

  • Creates a place index resource in your Amazon Web Services account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.

    If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.

    See

    AWSLocationCreatePlaceIndexRequest

    See

    AWSLocationCreatePlaceIndexResponse

    Declaration

    Objective-C

    - (id)createPlaceIndex:(nonnull AWSLocationCreatePlaceIndexRequest *)request;

    Swift

    func createPlaceIndex(_ request: AWSLocationCreatePlaceIndexRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreatePlaceIndex service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationCreatePlaceIndexResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorConflict, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorServiceQuotaExceeded, AWSLocationErrorThrottling.

  • Creates a place index resource in your Amazon Web Services account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.

    If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.

    See

    AWSLocationCreatePlaceIndexRequest

    See

    AWSLocationCreatePlaceIndexResponse

    Declaration

    Objective-C

    - (void)createPlaceIndex:(nonnull AWSLocationCreatePlaceIndexRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSLocationCreatePlaceIndexResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func createPlaceIndex(_ request: AWSLocationCreatePlaceIndexRequest) async throws -> AWSLocationCreatePlaceIndexResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreatePlaceIndex service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorConflict, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorServiceQuotaExceeded, AWSLocationErrorThrottling.

  • Creates a route calculator resource in your Amazon Web Services account.

    You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.

    If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.

    See

    AWSLocationCreateRouteCalculatorRequest

    See

    AWSLocationCreateRouteCalculatorResponse

    Declaration

    Objective-C

    - (id)createRouteCalculator:
    (nonnull AWSLocationCreateRouteCalculatorRequest *)request;

    Swift

    func createRouteCalculator(_ request: AWSLocationCreateRouteCalculatorRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateRouteCalculator service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationCreateRouteCalculatorResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorConflict, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorServiceQuotaExceeded, AWSLocationErrorThrottling.

  • Creates a route calculator resource in your Amazon Web Services account.

    You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.

    If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.

    See

    AWSLocationCreateRouteCalculatorRequest

    See

    AWSLocationCreateRouteCalculatorResponse

    Declaration

    Objective-C

    - (void)createRouteCalculator:
            (nonnull AWSLocationCreateRouteCalculatorRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSLocationCreateRouteCalculatorResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func createRouteCalculator(_ request: AWSLocationCreateRouteCalculatorRequest) async throws -> AWSLocationCreateRouteCalculatorResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateRouteCalculator service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorConflict, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorServiceQuotaExceeded, AWSLocationErrorThrottling.

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

    See

    AWSLocationCreateTrackerRequest

    See

    AWSLocationCreateTrackerResponse

    Declaration

    Objective-C

    - (id)createTracker:(nonnull AWSLocationCreateTrackerRequest *)request;

    Swift

    func createTracker(_ request: AWSLocationCreateTrackerRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateTracker service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationCreateTrackerResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorConflict, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorServiceQuotaExceeded, AWSLocationErrorThrottling.

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

    See

    AWSLocationCreateTrackerRequest

    See

    AWSLocationCreateTrackerResponse

    Declaration

    Objective-C

    - (void)createTracker:(nonnull AWSLocationCreateTrackerRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationCreateTrackerResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func createTracker(_ request: AWSLocationCreateTrackerRequest) async throws -> AWSLocationCreateTrackerResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateTracker service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorConflict, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorServiceQuotaExceeded, AWSLocationErrorThrottling.

  • Deletes a geofence collection from your Amazon Web Services account.

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

    See

    AWSLocationDeleteGeofenceCollectionRequest

    See

    AWSLocationDeleteGeofenceCollectionResponse

    Declaration

    Objective-C

    - (id)deleteGeofenceCollection:
    (nonnull AWSLocationDeleteGeofenceCollectionRequest *)request;

    Swift

    func deleteGeofenceCollection(_ request: AWSLocationDeleteGeofenceCollectionRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteGeofenceCollection service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationDeleteGeofenceCollectionResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Deletes a geofence collection from your Amazon Web Services account.

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

    See

    AWSLocationDeleteGeofenceCollectionRequest

    See

    AWSLocationDeleteGeofenceCollectionResponse

    Declaration

    Objective-C

    - (void)deleteGeofenceCollection:
            (nonnull AWSLocationDeleteGeofenceCollectionRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSLocationDeleteGeofenceCollectionResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func deleteGeofenceCollection(_ request: AWSLocationDeleteGeofenceCollectionRequest) async throws -> AWSLocationDeleteGeofenceCollectionResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteGeofenceCollection service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationDeleteKeyRequest

    See

    AWSLocationDeleteKeyResponse

    Declaration

    Objective-C

    - (id)deleteKey:(nonnull AWSLocationDeleteKeyRequest *)request;

    Swift

    func deleteKey(_ request: AWSLocationDeleteKeyRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteKey service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationDeleteKeyResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationDeleteKeyRequest

    See

    AWSLocationDeleteKeyResponse

    Declaration

    Objective-C

    - (void)deleteKey:(nonnull AWSLocationDeleteKeyRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationDeleteKeyResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func deleteKey(_ request: AWSLocationDeleteKeyRequest) async throws -> AWSLocationDeleteKeyResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteKey service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Deletes a map resource from your Amazon Web Services account.

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

    See

    AWSLocationDeleteMapRequest

    See

    AWSLocationDeleteMapResponse

    Declaration

    Objective-C

    - (id)deleteMap:(nonnull AWSLocationDeleteMapRequest *)request;

    Swift

    func deleteMap(_ request: AWSLocationDeleteMapRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteMap service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationDeleteMapResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Deletes a map resource from your Amazon Web Services account.

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

    See

    AWSLocationDeleteMapRequest

    See

    AWSLocationDeleteMapResponse

    Declaration

    Objective-C

    - (void)deleteMap:(nonnull AWSLocationDeleteMapRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationDeleteMapResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func deleteMap(_ request: AWSLocationDeleteMapRequest) async throws -> AWSLocationDeleteMapResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteMap service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    This operation deletes the resource permanently.

    See

    AWSLocationDeletePlaceIndexRequest

    See

    AWSLocationDeletePlaceIndexResponse

    Declaration

    Objective-C

    - (id)deletePlaceIndex:(nonnull AWSLocationDeletePlaceIndexRequest *)request;

    Swift

    func deletePlaceIndex(_ request: AWSLocationDeletePlaceIndexRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeletePlaceIndex service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationDeletePlaceIndexResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    This operation deletes the resource permanently.

    See

    AWSLocationDeletePlaceIndexRequest

    See

    AWSLocationDeletePlaceIndexResponse

    Declaration

    Objective-C

    - (void)deletePlaceIndex:(nonnull AWSLocationDeletePlaceIndexRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSLocationDeletePlaceIndexResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func deletePlaceIndex(_ request: AWSLocationDeletePlaceIndexRequest) async throws -> AWSLocationDeletePlaceIndexResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeletePlaceIndex service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    This operation deletes the resource permanently.

    See

    AWSLocationDeleteRouteCalculatorRequest

    See

    AWSLocationDeleteRouteCalculatorResponse

    Declaration

    Objective-C

    - (id)deleteRouteCalculator:
    (nonnull AWSLocationDeleteRouteCalculatorRequest *)request;

    Swift

    func deleteRouteCalculator(_ request: AWSLocationDeleteRouteCalculatorRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteRouteCalculator service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationDeleteRouteCalculatorResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    This operation deletes the resource permanently.

    See

    AWSLocationDeleteRouteCalculatorRequest

    See

    AWSLocationDeleteRouteCalculatorResponse

    Declaration

    Objective-C

    - (void)deleteRouteCalculator:
            (nonnull AWSLocationDeleteRouteCalculatorRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSLocationDeleteRouteCalculatorResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func deleteRouteCalculator(_ request: AWSLocationDeleteRouteCalculatorRequest) async throws -> AWSLocationDeleteRouteCalculatorResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteRouteCalculator service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Deletes a tracker resource from your Amazon Web Services account.

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

    See

    AWSLocationDeleteTrackerRequest

    See

    AWSLocationDeleteTrackerResponse

    Declaration

    Objective-C

    - (id)deleteTracker:(nonnull AWSLocationDeleteTrackerRequest *)request;

    Swift

    func deleteTracker(_ request: AWSLocationDeleteTrackerRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteTracker service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationDeleteTrackerResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Deletes a tracker resource from your Amazon Web Services account.

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

    See

    AWSLocationDeleteTrackerRequest

    See

    AWSLocationDeleteTrackerResponse

    Declaration

    Objective-C

    - (void)deleteTracker:(nonnull AWSLocationDeleteTrackerRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationDeleteTrackerResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func deleteTracker(_ request: AWSLocationDeleteTrackerRequest) async throws -> AWSLocationDeleteTrackerResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteTracker service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves the geofence collection details.

    See

    AWSLocationDescribeGeofenceCollectionRequest

    See

    AWSLocationDescribeGeofenceCollectionResponse

    Declaration

    Objective-C

    - (id)describeGeofenceCollection:
    (nonnull AWSLocationDescribeGeofenceCollectionRequest *)request;

    Swift

    func describeGeofenceCollection(_ request: AWSLocationDescribeGeofenceCollectionRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeGeofenceCollection service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationDescribeGeofenceCollectionResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves the geofence collection details.

    See

    AWSLocationDescribeGeofenceCollectionRequest

    See

    AWSLocationDescribeGeofenceCollectionResponse

    Declaration

    Objective-C

    - (void)
    describeGeofenceCollection:
        (nonnull AWSLocationDescribeGeofenceCollectionRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSLocationDescribeGeofenceCollectionResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func describeGeofenceCollection(_ request: AWSLocationDescribeGeofenceCollectionRequest) async throws -> AWSLocationDescribeGeofenceCollectionResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeGeofenceCollection service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves the API key resource details.

    See

    AWSLocationDescribeKeyRequest

    See

    AWSLocationDescribeKeyResponse

    Declaration

    Objective-C

    - (id)describeKey:(nonnull AWSLocationDescribeKeyRequest *)request;

    Swift

    func describeKey(_ request: AWSLocationDescribeKeyRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeKey service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationDescribeKeyResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves the API key resource details.

    See

    AWSLocationDescribeKeyRequest

    See

    AWSLocationDescribeKeyResponse

    Declaration

    Objective-C

    - (void)describeKey:(nonnull AWSLocationDescribeKeyRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationDescribeKeyResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func describeKey(_ request: AWSLocationDescribeKeyRequest) async throws -> AWSLocationDescribeKeyResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeKey service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves the map resource details.

    See

    AWSLocationDescribeMapRequest

    See

    AWSLocationDescribeMapResponse

    Declaration

    Objective-C

    - (id)describeMap:(nonnull AWSLocationDescribeMapRequest *)request;

    Swift

    func describeMap(_ request: AWSLocationDescribeMapRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeMap service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationDescribeMapResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves the map resource details.

    See

    AWSLocationDescribeMapRequest

    See

    AWSLocationDescribeMapResponse

    Declaration

    Objective-C

    - (void)describeMap:(nonnull AWSLocationDescribeMapRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationDescribeMapResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func describeMap(_ request: AWSLocationDescribeMapRequest) async throws -> AWSLocationDescribeMapResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeMap service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves the place index resource details.

    See

    AWSLocationDescribePlaceIndexRequest

    See

    AWSLocationDescribePlaceIndexResponse

    Declaration

    Objective-C

    - (id)describePlaceIndex:
    (nonnull AWSLocationDescribePlaceIndexRequest *)request;

    Swift

    func describePlaceIndex(_ request: AWSLocationDescribePlaceIndexRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribePlaceIndex service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationDescribePlaceIndexResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves the place index resource details.

    See

    AWSLocationDescribePlaceIndexRequest

    See

    AWSLocationDescribePlaceIndexResponse

    Declaration

    Objective-C

    - (void)
    describePlaceIndex:(nonnull AWSLocationDescribePlaceIndexRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSLocationDescribePlaceIndexResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func describePlaceIndex(_ request: AWSLocationDescribePlaceIndexRequest) async throws -> AWSLocationDescribePlaceIndexResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribePlaceIndex service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves the route calculator resource details.

    See

    AWSLocationDescribeRouteCalculatorRequest

    See

    AWSLocationDescribeRouteCalculatorResponse

    Declaration

    Objective-C

    - (id)describeRouteCalculator:
    (nonnull AWSLocationDescribeRouteCalculatorRequest *)request;

    Swift

    func describeRouteCalculator(_ request: AWSLocationDescribeRouteCalculatorRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeRouteCalculator service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationDescribeRouteCalculatorResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves the route calculator resource details.

    See

    AWSLocationDescribeRouteCalculatorRequest

    See

    AWSLocationDescribeRouteCalculatorResponse

    Declaration

    Objective-C

    - (void)describeRouteCalculator:
            (nonnull AWSLocationDescribeRouteCalculatorRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSLocationDescribeRouteCalculatorResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func describeRouteCalculator(_ request: AWSLocationDescribeRouteCalculatorRequest) async throws -> AWSLocationDescribeRouteCalculatorResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeRouteCalculator service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves the tracker resource details.

    See

    AWSLocationDescribeTrackerRequest

    See

    AWSLocationDescribeTrackerResponse

    Declaration

    Objective-C

    - (id)describeTracker:(nonnull AWSLocationDescribeTrackerRequest *)request;

    Swift

    func describeTracker(_ request: AWSLocationDescribeTrackerRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeTracker service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationDescribeTrackerResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves the tracker resource details.

    See

    AWSLocationDescribeTrackerRequest

    See

    AWSLocationDescribeTrackerResponse

    Declaration

    Objective-C

    - (void)describeTracker:(nonnull AWSLocationDescribeTrackerRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSLocationDescribeTrackerResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func describeTracker(_ request: AWSLocationDescribeTrackerRequest) async throws -> AWSLocationDescribeTrackerResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeTracker service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

    See

    AWSLocationDisassociateTrackerConsumerRequest

    See

    AWSLocationDisassociateTrackerConsumerResponse

    Declaration

    Objective-C

    - (id)disassociateTrackerConsumer:
    (nonnull AWSLocationDisassociateTrackerConsumerRequest *)request;

    Swift

    func disassociateTrackerConsumer(_ request: AWSLocationDisassociateTrackerConsumerRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DisassociateTrackerConsumer service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationDisassociateTrackerConsumerResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

    See

    AWSLocationDisassociateTrackerConsumerRequest

    See

    AWSLocationDisassociateTrackerConsumerResponse

    Declaration

    Objective-C

    - (void)
    disassociateTrackerConsumer:
        (nonnull AWSLocationDisassociateTrackerConsumerRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSLocationDisassociateTrackerConsumerResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func disassociateTrackerConsumer(_ request: AWSLocationDisassociateTrackerConsumerRequest) async throws -> AWSLocationDisassociateTrackerConsumerResponse

    Parameters

    request

    A container for the necessary parameters to execute the DisassociateTrackerConsumer service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

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

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

    See

    AWSLocationForecastGeofenceEventsRequest

    See

    AWSLocationForecastGeofenceEventsResponse

    Declaration

    Objective-C

    - (id)forecastGeofenceEvents:
    (nonnull AWSLocationForecastGeofenceEventsRequest *)request;

    Swift

    func forecastGeofenceEvents(_ request: AWSLocationForecastGeofenceEventsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ForecastGeofenceEvents service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationForecastGeofenceEventsResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

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

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

    See

    AWSLocationForecastGeofenceEventsRequest

    See

    AWSLocationForecastGeofenceEventsResponse

    Declaration

    Objective-C

    - (void)forecastGeofenceEvents:
            (nonnull AWSLocationForecastGeofenceEventsRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSLocationForecastGeofenceEventsResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func forecastGeofenceEvents(_ request: AWSLocationForecastGeofenceEventsRequest) async throws -> AWSLocationForecastGeofenceEventsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ForecastGeofenceEvents service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    Device positions are deleted after 30 days.

    See

    AWSLocationGetDevicePositionRequest

    See

    AWSLocationGetDevicePositionResponse

    Declaration

    Objective-C

    - (id)getDevicePosition:(nonnull AWSLocationGetDevicePositionRequest *)request;

    Swift

    func getDevicePosition(_ request: AWSLocationGetDevicePositionRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetDevicePosition service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationGetDevicePositionResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    Device positions are deleted after 30 days.

    See

    AWSLocationGetDevicePositionRequest

    See

    AWSLocationGetDevicePositionResponse

    Declaration

    Objective-C

    - (void)getDevicePosition:(nonnull AWSLocationGetDevicePositionRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSLocationGetDevicePositionResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func devicePosition(_ request: AWSLocationGetDevicePositionRequest) async throws -> AWSLocationGetDevicePositionResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetDevicePosition service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    Device positions are deleted after 30 days.

    See

    AWSLocationGetDevicePositionHistoryRequest

    See

    AWSLocationGetDevicePositionHistoryResponse

    Declaration

    Objective-C

    - (id)getDevicePositionHistory:
    (nonnull AWSLocationGetDevicePositionHistoryRequest *)request;

    Swift

    func getDevicePositionHistory(_ request: AWSLocationGetDevicePositionHistoryRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetDevicePositionHistory service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationGetDevicePositionHistoryResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    Device positions are deleted after 30 days.

    See

    AWSLocationGetDevicePositionHistoryRequest

    See

    AWSLocationGetDevicePositionHistoryResponse

    Declaration

    Objective-C

    - (void)getDevicePositionHistory:
            (nonnull AWSLocationGetDevicePositionHistoryRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSLocationGetDevicePositionHistoryResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func devicePositionHistory(_ request: AWSLocationGetDevicePositionHistoryRequest) async throws -> AWSLocationGetDevicePositionHistoryResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetDevicePositionHistory service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves the geofence details from a geofence collection.

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

    See

    AWSLocationGetGeofenceRequest

    See

    AWSLocationGetGeofenceResponse

    Declaration

    Objective-C

    - (id)getGeofence:(nonnull AWSLocationGetGeofenceRequest *)request;

    Swift

    func getGeofence(_ request: AWSLocationGetGeofenceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetGeofence service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationGetGeofenceResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves the geofence details from a geofence collection.

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

    See

    AWSLocationGetGeofenceRequest

    See

    AWSLocationGetGeofenceResponse

    Declaration

    Objective-C

    - (void)getGeofence:(nonnull AWSLocationGetGeofenceRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationGetGeofenceResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func geofence(_ request: AWSLocationGetGeofenceRequest) async throws -> AWSLocationGetGeofenceResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetGeofence service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves glyphs used to display labels on a map.

    See

    AWSLocationGetMapGlyphsRequest

    See

    AWSLocationGetMapGlyphsResponse

    Declaration

    Objective-C

    - (id)getMapGlyphs:(nonnull AWSLocationGetMapGlyphsRequest *)request;

    Swift

    func getMapGlyphs(_ request: AWSLocationGetMapGlyphsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetMapGlyphs service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationGetMapGlyphsResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves glyphs used to display labels on a map.

    See

    AWSLocationGetMapGlyphsRequest

    See

    AWSLocationGetMapGlyphsResponse

    Declaration

    Objective-C

    - (void)getMapGlyphs:(nonnull AWSLocationGetMapGlyphsRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationGetMapGlyphsResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func mapGlyphs(_ request: AWSLocationGetMapGlyphsRequest) async throws -> AWSLocationGetMapGlyphsResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetMapGlyphs service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationGetMapSpritesRequest

    See

    AWSLocationGetMapSpritesResponse

    Declaration

    Objective-C

    - (id)getMapSprites:(nonnull AWSLocationGetMapSpritesRequest *)request;

    Swift

    func getMapSprites(_ request: AWSLocationGetMapSpritesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetMapSprites service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationGetMapSpritesResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationGetMapSpritesRequest

    See

    AWSLocationGetMapSpritesResponse

    Declaration

    Objective-C

    - (void)getMapSprites:(nonnull AWSLocationGetMapSpritesRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationGetMapSpritesResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func mapSprites(_ request: AWSLocationGetMapSpritesRequest) async throws -> AWSLocationGetMapSpritesResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetMapSprites service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves the map style descriptor from a map resource.

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

    See

    AWSLocationGetMapStyleDescriptorRequest

    See

    AWSLocationGetMapStyleDescriptorResponse

    Declaration

    Objective-C

    - (id)getMapStyleDescriptor:
    (nonnull AWSLocationGetMapStyleDescriptorRequest *)request;

    Swift

    func getMapStyleDescriptor(_ request: AWSLocationGetMapStyleDescriptorRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetMapStyleDescriptor service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationGetMapStyleDescriptorResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Retrieves the map style descriptor from a map resource.

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

    See

    AWSLocationGetMapStyleDescriptorRequest

    See

    AWSLocationGetMapStyleDescriptorResponse

    Declaration

    Objective-C

    - (void)getMapStyleDescriptor:
            (nonnull AWSLocationGetMapStyleDescriptorRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSLocationGetMapStyleDescriptorResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func mapStyleDescriptor(_ request: AWSLocationGetMapStyleDescriptorRequest) async throws -> AWSLocationGetMapStyleDescriptorResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetMapStyleDescriptor service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

    See

    AWSLocationGetMapTileRequest

    See

    AWSLocationGetMapTileResponse

    Declaration

    Objective-C

    - (id)getMapTile:(nonnull AWSLocationGetMapTileRequest *)request;

    Swift

    func getMapTile(_ request: AWSLocationGetMapTileRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetMapTile service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationGetMapTileResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

    See

    AWSLocationGetMapTileRequest

    See

    AWSLocationGetMapTileResponse

    Declaration

    Objective-C

    - (void)getMapTile:(nonnull AWSLocationGetMapTileRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationGetMapTileResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func mapTile(_ request: AWSLocationGetMapTileRequest) async throws -> AWSLocationGetMapTileResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetMapTile service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

    • Customer Amazon Web Services account

    • Amazon Web Services Region

    • Data provider specified in the place index resource

    See

    AWSLocationGetPlaceRequest

    See

    AWSLocationGetPlaceResponse

    Declaration

    Objective-C

    - (id)getPlace:(nonnull AWSLocationGetPlaceRequest *)request;

    Swift

    func getPlace(_ request: AWSLocationGetPlaceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetPlace service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationGetPlaceResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

    • Customer Amazon Web Services account

    • Amazon Web Services Region

    • Data provider specified in the place index resource

    See

    AWSLocationGetPlaceRequest

    See

    AWSLocationGetPlaceResponse

    Declaration

    Objective-C

    - (void)getPlace:(nonnull AWSLocationGetPlaceRequest *)request
    completionHandler:(void (^_Nullable)(AWSLocationGetPlaceResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func place(_ request: AWSLocationGetPlaceRequest) async throws -> AWSLocationGetPlaceResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetPlace service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • A batch request to retrieve all device positions.

    See

    AWSLocationListDevicePositionsRequest

    See

    AWSLocationListDevicePositionsResponse

    Declaration

    Objective-C

    - (id)listDevicePositions:
    (nonnull AWSLocationListDevicePositionsRequest *)request;

    Swift

    func listDevicePositions(_ request: AWSLocationListDevicePositionsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListDevicePositions service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationListDevicePositionsResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • A batch request to retrieve all device positions.

    See

    AWSLocationListDevicePositionsRequest

    See

    AWSLocationListDevicePositionsResponse

    Declaration

    Objective-C

    - (void)
    listDevicePositions:(nonnull AWSLocationListDevicePositionsRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSLocationListDevicePositionsResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func listDevicePositions(_ request: AWSLocationListDevicePositionsRequest) async throws -> AWSLocationListDevicePositionsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListDevicePositions service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists geofence collections in your Amazon Web Services account.

    See

    AWSLocationListGeofenceCollectionsRequest

    See

    AWSLocationListGeofenceCollectionsResponse

    Declaration

    Objective-C

    - (id)listGeofenceCollections:
    (nonnull AWSLocationListGeofenceCollectionsRequest *)request;

    Swift

    func listGeofenceCollections(_ request: AWSLocationListGeofenceCollectionsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListGeofenceCollections service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationListGeofenceCollectionsResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists geofence collections in your Amazon Web Services account.

    See

    AWSLocationListGeofenceCollectionsRequest

    See

    AWSLocationListGeofenceCollectionsResponse

    Declaration

    Objective-C

    - (void)listGeofenceCollections:
            (nonnull AWSLocationListGeofenceCollectionsRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSLocationListGeofenceCollectionsResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func listGeofenceCollections(_ request: AWSLocationListGeofenceCollectionsRequest) async throws -> AWSLocationListGeofenceCollectionsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListGeofenceCollections service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists geofences stored in a given geofence collection.

    See

    AWSLocationListGeofencesRequest

    See

    AWSLocationListGeofencesResponse

    Declaration

    Objective-C

    - (id)listGeofences:(nonnull AWSLocationListGeofencesRequest *)request;

    Swift

    func listGeofences(_ request: AWSLocationListGeofencesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListGeofences service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationListGeofencesResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists geofences stored in a given geofence collection.

    See

    AWSLocationListGeofencesRequest

    See

    AWSLocationListGeofencesResponse

    Declaration

    Objective-C

    - (void)listGeofences:(nonnull AWSLocationListGeofencesRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationListGeofencesResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func listGeofences(_ request: AWSLocationListGeofencesRequest) async throws -> AWSLocationListGeofencesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListGeofences service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists API key resources in your Amazon Web Services account.

    See

    AWSLocationListKeysRequest

    See

    AWSLocationListKeysResponse

    Declaration

    Objective-C

    - (id)listKeys:(nonnull AWSLocationListKeysRequest *)request;

    Swift

    func listKeys(_ request: AWSLocationListKeysRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListKeys service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationListKeysResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists API key resources in your Amazon Web Services account.

    See

    AWSLocationListKeysRequest

    See

    AWSLocationListKeysResponse

    Declaration

    Objective-C

    - (void)listKeys:(nonnull AWSLocationListKeysRequest *)request
    completionHandler:(void (^_Nullable)(AWSLocationListKeysResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func listKeys(_ request: AWSLocationListKeysRequest) async throws -> AWSLocationListKeysResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListKeys service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists map resources in your Amazon Web Services account.

    See

    AWSLocationListMapsRequest

    See

    AWSLocationListMapsResponse

    Declaration

    Objective-C

    - (id)listMaps:(nonnull AWSLocationListMapsRequest *)request;

    Swift

    func listMaps(_ request: AWSLocationListMapsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListMaps service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationListMapsResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists map resources in your Amazon Web Services account.

    See

    AWSLocationListMapsRequest

    See

    AWSLocationListMapsResponse

    Declaration

    Objective-C

    - (void)listMaps:(nonnull AWSLocationListMapsRequest *)request
    completionHandler:(void (^_Nullable)(AWSLocationListMapsResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func listMaps(_ request: AWSLocationListMapsRequest) async throws -> AWSLocationListMapsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListMaps service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists place index resources in your Amazon Web Services account.

    See

    AWSLocationListPlaceIndexesRequest

    See

    AWSLocationListPlaceIndexesResponse

    Declaration

    Objective-C

    - (id)listPlaceIndexes:(nonnull AWSLocationListPlaceIndexesRequest *)request;

    Swift

    func listPlaceIndexes(_ request: AWSLocationListPlaceIndexesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListPlaceIndexes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationListPlaceIndexesResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists place index resources in your Amazon Web Services account.

    See

    AWSLocationListPlaceIndexesRequest

    See

    AWSLocationListPlaceIndexesResponse

    Declaration

    Objective-C

    - (void)listPlaceIndexes:(nonnull AWSLocationListPlaceIndexesRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSLocationListPlaceIndexesResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func listPlaceIndexes(_ request: AWSLocationListPlaceIndexesRequest) async throws -> AWSLocationListPlaceIndexesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListPlaceIndexes service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists route calculator resources in your Amazon Web Services account.

    See

    AWSLocationListRouteCalculatorsRequest

    See

    AWSLocationListRouteCalculatorsResponse

    Declaration

    Objective-C

    - (id)listRouteCalculators:
    (nonnull AWSLocationListRouteCalculatorsRequest *)request;

    Swift

    func listRouteCalculators(_ request: AWSLocationListRouteCalculatorsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListRouteCalculators service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationListRouteCalculatorsResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists route calculator resources in your Amazon Web Services account.

    See

    AWSLocationListRouteCalculatorsRequest

    See

    AWSLocationListRouteCalculatorsResponse

    Declaration

    Objective-C

    - (void)listRouteCalculators:
            (nonnull AWSLocationListRouteCalculatorsRequest *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSLocationListRouteCalculatorsResponse *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func listRouteCalculators(_ request: AWSLocationListRouteCalculatorsRequest) async throws -> AWSLocationListRouteCalculatorsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListRouteCalculators service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationListTagsForResourceRequest

    See

    AWSLocationListTagsForResourceResponse

    Declaration

    Objective-C

    - (id)listTagsForResource:
    (nonnull AWSLocationListTagsForResourceRequest *)request;

    Swift

    func listTags(forResource request: AWSLocationListTagsForResourceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListTagsForResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationListTagsForResourceResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationListTagsForResourceRequest

    See

    AWSLocationListTagsForResourceResponse

    Declaration

    Objective-C

    - (void)
    listTagsForResource:(nonnull AWSLocationListTagsForResourceRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSLocationListTagsForResourceResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func listTags(forResource request: AWSLocationListTagsForResourceRequest) async throws -> AWSLocationListTagsForResourceResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListTagsForResource service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists geofence collections currently associated to the given tracker resource.

    See

    AWSLocationListTrackerConsumersRequest

    See

    AWSLocationListTrackerConsumersResponse

    Declaration

    Objective-C

    - (id)listTrackerConsumers:
    (nonnull AWSLocationListTrackerConsumersRequest *)request;

    Swift

    func listTrackerConsumers(_ request: AWSLocationListTrackerConsumersRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListTrackerConsumers service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationListTrackerConsumersResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists geofence collections currently associated to the given tracker resource.

    See

    AWSLocationListTrackerConsumersRequest

    See

    AWSLocationListTrackerConsumersResponse

    Declaration

    Objective-C

    - (void)listTrackerConsumers:
            (nonnull AWSLocationListTrackerConsumersRequest *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSLocationListTrackerConsumersResponse *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func listTrackerConsumers(_ request: AWSLocationListTrackerConsumersRequest) async throws -> AWSLocationListTrackerConsumersResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListTrackerConsumers service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists tracker resources in your Amazon Web Services account.

    See

    AWSLocationListTrackersRequest

    See

    AWSLocationListTrackersResponse

    Declaration

    Objective-C

    - (id)listTrackers:(nonnull AWSLocationListTrackersRequest *)request;

    Swift

    func listTrackers(_ request: AWSLocationListTrackersRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListTrackers service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationListTrackersResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Lists tracker resources in your Amazon Web Services account.

    See

    AWSLocationListTrackersRequest

    See

    AWSLocationListTrackersResponse

    Declaration

    Objective-C

    - (void)listTrackers:(nonnull AWSLocationListTrackersRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationListTrackersResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func listTrackers(_ request: AWSLocationListTrackersRequest) async throws -> AWSLocationListTrackersResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListTrackers service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationPutGeofenceRequest

    See

    AWSLocationPutGeofenceResponse

    Declaration

    Objective-C

    - (id)putGeofence:(nonnull AWSLocationPutGeofenceRequest *)request;

    Swift

    func putGeofence(_ request: AWSLocationPutGeofenceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the PutGeofence service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationPutGeofenceResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorConflict, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationPutGeofenceRequest

    See

    AWSLocationPutGeofenceResponse

    Declaration

    Objective-C

    - (void)putGeofence:(nonnull AWSLocationPutGeofenceRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationPutGeofenceResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func putGeofence(_ request: AWSLocationPutGeofenceRequest) async throws -> AWSLocationPutGeofenceResponse

    Parameters

    request

    A container for the necessary parameters to execute the PutGeofence service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorConflict, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationSearchPlaceIndexForPositionRequest

    See

    AWSLocationSearchPlaceIndexForPositionResponse

    Declaration

    Objective-C

    - (id)searchPlaceIndexForPosition:
    (nonnull AWSLocationSearchPlaceIndexForPositionRequest *)request;

    Swift

    func searchPlaceIndex(forPosition request: AWSLocationSearchPlaceIndexForPositionRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the SearchPlaceIndexForPosition service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationSearchPlaceIndexForPositionResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationSearchPlaceIndexForPositionRequest

    See

    AWSLocationSearchPlaceIndexForPositionResponse

    Declaration

    Objective-C

    - (void)
    searchPlaceIndexForPosition:
        (nonnull AWSLocationSearchPlaceIndexForPositionRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSLocationSearchPlaceIndexForPositionResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func searchPlaceIndex(forPosition request: AWSLocationSearchPlaceIndexForPositionRequest) async throws -> AWSLocationSearchPlaceIndexForPositionResponse

    Parameters

    request

    A container for the necessary parameters to execute the SearchPlaceIndexForPosition service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

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

    See

    AWSLocationSearchPlaceIndexForSuggestionsRequest

    See

    AWSLocationSearchPlaceIndexForSuggestionsResponse

    Declaration

    Objective-C

    - (id)searchPlaceIndexForSuggestions:
    (nonnull AWSLocationSearchPlaceIndexForSuggestionsRequest *)request;

    Swift

    func searchPlaceIndex(forSuggestions request: AWSLocationSearchPlaceIndexForSuggestionsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the SearchPlaceIndexForSuggestions service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationSearchPlaceIndexForSuggestionsResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

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

    See

    AWSLocationSearchPlaceIndexForSuggestionsRequest

    See

    AWSLocationSearchPlaceIndexForSuggestionsResponse

    Declaration

    Objective-C

    - (void)searchPlaceIndexForSuggestions:
            (nonnull AWSLocationSearchPlaceIndexForSuggestionsRequest *)request
                     completionHandler:
                         (void (^_Nullable)(
                             AWSLocationSearchPlaceIndexForSuggestionsResponse
                                 *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func searchPlaceIndex(forSuggestions request: AWSLocationSearchPlaceIndexForSuggestionsRequest) async throws -> AWSLocationSearchPlaceIndexForSuggestionsResponse

    Parameters

    request

    A container for the necessary parameters to execute the SearchPlaceIndexForSuggestions service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

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

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

    See

    AWSLocationSearchPlaceIndexForTextRequest

    See

    AWSLocationSearchPlaceIndexForTextResponse

    Declaration

    Objective-C

    - (id)searchPlaceIndexForText:
    (nonnull AWSLocationSearchPlaceIndexForTextRequest *)request;

    Swift

    func searchPlaceIndex(forText request: AWSLocationSearchPlaceIndexForTextRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the SearchPlaceIndexForText service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationSearchPlaceIndexForTextResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

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

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

    See

    AWSLocationSearchPlaceIndexForTextRequest

    See

    AWSLocationSearchPlaceIndexForTextResponse

    Declaration

    Objective-C

    - (void)searchPlaceIndexForText:
            (nonnull AWSLocationSearchPlaceIndexForTextRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSLocationSearchPlaceIndexForTextResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func searchPlaceIndex(forText request: AWSLocationSearchPlaceIndexForTextRequest) async throws -> AWSLocationSearchPlaceIndexForTextResponse

    Parameters

    request

    A container for the necessary parameters to execute the SearchPlaceIndexForText service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

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

    You can associate up to 50 tags with a resource.

    See

    AWSLocationTagResourceRequest

    See

    AWSLocationTagResourceResponse

    Declaration

    Objective-C

    - (id)tagResource:(nonnull AWSLocationTagResourceRequest *)request;

    Swift

    func tagResource(_ request: AWSLocationTagResourceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the TagResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationTagResourceResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

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

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

    You can associate up to 50 tags with a resource.

    See

    AWSLocationTagResourceRequest

    See

    AWSLocationTagResourceResponse

    Declaration

    Objective-C

    - (void)tagResource:(nonnull AWSLocationTagResourceRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationTagResourceResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func tagResource(_ request: AWSLocationTagResourceRequest) async throws -> AWSLocationTagResourceResponse

    Parameters

    request

    A container for the necessary parameters to execute the TagResource service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationUntagResourceRequest

    See

    AWSLocationUntagResourceResponse

    Declaration

    Objective-C

    - (id)untagResource:(nonnull AWSLocationUntagResourceRequest *)request;

    Swift

    func untagResource(_ request: AWSLocationUntagResourceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UntagResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationUntagResourceResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationUntagResourceRequest

    See

    AWSLocationUntagResourceResponse

    Declaration

    Objective-C

    - (void)untagResource:(nonnull AWSLocationUntagResourceRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationUntagResourceResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func untagResource(_ request: AWSLocationUntagResourceRequest) async throws -> AWSLocationUntagResourceResponse

    Parameters

    request

    A container for the necessary parameters to execute the UntagResource service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Updates the specified properties of a given geofence collection.

    See

    AWSLocationUpdateGeofenceCollectionRequest

    See

    AWSLocationUpdateGeofenceCollectionResponse

    Declaration

    Objective-C

    - (id)updateGeofenceCollection:
    (nonnull AWSLocationUpdateGeofenceCollectionRequest *)request;

    Swift

    func updateGeofenceCollection(_ request: AWSLocationUpdateGeofenceCollectionRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateGeofenceCollection service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationUpdateGeofenceCollectionResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Updates the specified properties of a given geofence collection.

    See

    AWSLocationUpdateGeofenceCollectionRequest

    See

    AWSLocationUpdateGeofenceCollectionResponse

    Declaration

    Objective-C

    - (void)updateGeofenceCollection:
            (nonnull AWSLocationUpdateGeofenceCollectionRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSLocationUpdateGeofenceCollectionResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func updateGeofenceCollection(_ request: AWSLocationUpdateGeofenceCollectionRequest) async throws -> AWSLocationUpdateGeofenceCollectionResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateGeofenceCollection service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Updates the specified properties of a given API key resource.

    See

    AWSLocationUpdateKeyRequest

    See

    AWSLocationUpdateKeyResponse

    Declaration

    Objective-C

    - (id)updateKey:(nonnull AWSLocationUpdateKeyRequest *)request;

    Swift

    func updateKey(_ request: AWSLocationUpdateKeyRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateKey service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationUpdateKeyResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Updates the specified properties of a given API key resource.

    See

    AWSLocationUpdateKeyRequest

    See

    AWSLocationUpdateKeyResponse

    Declaration

    Objective-C

    - (void)updateKey:(nonnull AWSLocationUpdateKeyRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationUpdateKeyResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func updateKey(_ request: AWSLocationUpdateKeyRequest) async throws -> AWSLocationUpdateKeyResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateKey service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Updates the specified properties of a given map resource.

    See

    AWSLocationUpdateMapRequest

    See

    AWSLocationUpdateMapResponse

    Declaration

    Objective-C

    - (id)updateMap:(nonnull AWSLocationUpdateMapRequest *)request;

    Swift

    func updateMap(_ request: AWSLocationUpdateMapRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateMap service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationUpdateMapResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Updates the specified properties of a given map resource.

    See

    AWSLocationUpdateMapRequest

    See

    AWSLocationUpdateMapResponse

    Declaration

    Objective-C

    - (void)updateMap:(nonnull AWSLocationUpdateMapRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationUpdateMapResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func updateMap(_ request: AWSLocationUpdateMapRequest) async throws -> AWSLocationUpdateMapResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateMap service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Updates the specified properties of a given place index resource.

    See

    AWSLocationUpdatePlaceIndexRequest

    See

    AWSLocationUpdatePlaceIndexResponse

    Declaration

    Objective-C

    - (id)updatePlaceIndex:(nonnull AWSLocationUpdatePlaceIndexRequest *)request;

    Swift

    func updatePlaceIndex(_ request: AWSLocationUpdatePlaceIndexRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdatePlaceIndex service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationUpdatePlaceIndexResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Updates the specified properties of a given place index resource.

    See

    AWSLocationUpdatePlaceIndexRequest

    See

    AWSLocationUpdatePlaceIndexResponse

    Declaration

    Objective-C

    - (void)updatePlaceIndex:(nonnull AWSLocationUpdatePlaceIndexRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSLocationUpdatePlaceIndexResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func updatePlaceIndex(_ request: AWSLocationUpdatePlaceIndexRequest) async throws -> AWSLocationUpdatePlaceIndexResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdatePlaceIndex service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Updates the specified properties for a given route calculator resource.

    See

    AWSLocationUpdateRouteCalculatorRequest

    See

    AWSLocationUpdateRouteCalculatorResponse

    Declaration

    Objective-C

    - (id)updateRouteCalculator:
    (nonnull AWSLocationUpdateRouteCalculatorRequest *)request;

    Swift

    func updateRouteCalculator(_ request: AWSLocationUpdateRouteCalculatorRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateRouteCalculator service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationUpdateRouteCalculatorResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Updates the specified properties for a given route calculator resource.

    See

    AWSLocationUpdateRouteCalculatorRequest

    See

    AWSLocationUpdateRouteCalculatorResponse

    Declaration

    Objective-C

    - (void)updateRouteCalculator:
            (nonnull AWSLocationUpdateRouteCalculatorRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSLocationUpdateRouteCalculatorResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func updateRouteCalculator(_ request: AWSLocationUpdateRouteCalculatorRequest) async throws -> AWSLocationUpdateRouteCalculatorResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateRouteCalculator service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Updates the specified properties of a given tracker resource.

    See

    AWSLocationUpdateTrackerRequest

    See

    AWSLocationUpdateTrackerResponse

    Declaration

    Objective-C

    - (id)updateTracker:(nonnull AWSLocationUpdateTrackerRequest *)request;

    Swift

    func updateTracker(_ request: AWSLocationUpdateTrackerRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateTracker service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationUpdateTrackerResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

  • Updates the specified properties of a given tracker resource.

    See

    AWSLocationUpdateTrackerRequest

    See

    AWSLocationUpdateTrackerResponse

    Declaration

    Objective-C

    - (void)updateTracker:(nonnull AWSLocationUpdateTrackerRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSLocationUpdateTrackerResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func updateTracker(_ request: AWSLocationUpdateTrackerRequest) async throws -> AWSLocationUpdateTrackerResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateTracker service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationVerifyDevicePositionRequest

    See

    AWSLocationVerifyDevicePositionResponse

    Declaration

    Objective-C

    - (id)verifyDevicePosition:
    (nonnull AWSLocationVerifyDevicePositionRequest *)request;

    Swift

    func verifyDevicePosition(_ request: AWSLocationVerifyDevicePositionRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the VerifyDevicePosition service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSLocationVerifyDevicePositionResponse. On failed execution, task.error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.

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

    See

    AWSLocationVerifyDevicePositionRequest

    See

    AWSLocationVerifyDevicePositionResponse

    Declaration

    Objective-C

    - (void)verifyDevicePosition:
            (nonnull AWSLocationVerifyDevicePositionRequest *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSLocationVerifyDevicePositionResponse *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func verifyDevicePosition(_ request: AWSLocationVerifyDevicePositionRequest) async throws -> AWSLocationVerifyDevicePositionResponse

    Parameters

    request

    A container for the necessary parameters to execute the VerifyDevicePosition service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSLocationErrorDomain domain and the following error code: AWSLocationErrorInternalServer, AWSLocationErrorResourceNotFound, AWSLocationErrorAccessDenied, AWSLocationErrorValidation, AWSLocationErrorThrottling.