Struct rusoto_apigateway::Account
[−]
[src]
pub struct Account { pub api_key_version: Option<String>, pub cloudwatch_role_arn: Option<String>, pub features: Option<Vec<String>>, pub throttle_settings: Option<ThrottleSettings>, }
Represents an AWS account that is associated with Amazon 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": "http://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.
Fields
api_key_version: Option<String>
The version of the API keys used for the account.
cloudwatch_role_arn: Option<String>
The ARN of an Amazon CloudWatch role for the current Account.
features: Option<Vec<String>>
A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans"
.
throttle_settings: Option<ThrottleSettings>
Specifies the API request limits configured for the current Account.