amazonka-apigateway-1.4.5: Amazon API Gateway SDK.

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

Network.AWS.APIGateway.GetAccount

Contents

Description

Gets information about the current Account resource.

Synopsis

Creating a Request

getAccount :: GetAccount #

Creates a value of GetAccount with the minimum fields required to make a request.

data GetAccount #

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

See: getAccount smart constructor.

Instances

Eq GetAccount # 
Data GetAccount # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetAccount -> c GetAccount #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetAccount #

toConstr :: GetAccount -> Constr #

dataTypeOf :: GetAccount -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetAccount) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetAccount) #

gmapT :: (forall b. Data b => b -> b) -> GetAccount -> GetAccount #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetAccount -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetAccount -> r #

gmapQ :: (forall d. Data d => d -> u) -> GetAccount -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetAccount -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetAccount -> m GetAccount #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetAccount -> m GetAccount #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetAccount -> m GetAccount #

Read GetAccount # 
Show GetAccount # 
Generic GetAccount # 

Associated Types

type Rep GetAccount :: * -> * #

Hashable GetAccount # 
NFData GetAccount # 

Methods

rnf :: GetAccount -> () #

AWSRequest GetAccount # 
ToQuery GetAccount # 
ToPath GetAccount # 
ToHeaders GetAccount # 

Methods

toHeaders :: GetAccount -> [Header] #

type Rep GetAccount # 
type Rep GetAccount = D1 (MetaData "GetAccount" "Network.AWS.APIGateway.GetAccount" "amazonka-apigateway-1.4.5-5OCToOwmZjEH3FMiU9Yogu" False) (C1 (MetaCons "GetAccount'" PrefixI False) U1)
type Rs GetAccount # 

Destructuring the Response

account :: Account #

Creates a value of Account with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data Account #

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 HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}us-east-1apigatewayaws4_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.

API Gateway Limits Developer Guide , AWS CLI

See: account smart constructor.

Instances

Eq Account # 

Methods

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

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

Data Account # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Account -> c Account #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Account #

toConstr :: Account -> Constr #

dataTypeOf :: Account -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Account) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Account) #

gmapT :: (forall b. Data b => b -> b) -> Account -> Account #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Account -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Account -> r #

gmapQ :: (forall d. Data d => d -> u) -> Account -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Account -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Account -> m Account #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Account -> m Account #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Account -> m Account #

Read Account # 
Show Account # 
Generic Account # 

Associated Types

type Rep Account :: * -> * #

Methods

from :: Account -> Rep Account x #

to :: Rep Account x -> Account #

Hashable Account # 

Methods

hashWithSalt :: Int -> Account -> Int #

hash :: Account -> Int #

FromJSON Account # 
NFData Account # 

Methods

rnf :: Account -> () #

type Rep Account # 
type Rep Account = D1 (MetaData "Account" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.5-5OCToOwmZjEH3FMiU9Yogu" False) (C1 (MetaCons "Account'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aApiKeyVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_aCloudwatchRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_aFeatures") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_aThrottleSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ThrottleSettings))))))

Response Lenses

aApiKeyVersion :: Lens' Account (Maybe Text) #

The version of the API keys used for the account.

aCloudwatchRoleARN :: Lens' Account (Maybe Text) #

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

aFeatures :: Lens' Account [Text] #

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

aThrottleSettings :: Lens' Account (Maybe ThrottleSettings) #

Specifies the API request limits configured for the current Account .