- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetApiKeyCommand
Gets information about the current ApiKey resource.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { APIGatewayClient, GetApiKeyCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
// const { APIGatewayClient, GetApiKeyCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
const client = new APIGatewayClient(config);
const input = { // GetApiKeyRequest
apiKey: "STRING_VALUE", // required
includeValue: true || false,
};
const command = new GetApiKeyCommand(input);
const response = await client.send(command);
// { // ApiKey
// id: "STRING_VALUE",
// value: "STRING_VALUE",
// name: "STRING_VALUE",
// customerId: "STRING_VALUE",
// description: "STRING_VALUE",
// enabled: true || false,
// createdDate: new Date("TIMESTAMP"),
// lastUpdatedDate: new Date("TIMESTAMP"),
// stageKeys: [ // ListOfString
// "STRING_VALUE",
// ],
// tags: { // MapOfStringToString
// "<keys>": "STRING_VALUE",
// },
// };
GetApiKeyCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
apiKeyRequired | string | undefined | The identifier of the ApiKey resource. |
includeValue | boolean | undefined | A boolean flag to specify whether ( |
GetApiKeyCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
createdDate | Date | undefined | The timestamp when the API Key was created. |
customerId | string | undefined | An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace. |
description | string | undefined | The description of the API Key. |
enabled | boolean | undefined | Specifies whether the API Key can be used by callers. |
id | string | undefined | The identifier of the API Key. |
lastUpdatedDate | Date | undefined | The timestamp when the API Key was last updated. |
name | string | undefined | The name of the API Key. |
stageKeys | string[] | undefined | A list of Stage resources that are associated with the ApiKey resource. |
tags | Record<string, string> | undefined | The collection of tags. Each tag element is associated with a given resource. |
value | string | undefined | The value of the API Key. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| BadRequestException | client | The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details. |
| NotFoundException | client | The requested resource is not found. Make sure that the request URI is correct. |
| TooManyRequestsException | client | The request has reached its throttling limit. Retry after the specified time period. |
| UnauthorizedException | client | The request is denied because the caller has insufficient permissions. |
| APIGatewayServiceException | Base exception class for all service exceptions from APIGateway service. |