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

DescribeKey

Retrieves the API key resource details.

Request Syntax


GET /metadata/v0/keys/KeyName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

KeyName

The name of the API key resource.

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

Pattern: [-._\w]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CreateTime": "string",
   "Description": "string",
   "ExpireTime": "string",
   "Key": "string",
   "KeyArn": "string",
   "KeyName": "string",
   "Restrictions": { 
      "AllowActions": [ "string" ],
      "AllowReferers": [ "string" ],
      "AllowResources": [ "string" ]
   },
   "Tags": { 
      "string" : "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.

CreateTime

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

Type: Timestamp

Description

The optional description for the API key resource.

Type: String

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

ExpireTime

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

Type: Timestamp

Key

The key value/string of an API key.

Type: String

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

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]+

Restrictions

API Restrictions on the allowed actions, resources, and referers for an API key resource.

Type: ApiKeyRestrictions object

Tags

Tags associated with the API key resource.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)

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