AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Location Service UpdateKey API operation.

Syntax

Update-LOCKey
-KeyName <String>
-Restrictions_AllowAction <String[]>
-Restrictions_AllowAndroidApp <AndroidApp[]>
-Restrictions_AllowAppleApp <AppleApp[]>
-Restrictions_AllowReferer <String[]>
-Restrictions_AllowResource <String[]>
-Description <String>
-ExpireTime <DateTime>
-ForceUpdate <Boolean>
-NoExpiry <Boolean>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonLocationServiceConfig>

Description

Updates the specified properties of a given API key resource.

Parameters

-ClientConfig <AmazonLocationServiceConfig>
Amazon.PowerShell.Cmdlets.LOC.AmazonLocationServiceClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
Updates the description for the API key resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExpireTime <DateTime>
Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ForceUpdate <Boolean>
The boolean flag to be included for updating ExpireTime or Restrictions details.Must be set to true to update an API key resource that has been used in the past 7 days.False if force update is not preferredDefault value: False
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KeyName <String>
The name of the API key resource to update.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-NoExpiry <Boolean>
Whether the API key should expire. Set to true to set the API key to have no expiration time.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the KeyName parameter. The -PassThru parameter is deprecated, use -Select '^KeyName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Restrictions_AllowAction <String[]>
A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.The following are valid values for the actions.
  • Map actions
    • geo:GetMap* - Allows all actions needed for map rendering.
    • geo-maps:GetTile - Allows retrieving map tiles.
    • geo-maps:GetStaticMap - Allows retrieving static map images.
    • geo-maps:* - Allows all actions related to map functionalities.
  • Place actions
    • geo:SearchPlaceIndexForText - Allows geocoding.
    • geo:SearchPlaceIndexForPosition - Allows reverse geocoding.
    • geo:SearchPlaceIndexForSuggestions - Allows generating suggestions from text.
    • GetPlace - Allows finding a place by place ID.
    • geo-places:Geocode - Allows geocoding using place information.
    • geo-places:ReverseGeocode - Allows reverse geocoding from location coordinates.
    • geo-places:SearchNearby - Allows searching for places near a location.
    • geo-places:SearchText - Allows searching for places based on text input.
    • geo-places:Autocomplete - Allows auto-completion of place names based on text input.
    • geo-places:Suggest - Allows generating suggestions for places based on partial input.
    • geo-places:GetPlace - Allows finding a place by its ID.
    • geo-places:* - Allows all actions related to place services.
  • Route actions
    • geo:CalculateRoute - Allows point to point routing.
    • geo:CalculateRouteMatrix - Allows calculating a matrix of routes.
    • geo-routes:CalculateRoutes - Allows calculating multiple routes between points.
    • geo-routes:CalculateRouteMatrix - Allows calculating a matrix of routes between points.
    • geo-routes:CalculateIsolines - Allows calculating isolines for a given area.
    • geo-routes:OptimizeWaypoints - Allows optimizing the order of waypoints in a route.
    • geo-routes:SnapToRoads - Allows snapping a route to the nearest roads.
    • geo-routes:* - Allows all actions related to routing functionalities.
You must use these strings exactly. For example, to provide access to map rendering, the only valid action is geo:GetMap* as an input to the list. ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not. Similarly, you cannot use ["geo:SearchPlaceIndexFor*"] - you must list each of the Place actions separately.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRestrictions_AllowActions
-Restrictions_AllowAndroidApp <AndroidApp[]>
An optional list of allowed Android applications for which requests must originate from. Requests using this API key from other sources will not be allowed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRestrictions_AllowAndroidApps
-Restrictions_AllowAppleApp <AppleApp[]>
An optional list of allowed Apple applications for which requests must originate from. Requests using this API key from other sources will not be allowed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRestrictions_AllowAppleApps
-Restrictions_AllowReferer <String[]>
An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.Requirements:
  • Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*`(),;/?:@=&
  • May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
  • May contain wildcard characters question mark (?) and asterisk (*).Question mark (?) will replace any single character (including hexadecimal digits).Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
  • No spaces allowed. For example, https://example.com.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRestrictions_AllowReferers
-Restrictions_AllowResource <String[]>
A list of allowed resource ARNs that a API key bearer can perform actions on.
  • The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
  • The resources must be in the same partition, region, and account-id as the key that is being created.
  • Other than wildcards, you must include the full ARN, including the arn, partition, service, region, account-id and resource-id delimited by colons (:).
  • No spaces allowed, even with wildcards. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
For more information about ARN format, see Amazon Resource Names (ARNs).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRestrictions_AllowResources
-Select <String>
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.UpdateKeyResponse). Specifying the name of a property of type Amazon.LocationService.Model.UpdateKeyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.LocationService.Model.UpdateKeyResponse
This cmdlet returns an Amazon.LocationService.Model.UpdateKeyResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z