AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.APIGateway.Model.UpdateAccountResponse

Namespace: Amazon.APIGateway.Model
Assembly: AWSSDK.APIGateway.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateAccountResponse : AmazonWebServiceResponse

The UpdateAccountResponse type exposes the following members

Constructors

NameDescription
Public Method UpdateAccountResponse()

Properties

NameTypeDescription
Public Property ApiKeyVersion System.String

Gets and sets the property ApiKeyVersion.

The version of the API keys used for the account.

Public Property CloudwatchRoleArn System.String

Gets and sets the property CloudwatchRoleArn.

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

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Features System.Collections.Generic.List<System.String>

Gets and sets the property Features.

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

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property ThrottleSettings Amazon.APIGateway.Model.ThrottleSettings

Gets and sets the property ThrottleSettings.

Specifies the API request limits configured for the current Account.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms