LocationServiceClient
extends AwsClient
in package
This client is used to interact with the Amazon Location Service service.
Supported API Versions
This class uses a service description model that is associated at
runtime based on the version
option given when constructing the
client. The version
option will determine which API operations,
waiters, and paginators are available for a client. Creating a command or a
specific API operation can be done using magic methods (e.g.,
$client->commandName(/** parameters */)
, or using the
$client->getCommand
method of the client.
- AssociateTrackerConsumer
- BatchDeleteDevicePositionHistory
- BatchDeleteGeofence
- BatchEvaluateGeofences
- BatchGetDevicePosition
- BatchPutGeofence
- BatchUpdateDevicePosition
- CalculateRoute
- CalculateRouteMatrix
- CreateGeofenceCollection
- CreateKey
- CreateMap
- CreatePlaceIndex
- CreateRouteCalculator
- CreateTracker
- DeleteGeofenceCollection
- DeleteKey
- DeleteMap
- DeletePlaceIndex
- DeleteRouteCalculator
- DeleteTracker
- DescribeGeofenceCollection
- DescribeKey
- DescribeMap
- DescribePlaceIndex
- DescribeRouteCalculator
- DescribeTracker
- DisassociateTrackerConsumer
- GetDevicePosition
- GetDevicePositionHistory
- GetGeofence
- GetMapGlyphs
- GetMapSprites
- GetMapStyleDescriptor
- GetMapTile
- GetPlace
- ListDevicePositions
- ListGeofenceCollections
- ListGeofences
- ListKeys
- ListMaps
- ListPlaceIndexes
- ListRouteCalculators
- ListTagsForResource
- ListTrackerConsumers
- ListTrackers
- PutGeofence
- SearchPlaceIndexForPosition
- SearchPlaceIndexForSuggestions
- SearchPlaceIndexForText
- TagResource
- UntagResource
- UpdateGeofenceCollection
- UpdateKey
- UpdateMap
- UpdatePlaceIndex
- UpdateRouteCalculator
- UpdateTracker
Table of Contents
Methods
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- associateTrackerConsumer() : Result
- associateTrackerConsumerAsync() : Promise
- batchDeleteDevicePositionHistory() : Result
- batchDeleteDevicePositionHistoryAsync() : Promise
- batchDeleteGeofence() : Result
- batchDeleteGeofenceAsync() : Promise
- batchEvaluateGeofences() : Result
- batchEvaluateGeofencesAsync() : Promise
- batchGetDevicePosition() : Result
- batchGetDevicePositionAsync() : Promise
- batchPutGeofence() : Result
- batchPutGeofenceAsync() : Promise
- batchUpdateDevicePosition() : Result
- batchUpdateDevicePositionAsync() : Promise
- calculateRoute() : Result
- calculateRouteAsync() : Promise
- calculateRouteMatrix() : Result
- calculateRouteMatrixAsync() : Promise
- createGeofenceCollection() : Result
- createGeofenceCollectionAsync() : Promise
- createKey() : Result
- createKeyAsync() : Promise
- createMap() : Result
- createMapAsync() : Promise
- createPlaceIndex() : Result
- createPlaceIndexAsync() : Promise
- createRouteCalculator() : Result
- createRouteCalculatorAsync() : Promise
- createTracker() : Result
- createTrackerAsync() : Promise
- deleteGeofenceCollection() : Result
- deleteGeofenceCollectionAsync() : Promise
- deleteKey() : Result
- deleteKeyAsync() : Promise
- deleteMap() : Result
- deleteMapAsync() : Promise
- deletePlaceIndex() : Result
- deletePlaceIndexAsync() : Promise
- deleteRouteCalculator() : Result
- deleteRouteCalculatorAsync() : Promise
- deleteTracker() : Result
- deleteTrackerAsync() : Promise
- describeGeofenceCollection() : Result
- describeGeofenceCollectionAsync() : Promise
- describeKey() : Result
- describeKeyAsync() : Promise
- describeMap() : Result
- describeMapAsync() : Promise
- describePlaceIndex() : Result
- describePlaceIndexAsync() : Promise
- describeRouteCalculator() : Result
- describeRouteCalculatorAsync() : Promise
- describeTracker() : Result
- describeTrackerAsync() : Promise
- disassociateTrackerConsumer() : Result
- disassociateTrackerConsumerAsync() : Promise
- emitDeprecationWarning() : mixed
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- getApi() : Service
- getArguments() : array<string|int, mixed>
- Get an array of client constructor arguments used by the client.
- getClientBuiltIns() : array<string|int, mixed>
- Provides the set of built-in keys and values used for endpoint resolution
- getClientContextParams() : array<string|int, mixed>
- Provides the set of service context parameter key-value pairs used for endpoint resolution.
- getCommand() : CommandInterface
- getConfig() : mixed|null
- Get a client configuration value.
- getCredentials() : PromiseInterface
- Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
- getDevicePosition() : Result
- getDevicePositionAsync() : Promise
- getDevicePositionHistory() : Result
- getDevicePositionHistoryAsync() : Promise
- getEndpoint() : UriInterface
- Gets the default endpoint, or base URL, used by the client.
- getEndpointProvider() : mixed
- getEndpointProviderArgs() : array<string|int, mixed>
- Retrieves arguments to be used in endpoint resolution.
- getGeofence() : Result
- getGeofenceAsync() : Promise
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getIterator() : mixed
- getMapGlyphs() : Result
- getMapGlyphsAsync() : Promise
- getMapSprites() : Result
- getMapSpritesAsync() : Promise
- getMapStyleDescriptor() : Result
- getMapStyleDescriptorAsync() : Promise
- getMapTile() : Result
- getMapTileAsync() : Promise
- getPaginator() : mixed
- getPlace() : Result
- getPlaceAsync() : Promise
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getWaiter() : mixed
- listDevicePositions() : Result
- listDevicePositionsAsync() : Promise
- listGeofenceCollections() : Result
- listGeofenceCollectionsAsync() : Promise
- listGeofences() : Result
- listGeofencesAsync() : Promise
- listKeys() : Result
- listKeysAsync() : Promise
- listMaps() : Result
- listMapsAsync() : Promise
- listPlaceIndexes() : Result
- listPlaceIndexesAsync() : Promise
- listRouteCalculators() : Result
- listRouteCalculatorsAsync() : Promise
- listTagsForResource() : Result
- listTagsForResourceAsync() : Promise
- listTrackerConsumers() : Result
- listTrackerConsumersAsync() : Promise
- listTrackers() : Result
- listTrackersAsync() : Promise
- putGeofence() : Result
- putGeofenceAsync() : Promise
- searchPlaceIndexForPosition() : Result
- searchPlaceIndexForPositionAsync() : Promise
- searchPlaceIndexForSuggestions() : Result
- searchPlaceIndexForSuggestionsAsync() : Promise
- searchPlaceIndexForText() : Result
- searchPlaceIndexForTextAsync() : Promise
- tagResource() : Result
- tagResourceAsync() : Promise
- untagResource() : Result
- untagResourceAsync() : Promise
- updateGeofenceCollection() : Result
- updateGeofenceCollectionAsync() : Promise
- updateKey() : Result
- updateKeyAsync() : Promise
- updateMap() : Result
- updateMapAsync() : Promise
- updatePlaceIndex() : Result
- updatePlaceIndexAsync() : Promise
- updateRouteCalculator() : Result
- updateRouteCalculatorAsync() : Promise
- updateTracker() : Result
- updateTrackerAsync() : Promise
- waitUntil() : mixed
Methods
__call()
public
__call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed>
__construct()
The client constructor accepts the following options:
public
__construct(array<string|int, mixed> $args) : mixed
- api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
- credentials:
(Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies
the credentials used to sign requests. Provide an
Aws\Credentials\CredentialsInterface object, an associative array of
"key", "secret", and an optional "token" key,
false
to use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment. - token:
(Aws\Token\TokenInterface|array|bool|callable) Specifies
the token used to authorize requests. Provide an
Aws\Token\TokenInterface object, an associative array of
"token" and an optional "expires" key,
false
to use no token, or a callable token provider used to create a token or return null. See Aws\Token\TokenProvider for a list of built-in token providers. If no token is provided, the SDK will attempt to load one from the environment. - csm:
(Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies
the credentials used to sign requests. Provide an
Aws\ClientSideMonitoring\ConfigurationInterface object, a callable
configuration provider used to create client-side monitoring configuration,
false
to disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project - debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
- stats: (bool|array) Set to true to gather transfer statistics on
requests sent. Alternatively, you can provide an associative array with
the following keys: retries: (bool) Set to false to disable reporting
on retries attempted; http: (bool) Set to true to enable collecting
statistics from lower level HTTP adapters (e.g., values returned in
GuzzleHttp\TransferStats). HTTP handlers must support an
http_stats_receiver
option for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds. - disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
- endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
- endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, false to explicitly disable it, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
- endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
- handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
- http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
- http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
- idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
- profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
- region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
- retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
- scheme: (string, default=string(5) "https") URI scheme to use when
connecting connect. The SDK will utilize "https" endpoints (i.e.,
utilize SSL/TLS connections) by default. You can attempt to connect to
a service over an unencrypted "http" endpoint by setting
scheme
to "http". - signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
- signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
- use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
- validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
- version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
- ua_append: (string, array) To pass custom user agent parameters.
- app_id: (string) an optional application specific identifier that can be set. When set it will be appended to the User-Agent header of every request in the form of App/{AppId}. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. See https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html for more information on environment variables and shared config settings.
Parameters
- $args : array<string|int, mixed>
-
Client configuration arguments.
Tags
__sleep()
public
__sleep() : mixed
associateTrackerConsumer()
public
associateTrackerConsumer(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultassociateTrackerConsumerAsync()
public
associateTrackerConsumerAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisebatchDeleteDevicePositionHistory()
public
batchDeleteDevicePositionHistory(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultbatchDeleteDevicePositionHistoryAsync()
public
batchDeleteDevicePositionHistoryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisebatchDeleteGeofence()
public
batchDeleteGeofence(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultbatchDeleteGeofenceAsync()
public
batchDeleteGeofenceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisebatchEvaluateGeofences()
public
batchEvaluateGeofences(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultbatchEvaluateGeofencesAsync()
public
batchEvaluateGeofencesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisebatchGetDevicePosition()
public
batchGetDevicePosition(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultbatchGetDevicePositionAsync()
public
batchGetDevicePositionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisebatchPutGeofence()
public
batchPutGeofence(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultbatchPutGeofenceAsync()
public
batchPutGeofenceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisebatchUpdateDevicePosition()
public
batchUpdateDevicePosition(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultbatchUpdateDevicePositionAsync()
public
batchUpdateDevicePositionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecalculateRoute()
public
calculateRoute(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcalculateRouteAsync()
public
calculateRouteAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecalculateRouteMatrix()
public
calculateRouteMatrix(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcalculateRouteMatrixAsync()
public
calculateRouteMatrixAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateGeofenceCollection()
public
createGeofenceCollection(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateGeofenceCollectionAsync()
public
createGeofenceCollectionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateKey()
public
createKey(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateKeyAsync()
public
createKeyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateMap()
public
createMap(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateMapAsync()
public
createMapAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreatePlaceIndex()
public
createPlaceIndex(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreatePlaceIndexAsync()
public
createPlaceIndexAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateRouteCalculator()
public
createRouteCalculator(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateRouteCalculatorAsync()
public
createRouteCalculatorAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateTracker()
public
createTracker(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateTrackerAsync()
public
createTrackerAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteGeofenceCollection()
public
deleteGeofenceCollection(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteGeofenceCollectionAsync()
public
deleteGeofenceCollectionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteKey()
public
deleteKey(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteKeyAsync()
public
deleteKeyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteMap()
public
deleteMap(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteMapAsync()
public
deleteMapAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeletePlaceIndex()
public
deletePlaceIndex(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeletePlaceIndexAsync()
public
deletePlaceIndexAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteRouteCalculator()
public
deleteRouteCalculator(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteRouteCalculatorAsync()
public
deleteRouteCalculatorAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteTracker()
public
deleteTracker(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteTrackerAsync()
public
deleteTrackerAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeGeofenceCollection()
public
describeGeofenceCollection(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeGeofenceCollectionAsync()
public
describeGeofenceCollectionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeKey()
public
describeKey(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeKeyAsync()
public
describeKeyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeMap()
public
describeMap(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeMapAsync()
public
describeMapAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribePlaceIndex()
public
describePlaceIndex(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribePlaceIndexAsync()
public
describePlaceIndexAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeRouteCalculator()
public
describeRouteCalculator(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeRouteCalculatorAsync()
public
describeRouteCalculatorAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeTracker()
public
describeTracker(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeTrackerAsync()
public
describeTrackerAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedisassociateTrackerConsumer()
public
disassociateTrackerConsumer(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdisassociateTrackerConsumerAsync()
public
disassociateTrackerConsumerAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseemitDeprecationWarning()
public
static emitDeprecationWarning() : mixed
execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
staticgetApi()
public
abstract getApi() : Service
Return values
ServicegetArguments()
Get an array of client constructor arguments used by the client.
public
static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>getClientBuiltIns()
Provides the set of built-in keys and values used for endpoint resolution
public
getClientBuiltIns() : array<string|int, mixed>
Return values
array<string|int, mixed>getClientContextParams()
Provides the set of service context parameter key-value pairs used for endpoint resolution.
public
getClientContextParams() : array<string|int, mixed>
Return values
array<string|int, mixed>getCommand()
public
abstract getCommand(string $name[, array<string|int, mixed> $args = [] ]) : CommandInterface
Parameters
- $name : string
- $args : array<string|int, mixed> = []
Return values
CommandInterfacegetConfig()
Get a client configuration value.
public
getConfig([mixed $option = null ]) : mixed|null
Parameters
- $option : mixed = null
-
The option to retrieve. Pass null to retrieve all options.
Return values
mixed|nullgetCredentials()
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
public
getCredentials() : PromiseInterface
If you need the credentials synchronously, then call the wait() method on the returned promise.
Return values
PromiseInterfacegetDevicePosition()
public
getDevicePosition(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDevicePositionAsync()
public
getDevicePositionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetDevicePositionHistory()
public
getDevicePositionHistory(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDevicePositionHistoryAsync()
public
getDevicePositionHistoryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterfacegetEndpointProvider()
public
getEndpointProvider() : mixed
getEndpointProviderArgs()
Retrieves arguments to be used in endpoint resolution.
public
getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>getGeofence()
public
getGeofence(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetGeofenceAsync()
public
getGeofenceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetHandlerList()
Get the handler list used to transfer commands.
public
getHandlerList() : HandlerList
This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.
Return values
HandlerListgetIterator()
public
getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getMapGlyphs()
public
getMapGlyphs(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetMapGlyphsAsync()
public
getMapGlyphsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetMapSprites()
public
getMapSprites(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetMapSpritesAsync()
public
getMapSpritesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetMapStyleDescriptor()
public
getMapStyleDescriptor(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetMapStyleDescriptorAsync()
public
getMapStyleDescriptorAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetMapTile()
public
getMapTile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetMapTileAsync()
public
getMapTileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetPaginator()
public
getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getPlace()
public
getPlace(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetPlaceAsync()
public
getPlaceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
Return values
stringgetSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callablegetWaiter()
public
getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
listDevicePositions()
public
listDevicePositions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDevicePositionsAsync()
public
listDevicePositionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistGeofenceCollections()
public
listGeofenceCollections(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistGeofenceCollectionsAsync()
public
listGeofenceCollectionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistGeofences()
public
listGeofences(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistGeofencesAsync()
public
listGeofencesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistKeys()
public
listKeys(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistKeysAsync()
public
listKeysAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistMaps()
public
listMaps(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistMapsAsync()
public
listMapsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistPlaceIndexes()
public
listPlaceIndexes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistPlaceIndexesAsync()
public
listPlaceIndexesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistRouteCalculators()
public
listRouteCalculators(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistRouteCalculatorsAsync()
public
listRouteCalculatorsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTagsForResource()
public
listTagsForResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTagsForResourceAsync()
public
listTagsForResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTrackerConsumers()
public
listTrackerConsumers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTrackerConsumersAsync()
public
listTrackerConsumersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTrackers()
public
listTrackers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTrackersAsync()
public
listTrackersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputGeofence()
public
putGeofence(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputGeofenceAsync()
public
putGeofenceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesearchPlaceIndexForPosition()
public
searchPlaceIndexForPosition(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsearchPlaceIndexForPositionAsync()
public
searchPlaceIndexForPositionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesearchPlaceIndexForSuggestions()
public
searchPlaceIndexForSuggestions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsearchPlaceIndexForSuggestionsAsync()
public
searchPlaceIndexForSuggestionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesearchPlaceIndexForText()
public
searchPlaceIndexForText(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsearchPlaceIndexForTextAsync()
public
searchPlaceIndexForTextAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagResource()
public
tagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagResourceAsync()
public
tagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagResource()
public
untagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagResourceAsync()
public
untagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateGeofenceCollection()
public
updateGeofenceCollection(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateGeofenceCollectionAsync()
public
updateGeofenceCollectionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateKey()
public
updateKey(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateKeyAsync()
public
updateKeyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateMap()
public
updateMap(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateMapAsync()
public
updateMapAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdatePlaceIndex()
public
updatePlaceIndex(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdatePlaceIndexAsync()
public
updatePlaceIndexAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateRouteCalculator()
public
updateRouteCalculator(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateRouteCalculatorAsync()
public
updateRouteCalculatorAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateTracker()
public
updateTracker(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateTrackerAsync()
public
updateTrackerAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisewaitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []