libZSservicesZSamazonka-apigatewayZSamazonka-apigateway
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.APIGateway.GetAccount

Description

Gets information about the current Account resource.

Synopsis

Creating a Request

data GetAccount Source #

Requests API Gateway to get information about the current Account resource.

See: newGetAccount smart constructor.

Constructors

GetAccount' 

Instances

Instances details
Eq GetAccount Source # 
Instance details

Defined in Amazonka.APIGateway.GetAccount

Read GetAccount Source # 
Instance details

Defined in Amazonka.APIGateway.GetAccount

Show GetAccount Source # 
Instance details

Defined in Amazonka.APIGateway.GetAccount

Generic GetAccount Source # 
Instance details

Defined in Amazonka.APIGateway.GetAccount

Associated Types

type Rep GetAccount :: Type -> Type #

NFData GetAccount Source # 
Instance details

Defined in Amazonka.APIGateway.GetAccount

Methods

rnf :: GetAccount -> () #

Hashable GetAccount Source # 
Instance details

Defined in Amazonka.APIGateway.GetAccount

AWSRequest GetAccount Source # 
Instance details

Defined in Amazonka.APIGateway.GetAccount

Associated Types

type AWSResponse GetAccount #

ToHeaders GetAccount Source # 
Instance details

Defined in Amazonka.APIGateway.GetAccount

Methods

toHeaders :: GetAccount -> [Header] #

ToPath GetAccount Source # 
Instance details

Defined in Amazonka.APIGateway.GetAccount

ToQuery GetAccount Source # 
Instance details

Defined in Amazonka.APIGateway.GetAccount

type Rep GetAccount Source # 
Instance details

Defined in Amazonka.APIGateway.GetAccount

type Rep GetAccount = D1 ('MetaData "GetAccount" "Amazonka.APIGateway.GetAccount" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetAccount'" 'PrefixI 'False) (U1 :: Type -> Type))
type AWSResponse GetAccount Source # 
Instance details

Defined in Amazonka.APIGateway.GetAccount

newGetAccount :: GetAccount Source #

Create a value of GetAccount with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Destructuring the Response

data Account Source #

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

See: newAccount smart constructor.

Constructors

Account' 

Fields

Instances

Instances details
Eq Account Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Account

Methods

(==) :: Account -> Account -> Bool #

(/=) :: Account -> Account -> Bool #

Read Account Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Account

Show Account Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Account

Generic Account Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Account

Associated Types

type Rep Account :: Type -> Type #

Methods

from :: Account -> Rep Account x #

to :: Rep Account x -> Account #

NFData Account Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Account

Methods

rnf :: Account -> () #

Hashable Account Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Account

Methods

hashWithSalt :: Int -> Account -> Int #

hash :: Account -> Int #

FromJSON Account Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Account

type Rep Account Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Account

type Rep Account = D1 ('MetaData "Account" "Amazonka.APIGateway.Types.Account" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "Account'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiKeyVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cloudwatchRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "features") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "throttleSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThrottleSettings)))))

newAccount :: Account Source #

Create a value of Account with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKeyVersion:Account', account_apiKeyVersion - The version of the API keys used for the account.

$sel:cloudwatchRoleArn:Account', account_cloudwatchRoleArn - The ARN of an Amazon CloudWatch role for the current Account.

$sel:features:Account', account_features - A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".

$sel:throttleSettings:Account', account_throttleSettings - Specifies the API request limits configured for the current Account.

Response Lenses

account_apiKeyVersion :: Lens' Account (Maybe Text) Source #

The version of the API keys used for the account.

account_cloudwatchRoleArn :: Lens' Account (Maybe Text) Source #

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

account_features :: Lens' Account (Maybe [Text]) Source #

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

account_throttleSettings :: Lens' Account (Maybe ThrottleSettings) Source #

Specifies the API request limits configured for the current Account.