Requests API Gateway to get information about the current Account resource.

See: newGetAccount smart constructor.

Create a value of GetAccount with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Represents an AWS account that is associated with API Gateway.

To view the account info, call GET on this resource.

Error Codes

The following exception may be thrown when the request fails.

• UnauthorizedException
• NotFoundException
• TooManyRequestsException

For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes

Example: Get the information about an account.

Request

GET /account HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}

Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html", "name": "account", "templated": true }, "self": { "href": "/account" }, "account:update": { "href": "/account" } }, "cloudwatchRoleArn": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "throttleSettings": { "rateLimit": 500, "burstLimit": 1000 } }

In addition to making the REST API call directly, you can use the AWS CLI and an AWS SDK to access this resource.

API Gateway Limits Developer Guide, AWS CLI

See: newAccount smart constructor.

Create a value of Account with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKeyVersion:Account', account_apiKeyVersion - The version of the API keys used for the account.

$sel:cloudwatchRoleArn:Account', account_cloudwatchRoleArn - The ARN of an Amazon CloudWatch role for the current Account.

$sel:features:Account', account_features - A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".

$sel:throttleSettings:Account', account_throttleSettings - Specifies the API request limits configured for the current Account.

The version of the API keys used for the account.

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

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

Specifies the API request limits configured for the current Account.