AWS SDK for C++  1.9.124
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::UpdateAccountResult Class Reference

#include <UpdateAccountResult.h>

Public Member Functions

 UpdateAccountResult ()
 
 UpdateAccountResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
UpdateAccountResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetCloudwatchRoleArn () const
 
void SetCloudwatchRoleArn (const Aws::String &value)
 
void SetCloudwatchRoleArn (Aws::String &&value)
 
void SetCloudwatchRoleArn (const char *value)
 
UpdateAccountResultWithCloudwatchRoleArn (const Aws::String &value)
 
UpdateAccountResultWithCloudwatchRoleArn (Aws::String &&value)
 
UpdateAccountResultWithCloudwatchRoleArn (const char *value)
 
const ThrottleSettingsGetThrottleSettings () const
 
void SetThrottleSettings (const ThrottleSettings &value)
 
void SetThrottleSettings (ThrottleSettings &&value)
 
UpdateAccountResultWithThrottleSettings (const ThrottleSettings &value)
 
UpdateAccountResultWithThrottleSettings (ThrottleSettings &&value)
 
const Aws::Vector< Aws::String > & GetFeatures () const
 
void SetFeatures (const Aws::Vector< Aws::String > &value)
 
void SetFeatures (Aws::Vector< Aws::String > &&value)
 
UpdateAccountResultWithFeatures (const Aws::Vector< Aws::String > &value)
 
UpdateAccountResultWithFeatures (Aws::Vector< Aws::String > &&value)
 
UpdateAccountResultAddFeatures (const Aws::String &value)
 
UpdateAccountResultAddFeatures (Aws::String &&value)
 
UpdateAccountResultAddFeatures (const char *value)
 
const Aws::StringGetApiKeyVersion () const
 
void SetApiKeyVersion (const Aws::String &value)
 
void SetApiKeyVersion (Aws::String &&value)
 
void SetApiKeyVersion (const char *value)
 
UpdateAccountResultWithApiKeyVersion (const Aws::String &value)
 
UpdateAccountResultWithApiKeyVersion (Aws::String &&value)
 
UpdateAccountResultWithApiKeyVersion (const char *value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 63 of file UpdateAccountResult.h.

Constructor & Destructor Documentation

◆ UpdateAccountResult() [1/2]

Aws::APIGateway::Model::UpdateAccountResult::UpdateAccountResult ( )

◆ UpdateAccountResult() [2/2]

Aws::APIGateway::Model::UpdateAccountResult::UpdateAccountResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddFeatures() [1/3]

UpdateAccountResult& Aws::APIGateway::Model::UpdateAccountResult::AddFeatures ( Aws::String &&  value)
inline

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

Definition at line 178 of file UpdateAccountResult.h.

◆ AddFeatures() [2/3]

UpdateAccountResult& Aws::APIGateway::Model::UpdateAccountResult::AddFeatures ( const Aws::String value)
inline

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

Definition at line 172 of file UpdateAccountResult.h.

◆ AddFeatures() [3/3]

UpdateAccountResult& Aws::APIGateway::Model::UpdateAccountResult::AddFeatures ( const char *  value)
inline

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

Definition at line 184 of file UpdateAccountResult.h.

◆ GetApiKeyVersion()

const Aws::String& Aws::APIGateway::Model::UpdateAccountResult::GetApiKeyVersion ( ) const
inline

The version of the API keys used for the account.

Definition at line 190 of file UpdateAccountResult.h.

◆ GetCloudwatchRoleArn()

const Aws::String& Aws::APIGateway::Model::UpdateAccountResult::GetCloudwatchRoleArn ( ) const
inline

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

Definition at line 74 of file UpdateAccountResult.h.

◆ GetFeatures()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::UpdateAccountResult::GetFeatures ( ) const
inline

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

Definition at line 142 of file UpdateAccountResult.h.

◆ GetThrottleSettings()

const ThrottleSettings& Aws::APIGateway::Model::UpdateAccountResult::GetThrottleSettings ( ) const
inline

Specifies the API request limits configured for the current Account.

Definition at line 111 of file UpdateAccountResult.h.

◆ operator=()

UpdateAccountResult& Aws::APIGateway::Model::UpdateAccountResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetApiKeyVersion() [1/3]

void Aws::APIGateway::Model::UpdateAccountResult::SetApiKeyVersion ( Aws::String &&  value)
inline

The version of the API keys used for the account.

Definition at line 200 of file UpdateAccountResult.h.

◆ SetApiKeyVersion() [2/3]

void Aws::APIGateway::Model::UpdateAccountResult::SetApiKeyVersion ( const Aws::String value)
inline

The version of the API keys used for the account.

Definition at line 195 of file UpdateAccountResult.h.

◆ SetApiKeyVersion() [3/3]

void Aws::APIGateway::Model::UpdateAccountResult::SetApiKeyVersion ( const char *  value)
inline

The version of the API keys used for the account.

Definition at line 205 of file UpdateAccountResult.h.

◆ SetCloudwatchRoleArn() [1/3]

void Aws::APIGateway::Model::UpdateAccountResult::SetCloudwatchRoleArn ( Aws::String &&  value)
inline

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

Definition at line 84 of file UpdateAccountResult.h.

◆ SetCloudwatchRoleArn() [2/3]

void Aws::APIGateway::Model::UpdateAccountResult::SetCloudwatchRoleArn ( const Aws::String value)
inline

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

Definition at line 79 of file UpdateAccountResult.h.

◆ SetCloudwatchRoleArn() [3/3]

void Aws::APIGateway::Model::UpdateAccountResult::SetCloudwatchRoleArn ( const char *  value)
inline

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

Definition at line 89 of file UpdateAccountResult.h.

◆ SetFeatures() [1/2]

void Aws::APIGateway::Model::UpdateAccountResult::SetFeatures ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 154 of file UpdateAccountResult.h.

◆ SetFeatures() [2/2]

void Aws::APIGateway::Model::UpdateAccountResult::SetFeatures ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 148 of file UpdateAccountResult.h.

◆ SetThrottleSettings() [1/2]

void Aws::APIGateway::Model::UpdateAccountResult::SetThrottleSettings ( const ThrottleSettings value)
inline

Specifies the API request limits configured for the current Account.

Definition at line 117 of file UpdateAccountResult.h.

◆ SetThrottleSettings() [2/2]

void Aws::APIGateway::Model::UpdateAccountResult::SetThrottleSettings ( ThrottleSettings &&  value)
inline

Specifies the API request limits configured for the current Account.

Definition at line 123 of file UpdateAccountResult.h.

◆ WithApiKeyVersion() [1/3]

UpdateAccountResult& Aws::APIGateway::Model::UpdateAccountResult::WithApiKeyVersion ( Aws::String &&  value)
inline

The version of the API keys used for the account.

Definition at line 215 of file UpdateAccountResult.h.

◆ WithApiKeyVersion() [2/3]

UpdateAccountResult& Aws::APIGateway::Model::UpdateAccountResult::WithApiKeyVersion ( const Aws::String value)
inline

The version of the API keys used for the account.

Definition at line 210 of file UpdateAccountResult.h.

◆ WithApiKeyVersion() [3/3]

UpdateAccountResult& Aws::APIGateway::Model::UpdateAccountResult::WithApiKeyVersion ( const char *  value)
inline

The version of the API keys used for the account.

Definition at line 220 of file UpdateAccountResult.h.

◆ WithCloudwatchRoleArn() [1/3]

UpdateAccountResult& Aws::APIGateway::Model::UpdateAccountResult::WithCloudwatchRoleArn ( Aws::String &&  value)
inline

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

Definition at line 99 of file UpdateAccountResult.h.

◆ WithCloudwatchRoleArn() [2/3]

UpdateAccountResult& Aws::APIGateway::Model::UpdateAccountResult::WithCloudwatchRoleArn ( const Aws::String value)
inline

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

Definition at line 94 of file UpdateAccountResult.h.

◆ WithCloudwatchRoleArn() [3/3]

UpdateAccountResult& Aws::APIGateway::Model::UpdateAccountResult::WithCloudwatchRoleArn ( const char *  value)
inline

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

Definition at line 104 of file UpdateAccountResult.h.

◆ WithFeatures() [1/2]

UpdateAccountResult& Aws::APIGateway::Model::UpdateAccountResult::WithFeatures ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 166 of file UpdateAccountResult.h.

◆ WithFeatures() [2/2]

UpdateAccountResult& Aws::APIGateway::Model::UpdateAccountResult::WithFeatures ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 160 of file UpdateAccountResult.h.

◆ WithThrottleSettings() [1/2]

UpdateAccountResult& Aws::APIGateway::Model::UpdateAccountResult::WithThrottleSettings ( const ThrottleSettings value)
inline

Specifies the API request limits configured for the current Account.

Definition at line 129 of file UpdateAccountResult.h.

◆ WithThrottleSettings() [2/2]

UpdateAccountResult& Aws::APIGateway::Model::UpdateAccountResult::WithThrottleSettings ( ThrottleSettings &&  value)
inline

Specifies the API request limits configured for the current Account.

Definition at line 135 of file UpdateAccountResult.h.


The documentation for this class was generated from the following file: