com.amazonaws.services.apigateway.model

Class GetAccountResult

java.lang.Object

com.amazonaws.services.apigateway.model.GetAccountResult

All Implemented Interfaces:

Serializable, Cloneable

public class GetAccountResult
extends Object
implements Serializable, Cloneable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetAccountResult()

Method Summary

Modifier and Type	Method and Description
GetAccountResult	clone()
boolean	equals(Object obj)
String	getApiKeyVersion() The version of the API keys used for the account.
String	getCloudwatchRoleArn() The ARN of an Amazon CloudWatch role for the current Account.
List<String>	getFeatures() A list of features supported for the account.
ThrottleSettings	getThrottleSettings() Specifies the API request limits configured for the current Account.
int	hashCode()
void	setApiKeyVersion(String apiKeyVersion) The version of the API keys used for the account.
void	setCloudwatchRoleArn(String cloudwatchRoleArn) The ARN of an Amazon CloudWatch role for the current Account.
void	setFeatures(Collection<String> features) A list of features supported for the account.
void	setThrottleSettings(ThrottleSettings throttleSettings) Specifies the API request limits configured for the current Account.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetAccountResult	withApiKeyVersion(String apiKeyVersion) The version of the API keys used for the account.
GetAccountResult	withCloudwatchRoleArn(String cloudwatchRoleArn) The ARN of an Amazon CloudWatch role for the current Account.
GetAccountResult	withFeatures(Collection<String> features) A list of features supported for the account.
GetAccountResult	withFeatures(String... features) A list of features supported for the account.
GetAccountResult	withThrottleSettings(ThrottleSettings throttleSettings) Specifies the API request limits configured for the current Account.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetAccountResult

public GetAccountResult()

Method Detail

setCloudwatchRoleArn

public void setCloudwatchRoleArn(String cloudwatchRoleArn)

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

Parameters:

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

getCloudwatchRoleArn

public String getCloudwatchRoleArn()

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

Returns:

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

withCloudwatchRoleArn

public GetAccountResult withCloudwatchRoleArn(String cloudwatchRoleArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setThrottleSettings

public void setThrottleSettings(ThrottleSettings throttleSettings)

Specifies the API request limits configured for the current Account.

Parameters:

throttleSettings - Specifies the API request limits configured for the current Account.

getThrottleSettings

public ThrottleSettings getThrottleSettings()

Specifies the API request limits configured for the current Account.

Returns:

Specifies the API request limits configured for the current Account.

withThrottleSettings

public GetAccountResult withThrottleSettings(ThrottleSettings throttleSettings)

Specifies the API request limits configured for the current Account.

Parameters:

throttleSettings - Specifies the API request limits configured for the current Account.

Returns:

Returns a reference to this object so that method calls can be chained together.

getFeatures

public List<String> getFeatures()

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

setFeatures

public void setFeatures(Collection<String> features)

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

Parameters:

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

withFeatures

public GetAccountResult withFeatures(String... features)

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

NOTE: This method appends the values to the existing list (if any). Use setFeatures(java.util.Collection) or withFeatures(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withFeatures

public GetAccountResult withFeatures(Collection<String> features)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setApiKeyVersion

public void setApiKeyVersion(String apiKeyVersion)

The version of the API keys used for the account.

Parameters:

apiKeyVersion - The version of the API keys used for the account.

getApiKeyVersion

public String getApiKeyVersion()

The version of the API keys used for the account.

Returns:

The version of the API keys used for the account.

withApiKeyVersion

public GetAccountResult withApiKeyVersion(String apiKeyVersion)

The version of the API keys used for the account.

Parameters:

apiKeyVersion - The version of the API keys used for the account.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetAccountResult clone()

Overrides:

clone in class Object