- 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.
GetAccountCommand
Gets information about the current Account resource.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { APIGatewayClient, GetAccountCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
// const { APIGatewayClient, GetAccountCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
const client = new APIGatewayClient(config);
const input = {};
const command = new GetAccountCommand(input);
const response = await client.send(command);
// { // Account
// cloudwatchRoleArn: "STRING_VALUE",
// throttleSettings: { // ThrottleSettings
// burstLimit: Number("int"),
// rateLimit: Number("double"),
// },
// features: [ // ListOfString
// "STRING_VALUE",
// ],
// apiKeyVersion: "STRING_VALUE",
// };
GetAccountCommand Input
GetAccountCommandInput extends GetAccountRequest GetAccountCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
apiKeyVersion | string | undefined | The version of the API keys used for the account. |
cloudwatchRoleArn | string | undefined | The ARN of an Amazon CloudWatch role for the current Account. |
features | string[] | undefined | A list of features supported for the account. When usage plans are enabled, the features list will include an entry of |
throttleSettings | ThrottleSettings | undefined | Specifies the API request limits configured for the current Account. |
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. |