# UpdateKey
<a name="API_geotags_UpdateKey"></a>

Updates the specified properties of a given API key resource.

## Request Syntax
<a name="API_geotags_UpdateKey_RequestSyntax"></a>

```
PATCH /metadata/v0/keys/KeyName HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "ExpireTime": "string",
   "ForceUpdate": boolean,
   "NoExpiry": boolean,
   "Restrictions": { 
      "AllowActions": [ "string" ],
      "AllowAndroidApps": [ 
         { 
            "CertificateFingerprint": "string",
            "Package": "string"
         }
      ],
      "AllowAppleApps": [ 
         { 
            "BundleId": "string"
         }
      ],
      "AllowReferers": [ "string" ],
      "AllowResources": [ "string" ]
   }
}
```

## URI Request Parameters
<a name="API_geotags_UpdateKey_RequestParameters"></a>

The request uses the following URI parameters.

 ** [KeyName](#API_geotags_UpdateKey_RequestSyntax) **   <a name="location-geotags_UpdateKey-request-uri-KeyName"></a>
The name of the API key resource to update.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[-._\w]+`   
Required: Yes

## Request Body
<a name="API_geotags_UpdateKey_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_geotags_UpdateKey_RequestSyntax) **   <a name="location-geotags_UpdateKey-request-Description"></a>
Updates the description for the API key resource.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

 ** [ExpireTime](#API_geotags_UpdateKey_RequestSyntax) **   <a name="location-geotags_UpdateKey-request-ExpireTime"></a>
Updates the timestamp for when the API key resource will expire in [ ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`.   
Type: Timestamp  
Required: No

 ** [ForceUpdate](#API_geotags_UpdateKey_RequestSyntax) **   <a name="location-geotags_UpdateKey-request-ForceUpdate"></a>
The boolean flag to be included for updating `ExpireTime` or `Restrictions` details.  
Must be set to `true` to update an API key resource that has been used in the past 7 days.  
 `False` if force update is not preferred  
Default value: `False`   
Type: Boolean  
Required: No

 ** [NoExpiry](#API_geotags_UpdateKey_RequestSyntax) **   <a name="location-geotags_UpdateKey-request-NoExpiry"></a>
Whether the API key should expire. Set to `true` to set the API key to have no expiration time.  
Type: Boolean  
Required: No

 ** [Restrictions](#API_geotags_UpdateKey_RequestSyntax) **   <a name="location-geotags_UpdateKey-request-Restrictions"></a>
Updates the API key restrictions for the API key resource.  
Type: [ApiKeyRestrictions](API_geotags_ApiKeyRestrictions.md) object  
Required: No

## Response Syntax
<a name="API_geotags_UpdateKey_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "KeyArn": "string",
   "KeyName": "string",
   "UpdateTime": "string"
}
```

## Response Elements
<a name="API_geotags_UpdateKey_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [KeyArn](#API_geotags_UpdateKey_ResponseSyntax) **   <a name="location-geotags_UpdateKey-response-KeyArn"></a>
The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all AWS.  
+ Format example: `arn:aws:geo:region:account-id:key/ExampleKey` 
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1600.  
Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?` 

 ** [KeyName](#API_geotags_UpdateKey_ResponseSyntax) **   <a name="location-geotags_UpdateKey-response-KeyName"></a>
The name of the API key resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[-._\w]+` 

 ** [UpdateTime](#API_geotags_UpdateKey_ResponseSyntax) **   <a name="location-geotags_UpdateKey-response-UpdateTime"></a>
The timestamp for when the API key resource was last updated in [ ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`.   
Type: Timestamp

## Errors
<a name="API_geotags_UpdateKey_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
   
HTTP Status Code: 403

 ** InternalServerException **   
   
HTTP Status Code: 500

 ** ResourceNotFoundException **   
   
HTTP Status Code: 404

 ** ThrottlingException **   
   
HTTP Status Code: 429

 ** ValidationException **   
   
HTTP Status Code: 400

## See Also
<a name="API_geotags_UpdateKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geotags-2020-11-19/UpdateKey) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geotags-2020-11-19/UpdateKey) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geotags-2020-11-19/UpdateKey) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geotags-2020-11-19/UpdateKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geotags-2020-11-19/UpdateKey) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geotags-2020-11-19/UpdateKey) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geotags-2020-11-19/UpdateKey) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geotags-2020-11-19/UpdateKey) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geotags-2020-11-19/UpdateKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geotags-2020-11-19/UpdateKey)