Struct aws_sdk_apigateway::output::UpdateAccountOutput

#[non_exhaustive]
pub struct UpdateAccountOutput {
    pub cloudwatch_role_arn: Option<String>,
    pub throttle_settings: Option<ThrottleSettings>,
    pub features: Option<Vec<String>>,
    pub api_key_version: Option<String>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

cloudwatch_role_arn: Option<String>

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

throttle_settings: Option<ThrottleSettings>

Specifies the API request limits configured for the current Account.

features: Option<Vec<String>>

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

api_key_version: Option<String>

The version of the API keys used for the account.

Implementations

impl UpdateAccountOutput

pub fn cloudwatch_role_arn(&self) -> Option<&str>

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

pub fn throttle_settings(&self) -> Option<&ThrottleSettings>

Specifies the API request limits configured for the current Account.

pub fn features(&self) -> Option<&[String]>

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

pub fn api_key_version(&self) -> Option<&str>

The version of the API keys used for the account.

impl UpdateAccountOutput

pub fn builder() -> Builder

Creates a new builder-style object to manufacture UpdateAccountOutput

Trait Implementations

impl Clone for UpdateAccountOutput

fn clone(&self) -> UpdateAccountOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateAccountOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<UpdateAccountOutput> for UpdateAccountOutput

fn eq(&self, other: &UpdateAccountOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &UpdateAccountOutput) -> bool

This method tests for !=.

impl StructuralPartialEq for UpdateAccountOutput