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

GetUsagePlanKey

Gets a usage plan key of a given key identifier.

Request Syntax


GET /usageplans/usageplanId/keys/keyId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

keyId

The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

Required: Yes

usageplanId

The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "id": "string",
   "name": "string",
   "type": "string",
   "value": "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.

id

The Id of a usage plan key.

Type: String

name

The name of a usage plan key.

Type: String

type

The type of a usage plan key. Currently, the valid key type is API_KEY.

Type: String

value

The value of a usage plan key.

Type: String

Errors

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

BadRequestException

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

HTTP Status Code: 400

NotFoundException

The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404

TooManyRequestsException

The request has reached its throttling limit. Retry after the specified time period.

HTTP Status Code: 429

UnauthorizedException

The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401

Examples

Retrieve a usage plan key

This example illustrates one usage of GetUsagePlanKey.

Sample Request


GET /usageplans/n371pt/keys/4wj0d1lt91 HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
Content-Length: 58
X-Amz-Date: 20160805T180524Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160805/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sigv4_hash}
Response

Sample Response


{
  "_links": {
    "self": {
      "href": "/usageplans/n371pt/keys/4wj0d1lt91"
    }
  },
  "id": "4wj0d1lt91",
  "name": "MyApiKey",
  "type": "API_KEY"
}