Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateKey

Updates the specified properties of a given API key resource.

Request Syntax


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

{
   "Description": "string",
   "ExpireTime": "string",
   "ForceUpdate": boolean,
   "NoExpiry": boolean,
   "Restrictions": { 
      "AllowActions": [ "string" ],
      "AllowReferers": [ "string" ],
      "AllowResources": [ "string" ]
   }
}

URI Request Parameters

The request uses the following URI parameters.

KeyName

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

The request accepts the following data in JSON format.

Description

Updates the description for the API key resource.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Required: No

ExpireTime

Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Type: Timestamp

Required: No

ForceUpdate

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

Whether the API key should expire. Set to true to set the API key to have no expiration time.

Type: Boolean

Required: No

Restrictions

Updates the API key restrictions for the API key resource.

Type: ApiKeyRestrictions object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

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

Response Elements

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

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

The name of the API key resource.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-._\w]+

UpdateTime

The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

HTTP Status Code: 403

InternalServerException

The request has failed to process because of an unknown server error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource that you've entered was not found in your AWS account.

HTTP Status Code: 404

ThrottlingException

The request was denied because of request throttling.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

HTTP Status Code: 400