Package software.amazon.awssdk.services.apigateway.model

Class GetAccountResponse

java.lang.Object

software.amazon.awssdk.AmazonWebServiceResult<ResponseMetadata>

software.amazon.awssdk.services.apigateway.model.GetAccountResponse

All Implemented Interfaces:

ToCopyableBuilder<GetAccountResponse.Builder,GetAccountResponse>

@Generated("software.amazon.awssdk:codegen")
public class GetAccountResponse
extends AmazonWebServiceResult<ResponseMetadata>
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.

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.

API Gateway Limits Developer Guide, AWS CLI

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetAccountResponse.Builder

Method Summary

Modifier and Type	Method	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.
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()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceResult

setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

cloudwatchRoleArn

public String cloudwatchRoleArn()

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

Returns:

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

throttleSettings

public ThrottleSettings throttleSettings()

Specifies the API request limits configured for the current Account.

Returns:

Specifies the API request limits configured for the current Account.

features

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".

Returns:

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

apiKeyVersion

public String apiKeyVersion()

The version of the API keys used for the account.

Returns:

The version of the API keys used for the account.

toBuilder

public GetAccountResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetAccountResponse.Builder,GetAccountResponse>

Returns:

a builder for type T

builder

public static GetAccountResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetAccountResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object