AWS.Tools.LocationService.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.LocationService</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionCmdlet"> <summary> Retrieves a device's most recent position according to its sample time. <note><para> Device positions are deleted after one year. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionCmdlet.DeviceId"> <summary> <para> <para>The device whose position you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionCmdlet.TrackerName"> <summary> <para> <para>The tracker resource receiving the position update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.GetDevicePositionResponse). Specifying the name of a property of type Amazon.LocationService.Model.GetDevicePositionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrackerName parameter. The -PassThru parameter is deprecated, use -Select '^TrackerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionBatchCmdlet"> <summary> A batch request to retrieve all device positions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionBatchCmdlet.DeviceId"> <summary> <para> <para>Devices whose position you want to retrieve.</para><ul><li><para>For example, for two devices: <code>device-ids=DeviceId1&device-ids=DeviceId2</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionBatchCmdlet.TrackerName"> <summary> <para> <para>The tracker resource retrieving the device position.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.BatchGetDevicePositionResponse). Specifying the name of a property of type Amazon.LocationService.Model.BatchGetDevicePositionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrackerName parameter. The -PassThru parameter is deprecated, use -Select '^TrackerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionHistoryCmdlet"> <summary> Retrieves the device position history from a tracker resource within a specified range of time. <note><para> Device positions are deleted after 1 year. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionHistoryCmdlet.DeviceId"> <summary> <para> <para>The device whose position history you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionHistoryCmdlet.EndTimeExclusive"> <summary> <para> <para>Specify the end time for the position history in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. By default, the value will be the time that the request is made.</para><para>Requirement:</para><ul><li><para>The time specified for <code>EndTimeExclusive</code> must be after the time for <code>StartTimeInclusive</code>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionHistoryCmdlet.StartTimeInclusive"> <summary> <para> <para>Specify the start time for the position history in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. By default, the value will be 24 hours prior to the time that the request is made.</para><para>Requirement:</para><ul><li><para>The time specified for <code>StartTimeInclusive</code> must be before <code>EndTimeExclusive</code>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionHistoryCmdlet.TrackerName"> <summary> <para> <para>The tracker resource receiving the request for the device position history.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionHistoryCmdlet.NextToken"> <summary> <para> <para>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. </para><para>Default value: <code>null</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionHistoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.GetDevicePositionHistoryResponse). Specifying the name of a property of type Amazon.LocationService.Model.GetDevicePositionHistoryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCDevicePositionHistoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrackerName parameter. The -PassThru parameter is deprecated, use -Select '^TrackerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceCmdlet"> <summary> Retrieves the geofence details from a geofence collection. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceCmdlet.CollectionName"> <summary> <para> <para>The geofence collection storing the target geofence.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceCmdlet.GeofenceId"> <summary> <para> <para>The geofence you're retrieving details for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Geometry.Polygon'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.GetGeofenceResponse). Specifying the name of a property of type Amazon.LocationService.Model.GetGeofenceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionName parameter. The -PassThru parameter is deprecated, use -Select '^CollectionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceCollectionCmdlet"> <summary> Retrieves the geofence collection details. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceCollectionCmdlet.CollectionName"> <summary> <para> <para>The name of the geofence collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceCollectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.DescribeGeofenceCollectionResponse). Specifying the name of a property of type Amazon.LocationService.Model.DescribeGeofenceCollectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceCollectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionName parameter. The -PassThru parameter is deprecated, use -Select '^CollectionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceCollectionListCmdlet"> <summary> Lists geofence collections in your AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceCollectionListCmdlet.MaxResult"> <summary> <para> <para>An optional limit for the number of resources returned in a single call. </para><para>Default value: <code>100</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceCollectionListCmdlet.NextToken"> <summary> <para> <para>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. </para><para>Default value: <code>null</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceCollectionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Entries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.ListGeofenceCollectionsResponse). Specifying the name of a property of type Amazon.LocationService.Model.ListGeofenceCollectionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceListCmdlet"> <summary> Lists geofences stored in a given geofence collection. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceListCmdlet.CollectionName"> <summary> <para> <para>The name of the geofence collection storing the list of geofences.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceListCmdlet.NextToken"> <summary> <para> <para>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. </para><para>Default value: <code>null</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Entries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.ListGeofencesResponse). Specifying the name of a property of type Amazon.LocationService.Model.ListGeofencesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCGeofenceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionName parameter. The -PassThru parameter is deprecated, use -Select '^CollectionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapCmdlet"> <summary> Retrieves the map resource details. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapCmdlet.MapName"> <summary> <para> <para>The name of the map resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.DescribeMapResponse). Specifying the name of a property of type Amazon.LocationService.Model.DescribeMapResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MapName parameter. The -PassThru parameter is deprecated, use -Select '^MapName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapGlyphCmdlet"> <summary> Retrieves glyphs used to display labels on a map. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapGlyphCmdlet.FontStack"> <summary> <para> <para>A comma-separated list of fonts to load glyphs from in order of preference.. For example, <code>Noto Sans, Arial Unicode</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapGlyphCmdlet.FontUnicodeRange"> <summary> <para> <para>A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example, 0-255 includes all characters from range <code>U+0000</code> to <code>00FF</code>. Must be aligned to multiples of 256.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapGlyphCmdlet.MapName"> <summary> <para> <para>The map resource associated with the glyph file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapGlyphCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.GetMapGlyphsResponse). Specifying the name of a property of type Amazon.LocationService.Model.GetMapGlyphsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapGlyphCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MapName parameter. The -PassThru parameter is deprecated, use -Select '^MapName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapListCmdlet"> <summary> Lists map resources in your AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapListCmdlet.MaxResult"> <summary> <para> <para>An optional limit for the number of resources returned in a single call. </para><para>Default value: <code>100</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapListCmdlet.NextToken"> <summary> <para> <para>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.</para><para>Default value: <code>null</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Entries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.ListMapsResponse). Specifying the name of a property of type Amazon.LocationService.Model.ListMapsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapSpriteCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapSpriteCmdlet.FileName"> <summary> <para> <para>The name of the sprite file. Use the following file names for the sprite sheet:</para><ul><li><para><code>sprites.png</code></para></li><li><para><code>sprites@2x.png</code> for high pixel density displays</para></li></ul><para>For the JSON document contain image offsets. Use the following file names:</para><ul><li><para><code>sprites.json</code></para></li><li><para><code>sprites@2x.json</code> for high pixel density displays</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapSpriteCmdlet.MapName"> <summary> <para> <para>The map resource associated with the sprite file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapSpriteCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.GetMapSpritesResponse). Specifying the name of a property of type Amazon.LocationService.Model.GetMapSpritesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapSpriteCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MapName parameter. The -PassThru parameter is deprecated, use -Select '^MapName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapStyleDescriptorCmdlet"> <summary> Retrieves the map style descriptor from a map resource. <para> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapStyleDescriptorCmdlet.MapName"> <summary> <para> <para>The map resource to retrieve the style descriptor from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapStyleDescriptorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.GetMapStyleDescriptorResponse). Specifying the name of a property of type Amazon.LocationService.Model.GetMapStyleDescriptorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapStyleDescriptorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MapName parameter. The -PassThru parameter is deprecated, use -Select '^MapName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapTileCmdlet"> <summary> Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. They are addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level. <para> 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). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapTileCmdlet.MapName"> <summary> <para> <para>The map resource to retrieve the map tiles from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapTileCmdlet.X"> <summary> <para> <para>The X axis value for the map tile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapTileCmdlet.Y"> <summary> <para> <para>The Y axis value for the map tile. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapTileCmdlet.Z"> <summary> <para> <para>The zoom value for the map tile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapTileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.GetMapTileResponse). Specifying the name of a property of type Amazon.LocationService.Model.GetMapTileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCMapTileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MapName parameter. The -PassThru parameter is deprecated, use -Select '^MapName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCPlaceIndexCmdlet"> <summary> Retrieves the Place index resource details. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCPlaceIndexCmdlet.IndexName"> <summary> <para> <para>The name of the Place index resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCPlaceIndexCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.DescribePlaceIndexResponse). Specifying the name of a property of type Amazon.LocationService.Model.DescribePlaceIndexResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCPlaceIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexName parameter. The -PassThru parameter is deprecated, use -Select '^IndexName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCPlaceIndexListCmdlet"> <summary> Lists Place index resources in your AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCPlaceIndexListCmdlet.MaxResult"> <summary> <para> <para>An optional limit for the maximum number of results returned in a single call.</para><para>Default value: <code>100</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCPlaceIndexListCmdlet.NextToken"> <summary> <para> <para>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.</para><para>Default value: <code>null</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCPlaceIndexListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Entries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.ListPlaceIndexesResponse). Specifying the name of a property of type Amazon.LocationService.Model.ListPlaceIndexesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCTrackerCmdlet"> <summary> Retrieves the tracker resource details. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCTrackerCmdlet.TrackerName"> <summary> <para> <para>The name of the tracker resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCTrackerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.DescribeTrackerResponse). Specifying the name of a property of type Amazon.LocationService.Model.DescribeTrackerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCTrackerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrackerName parameter. The -PassThru parameter is deprecated, use -Select '^TrackerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCTrackerConsumerListCmdlet"> <summary> Lists geofence collections currently associated to the given tracker resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCTrackerConsumerListCmdlet.TrackerName"> <summary> <para> <para>The tracker resource whose associated geofence collections you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCTrackerConsumerListCmdlet.MaxResult"> <summary> <para> <para>An optional limit for the number of resources returned in a single call. </para><para>Default value: <code>100</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCTrackerConsumerListCmdlet.NextToken"> <summary> <para> <para>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. </para><para>Default value: <code>null</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCTrackerConsumerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConsumerArns'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.ListTrackerConsumersResponse). Specifying the name of a property of type Amazon.LocationService.Model.ListTrackerConsumersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCTrackerConsumerListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrackerName parameter. The -PassThru parameter is deprecated, use -Select '^TrackerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.GetLOCTrackerListCmdlet"> <summary> Lists tracker resources in your AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCTrackerListCmdlet.MaxResult"> <summary> <para> <para>An optional limit for the number of resources returned in a single call. </para><para>Default value: <code>100</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCTrackerListCmdlet.NextToken"> <summary> <para> <para>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. </para><para>Default value: <code>null</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.GetLOCTrackerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Entries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.ListTrackersResponse). Specifying the name of a property of type Amazon.LocationService.Model.ListTrackersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.NewLOCGeofenceCollectionCmdlet"> <summary> Creates a geofence collection, which manages and stores geofences. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCGeofenceCollectionCmdlet.CollectionName"> <summary> <para> <para>A custom name for the geofence collection.</para><para>Requirements:</para><ul><li><para>Contain only alphanumeric characters (A–Z, a–z, 0-9), hyphens (-), periods (.), and underscores (_). </para></li><li><para>Must be a unique geofence collection name.</para></li><li><para>No spaces allowed. For example, <code>ExampleGeofenceCollection</code>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCGeofenceCollectionCmdlet.Description"> <summary> <para> <para>An optional description for the geofence collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCGeofenceCollectionCmdlet.PricingPlan"> <summary> <para> <para>Specifies the pricing plan for your geofence collection.</para><para>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing page</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCGeofenceCollectionCmdlet.PricingPlanDataSource"> <summary> <para> <para>Specifies the plan data source. Required if the Mobile Asset Tracking (MAT) or the Mobile Asset Management (MAM) pricing plan is selected.</para><para>Billing is determined by the resource usage, the associated pricing plan, and the data source that was specified. For more information about each pricing plan option and restrictions, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing page</a>.</para><para>Valid Values: <code>Esri </code>| <code>Here</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCGeofenceCollectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.CreateGeofenceCollectionResponse). Specifying the name of a property of type Amazon.LocationService.Model.CreateGeofenceCollectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCGeofenceCollectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionName parameter. The -PassThru parameter is deprecated, use -Select '^CollectionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCGeofenceCollectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.NewLOCMapCmdlet"> <summary> Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers. <note><para> By using Maps, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. For more information, see the <a href="https://aws.amazon.com/service-terms/">AWS Service Terms</a> for Amazon Location Service. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCMapCmdlet.Description"> <summary> <para> <para>An optional description for the map resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCMapCmdlet.MapName"> <summary> <para> <para>The name for the map resource.</para><para>Requirements:</para><ul><li><para>Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). </para></li><li><para>Must be a unique map resource name. </para></li><li><para>No spaces allowed. For example, <code>ExampleMap</code>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCMapCmdlet.PricingPlan"> <summary> <para> <para>Specifies the pricing plan for your map resource.</para><para>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing page</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCMapCmdlet.Configuration_Style"> <summary> <para> <para>Specifies the map style selected from an available data provider.</para><para>Valid styles: <code>VectorEsriStreets</code>, <code>VectorEsriTopographic</code>, <code>VectorEsriNavigation</code>, <code>VectorEsriDarkGrayCanvas</code>, <code>VectorEsriLightGrayCanvas</code>, <code>VectorHereBerlin</code>.</para><note><para>When using HERE as your data provider, and selecting the Style <code>VectorHereBerlin</code>, you may not use HERE Maps for Asset Management. See the <a href="https://aws.amazon.com/service-terms/">AWS Service Terms</a> for Amazon Location Service. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCMapCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.CreateMapResponse). Specifying the name of a property of type Amazon.LocationService.Model.CreateMapResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCMapCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MapName parameter. The -PassThru parameter is deprecated, use -Select '^MapName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCMapCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.NewLOCPlaceIndexCmdlet"> <summary> Creates a Place index resource in your AWS account, which supports Places functions with geospatial data sourced from your chosen data provider. <note><para> By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. </para><para> Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the <a href="https://aws.amazon.com/service-terms/">AWS Service Terms</a> for Amazon Location Service. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCPlaceIndexCmdlet.DataSource"> <summary> <para> <para>Specifies the data provider of geospatial data.</para><note><para>This field is case-sensitive. Enter the valid values as shown. For example, entering <code>HERE</code> will return an error.</para></note><para>Valid values include:</para><ul><li><para><code>Esri</code></para></li><li><para><code>Here</code></para></li></ul><para>For additional details on data providers, see the <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers page</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCPlaceIndexCmdlet.Description"> <summary> <para> <para>The optional description for the Place index resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCPlaceIndexCmdlet.IndexName"> <summary> <para> <para>The name of the Place index resource. </para><para>Requirements:</para><ul><li><para>Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).</para></li><li><para>Must be a unique Place index resource name.</para></li><li><para>No spaces allowed. For example, <code>ExamplePlaceIndex</code>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCPlaceIndexCmdlet.DataSourceConfiguration_IntendedUse"> <summary> <para> <para>Specifies how the results of an operation will be stored by the caller. </para><para>Valid values include:</para><ul><li><para><code>SingleUse</code> specifies that the results won't be stored. </para></li><li><para><code>Storage</code> specifies that the result can be cached or stored in a database.</para></li></ul><para>Default value: <code>SingleUse</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCPlaceIndexCmdlet.PricingPlan"> <summary> <para> <para>Specifies the pricing plan for your Place index resource.</para><para>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing page</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCPlaceIndexCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.CreatePlaceIndexResponse). Specifying the name of a property of type Amazon.LocationService.Model.CreatePlaceIndexResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCPlaceIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexName parameter. The -PassThru parameter is deprecated, use -Select '^IndexName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCPlaceIndexCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.NewLOCTrackerCmdlet"> <summary> Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCTrackerCmdlet.Description"> <summary> <para> <para>An optional description for the tracker resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCTrackerCmdlet.PricingPlan"> <summary> <para> <para>Specifies the pricing plan for your tracker resource.</para><para>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing page</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCTrackerCmdlet.PricingPlanDataSource"> <summary> <para> <para>Specifies the plan data source. Required if the Mobile Asset Tracking (MAT) or the Mobile Asset Management (MAM) pricing plan is selected.</para><para>Billing is determined by the resource usage, the associated pricing plan, and data source that was specified. For more information about each pricing plan option and restrictions, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing page</a>.</para><para>Valid Values: <code>Esri</code> | <code>Here</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCTrackerCmdlet.TrackerName"> <summary> <para> <para>The name for the tracker resource.</para><para>Requirements:</para><ul><li><para>Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).</para></li><li><para>Must be a unique tracker resource name.</para></li><li><para>No spaces allowed. For example, <code>ExampleTracker</code>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCTrackerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.CreateTrackerResponse). Specifying the name of a property of type Amazon.LocationService.Model.CreateTrackerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCTrackerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrackerName parameter. The -PassThru parameter is deprecated, use -Select '^TrackerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.NewLOCTrackerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.RegisterLOCTrackerConsumerCmdlet"> <summary> 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. <note><para> Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RegisterLOCTrackerConsumerCmdlet.ConsumerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all AWS. </para><ul><li><para>Format example: <code>arn:partition:service:region:account-id:resource-type:resource-id</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RegisterLOCTrackerConsumerCmdlet.TrackerName"> <summary> <para> <para>The name of the tracker resource to be associated with a geofence collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RegisterLOCTrackerConsumerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.AssociateTrackerConsumerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RegisterLOCTrackerConsumerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrackerName parameter. The -PassThru parameter is deprecated, use -Select '^TrackerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RegisterLOCTrackerConsumerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCGeofenceBatchCmdlet"> <summary> Deletes a batch of geofences from a geofence collection. <note><para> This action deletes the resource permanently. You can't undo this action. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCGeofenceBatchCmdlet.CollectionName"> <summary> <para> <para>The geofence collection storing the geofences to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCGeofenceBatchCmdlet.GeofenceId"> <summary> <para> <para>The batch of geofences to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCGeofenceBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.BatchDeleteGeofenceResponse). Specifying the name of a property of type Amazon.LocationService.Model.BatchDeleteGeofenceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCGeofenceBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionName parameter. The -PassThru parameter is deprecated, use -Select '^CollectionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCGeofenceBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCGeofenceCollectionCmdlet"> <summary> Deletes a geofence collection from your AWS account. <note><para> This action deletes the resource permanently. You can't undo this action. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCGeofenceCollectionCmdlet.CollectionName"> <summary> <para> <para>The name of the geofence collection to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCGeofenceCollectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.DeleteGeofenceCollectionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCGeofenceCollectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionName parameter. The -PassThru parameter is deprecated, use -Select '^CollectionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCGeofenceCollectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCMapCmdlet"> <summary> Deletes a map resource from your AWS account. <note><para> This action deletes the resource permanently. You cannot undo this action. If the map is being used in an application, the map may not render. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCMapCmdlet.MapName"> <summary> <para> <para>The name of the map resource to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCMapCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.DeleteMapResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCMapCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MapName parameter. The -PassThru parameter is deprecated, use -Select '^MapName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCMapCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCPlaceIndexCmdlet"> <summary> Deletes a Place index resource from your AWS account. <note><para> This action deletes the resource permanently. You cannot undo this action. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCPlaceIndexCmdlet.IndexName"> <summary> <para> <para>The name of the Place index resource to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCPlaceIndexCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.DeletePlaceIndexResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCPlaceIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexName parameter. The -PassThru parameter is deprecated, use -Select '^IndexName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCPlaceIndexCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCTrackerCmdlet"> <summary> Deletes a tracker resource from your AWS account. <note><para> This action deletes the resource permanently. You can't undo this action. If the tracker resource is in use, you may encounter an error. Make sure that the target resource is not a dependency for your applications. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCTrackerCmdlet.TrackerName"> <summary> <para> <para>The name of the tracker resource to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCTrackerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.DeleteTrackerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCTrackerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrackerName parameter. The -PassThru parameter is deprecated, use -Select '^TrackerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.RemoveLOCTrackerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.SearchLOCPlaceIndexForPositionCmdlet"> <summary> Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position. <note><para> By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. </para><para> Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the <a href="https://aws.amazon.com/service-terms/">AWS Service Terms</a> for Amazon Location Service. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SearchLOCPlaceIndexForPositionCmdlet.IndexName"> <summary> <para> <para>The name of the Place index resource you want to use for the search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SearchLOCPlaceIndexForPositionCmdlet.Position"> <summary> <para> <para>Specifies a coordinate for the query defined by a longitude, and latitude.</para><ul><li><para>The first position is the X coordinate, or longitude.</para></li><li><para>The second position is the Y coordinate, or latitude. </para></li></ul><para>For example, <code>position=xLongitude&position=yLatitude</code> .</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SearchLOCPlaceIndexForPositionCmdlet.MaxResult"> <summary> <para> <para>An optional paramer. The maximum number of results returned per request. </para><para>Default value: <code>50</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SearchLOCPlaceIndexForPositionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.SearchPlaceIndexForPositionResponse). Specifying the name of a property of type Amazon.LocationService.Model.SearchPlaceIndexForPositionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SearchLOCPlaceIndexForPositionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexName parameter. The -PassThru parameter is deprecated, use -Select '^IndexName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.SearchLOCPlaceIndexForTextCmdlet"> <summary> Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest. <para> Includes the option to apply additional parameters to narrow your list of results. </para><note><para> You can search for places near a given position using <code>BiasPosition</code>, or filter results within a bounding box using <code>FilterBBox</code>. Providing both parameters simultaneously returns an error. </para></note><note><para> By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. </para><para> Also, when using HERE as your data provider, you may not (a) use HERE Places for Asset Management, or (b) select the <code>Storage</code> option for the <code>IntendedUse</code> parameter when requesting Places in Japan. For more information, see the <a href="https://aws.amazon.com/service-terms/">AWS Service Terms</a> for Amazon Location Service. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SearchLOCPlaceIndexForTextCmdlet.BiasPosition"> <summary> <para> <para>Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.</para><ul><li><para>The first <code>bias</code> position is the X coordinate, or longitude.</para></li><li><para>The second <code>bias</code> position is the Y coordinate, or latitude. </para></li></ul><para>For example, <code>bias=xLongitude&bias=yLatitude</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SearchLOCPlaceIndexForTextCmdlet.FilterBBox"> <summary> <para> <para>Filters the results by returning only Places within the provided bounding box. An optional parameter.</para><para>The first 2 <code>bbox</code> parameters describe the lower southwest corner:</para><ul><li><para>The first <code>bbox</code> position is the X coordinate or longitude of the lower southwest corner.</para></li><li><para>The second <code>bbox</code> position is the Y coordinate or latitude of the lower southwest corner.</para></li></ul><para>For example, <code>bbox=xLongitudeSW&bbox=yLatitudeSW</code>.</para><para>The next <code>bbox</code> parameters describe the upper northeast corner:</para><ul><li><para>The third <code>bbox</code> position is the X coordinate, or longitude of the upper northeast corner.</para></li><li><para>The fourth <code>bbox</code> position is the Y coordinate, or longitude of the upper northeast corner.</para></li></ul><para>For example, <code>bbox=xLongitudeNE&bbox=yLatitudeNE</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SearchLOCPlaceIndexForTextCmdlet.FilterCountry"> <summary> <para> <para>Limits the search to the given a list of countries/regions. An optional parameter.</para><ul><li><para>Use the <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit country code. For example, Australia uses three upper-case characters: <code>AUS</code>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SearchLOCPlaceIndexForTextCmdlet.IndexName"> <summary> <para> <para>The name of the Place index resource you want to use for the search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SearchLOCPlaceIndexForTextCmdlet.Text"> <summary> <para> <para>The address, name, city, or region to be used in the search. In free-form text format. For example, <code>123 Any Street</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SearchLOCPlaceIndexForTextCmdlet.MaxResult"> <summary> <para> <para>An optional parameter. The maximum number of results returned per request. </para><para>The default: <code>50</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SearchLOCPlaceIndexForTextCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.SearchPlaceIndexForTextResponse). Specifying the name of a property of type Amazon.LocationService.Model.SearchPlaceIndexForTextResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SearchLOCPlaceIndexForTextCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexName parameter. The -PassThru parameter is deprecated, use -Select '^IndexName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.SetLOCDevicePositionBatchCmdlet"> <summary> Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when reporting the last known device position and position history. <note><para> Only one position update is stored per sample time. Location data is sampled at a fixed rate of one position per 30-second interval, and retained for one year before it is deleted. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SetLOCDevicePositionBatchCmdlet.TrackerName"> <summary> <para> <para>The name of the tracker resource to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SetLOCDevicePositionBatchCmdlet.Update"> <summary> <para> <para>Contains the position update details for each device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SetLOCDevicePositionBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.BatchUpdateDevicePositionResponse). Specifying the name of a property of type Amazon.LocationService.Model.BatchUpdateDevicePositionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SetLOCDevicePositionBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrackerName parameter. The -PassThru parameter is deprecated, use -Select '^TrackerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SetLOCDevicePositionBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.SetLOCGeofenceCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SetLOCGeofenceCmdlet.CollectionName"> <summary> <para> <para>The geofence collection to store the geofence in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SetLOCGeofenceCmdlet.GeofenceId"> <summary> <para> <para>An identifier for the geofence. For example, <code>ExampleGeofence-1</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SetLOCGeofenceCmdlet.Geometry_Polygon"> <summary> <para> <para>An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: <code>[longitude, latitude]</code>. </para><para>The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SetLOCGeofenceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.PutGeofenceResponse). Specifying the name of a property of type Amazon.LocationService.Model.PutGeofenceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SetLOCGeofenceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionName parameter. The -PassThru parameter is deprecated, use -Select '^CollectionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SetLOCGeofenceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.SetLOCGeofenceBatchCmdlet"> <summary> A batch request for storing geofence geometries into a given geofence collection. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SetLOCGeofenceBatchCmdlet.CollectionName"> <summary> <para> <para>The geofence collection storing the geofences.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SetLOCGeofenceBatchCmdlet.Entry"> <summary> <para> <para>The batch of geofences to be stored in a geofence collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SetLOCGeofenceBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.BatchPutGeofenceResponse). Specifying the name of a property of type Amazon.LocationService.Model.BatchPutGeofenceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SetLOCGeofenceBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionName parameter. The -PassThru parameter is deprecated, use -Select '^CollectionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SetLOCGeofenceBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.SubmitLOCGeofenceEvaluationBatchCmdlet"> <summary> Evaluates device positions against the geofence geometries from a given geofence collection. The evaluation determines if the device has entered or exited a geofenced area, which publishes ENTER or EXIT geofence events to Amazon EventBridge. <note><para> The last geofence that a device was observed within, if any, is tracked for 30 days after the most recent device position update </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SubmitLOCGeofenceEvaluationBatchCmdlet.CollectionName"> <summary> <para> <para>The geofence collection used in evaluating the position of devices against its geofences.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SubmitLOCGeofenceEvaluationBatchCmdlet.DevicePositionUpdate"> <summary> <para> <para>Contains device details for each device to be evaluated against the given geofence collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SubmitLOCGeofenceEvaluationBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.BatchEvaluateGeofencesResponse). Specifying the name of a property of type Amazon.LocationService.Model.BatchEvaluateGeofencesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SubmitLOCGeofenceEvaluationBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectionName parameter. The -PassThru parameter is deprecated, use -Select '^CollectionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.SubmitLOCGeofenceEvaluationBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LOC.UnregisterLOCTrackerConsumerCmdlet"> <summary> Removes the association between a tracker resource and a geofence collection. <note><para> Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.UnregisterLOCTrackerConsumerCmdlet.ConsumerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the geofence collection to be disassociated from the tracker resource. Used when you need to specify a resource across all AWS. </para><ul><li><para>Format example: <code>arn:partition:service:region:account-id:resource-type:resource-id</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.UnregisterLOCTrackerConsumerCmdlet.TrackerName"> <summary> <para> <para>The name of the tracker resource to be dissociated from the consumer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.UnregisterLOCTrackerConsumerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.DisassociateTrackerConsumerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.UnregisterLOCTrackerConsumerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrackerName parameter. The -PassThru parameter is deprecated, use -Select '^TrackerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LOC.UnregisterLOCTrackerConsumerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |