Class: Aws::APIGateway::Types::Account
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::Account
- Defined in:
- gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb
Overview
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][1]
#### 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][2] [Developer Guide][3], [AWS CLI][4]
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#api_key_version ⇒ String
The version of the API keys used for the account.
-
#cloudwatch_role_arn ⇒ String
The ARN of an Amazon CloudWatch role for the current Account.
-
#features ⇒ Array<String>
A list of features supported for the account.
-
#throttle_settings ⇒ Types::ThrottleSettings
Specifies the API request limits configured for the current Account.
Instance Attribute Details
#api_key_version ⇒ String
The version of the API keys used for the account.
102 103 104 105 106 107 108 109 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 102 class Account < Struct.new( :cloudwatch_role_arn, :throttle_settings, :features, :api_key_version) SENSITIVE = [] include Aws::Structure end |
#cloudwatch_role_arn ⇒ String
The ARN of an Amazon CloudWatch role for the current Account.
102 103 104 105 106 107 108 109 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 102 class Account < Struct.new( :cloudwatch_role_arn, :throttle_settings, :features, :api_key_version) SENSITIVE = [] include Aws::Structure end |
#features ⇒ Array<String>
A list of features supported for the account. When usage plans are
enabled, the features list will include an entry of "UsagePlans"
.
102 103 104 105 106 107 108 109 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 102 class Account < Struct.new( :cloudwatch_role_arn, :throttle_settings, :features, :api_key_version) SENSITIVE = [] include Aws::Structure end |
#throttle_settings ⇒ Types::ThrottleSettings
Specifies the API request limits configured for the current Account.
102 103 104 105 106 107 108 109 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 102 class Account < Struct.new( :cloudwatch_role_arn, :throttle_settings, :features, :api_key_version) SENSITIVE = [] include Aws::Structure end |