GetAccount - Amazon API Gateway (original) (raw)

Gets information about the current Account resource.

Request Syntax

GET /account HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "apiKeyVersion": "string",
   "cloudwatchRoleArn": "string",
   "features": [ "string" ],
   "throttleSettings": { 
      "burstLimit": number,
      "rateLimit": number
   }
}

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.

apiKeyVersion

The version of the API keys used for the account.

Type: String

cloudwatchRoleArn

The ARN of an Amazon CloudWatch role for the current Account.

Type: String

features

A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".

Type: Array of strings

throttleSettings

Specifies the API request limits configured for the current Account.

Type: ThrottleSettings object

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