software.amazon.awssdk.services.apigateway.model

Class UpdateAccountResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

software.amazon.awssdk.services.apigateway.model.UpdateAccountResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateAccountResponse.Builder,UpdateAccountResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateAccountResponse
extends ApiGatewayResponse
implements ToCopyableBuilder<UpdateAccountResponse.Builder,UpdateAccountResponse>

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

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 Developer Guide, AWS CLI

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateAccountResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	apiKeyVersion() The version of the API keys used for the account.
static UpdateAccountResponse.Builder	builder()
String	cloudwatchRoleArn() The ARN of an Amazon CloudWatch role for the current Account.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	features() A list of features supported for the account.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFeatures() Returns true if the Features property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateAccountResponse.Builder>	serializableBuilderClass()
ThrottleSettings	throttleSettings() Specifies the API request limits configured for the current Account.
UpdateAccountResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

cloudwatchRoleArn

public final 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 final ThrottleSettings throttleSettings()

Specifies the API request limits configured for the current Account.

Returns:

Specifies the API request limits configured for the current Account.

hasFeatures

public final boolean hasFeatures()

Returns true if the Features property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

features

public final 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.

You can use hasFeatures() to see if a value was sent in this field.

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 final 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 UpdateAccountResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateAccountResponse.Builder,UpdateAccountResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static UpdateAccountResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo