@Generated(value="software.amazon.awssdk:codegen") public final class GetAccountResponse extends ApiGatewayResponse implements ToCopyableBuilder<GetAccountResponse.Builder,GetAccountResponse>
Represents an AWS account that is associated with Amazon API Gateway.
To view the account info, call GET
on this resource.
The following exception may be thrown when the request fails.
For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes
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}
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.
Modifier and Type | Class and Description |
---|---|
static interface |
GetAccountResponse.Builder |
Modifier and Type | Method and Description |
---|---|
String |
apiKeyVersion()
The version of the API keys used for the account.
|
static GetAccountResponse.Builder |
builder() |
String |
cloudwatchRoleArn()
The ARN of an Amazon CloudWatch role for the current Account.
|
boolean |
equals(Object obj) |
List<String> |
features()
A list of features supported for the account.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
static Class<? extends GetAccountResponse.Builder> |
serializableBuilderClass() |
ThrottleSettings |
throttleSettings()
Specifies the API request limits configured for the current Account.
|
GetAccountResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
sdkHttpResponse
copy
public String cloudwatchRoleArn()
The ARN of an Amazon CloudWatch role for the current Account.
public ThrottleSettings throttleSettings()
Specifies the API request limits configured for the current Account.
public List<String> features()
A list of features supported for the account. When usage plans are enabled, the features list will include an
entry of "UsagePlans"
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
"UsagePlans"
.public String apiKeyVersion()
The version of the API keys used for the account.
public GetAccountResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetAccountResponse.Builder,GetAccountResponse>
toBuilder
in class AwsResponse
public static GetAccountResponse.Builder builder()
public static Class<? extends GetAccountResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.