Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.APIGateway.GetAccount

Contents

Creating a Request
Destructuring the Response
Response Lenses

Description

Gets information about the current Account resource.

Synopsis

getAccount :: GetAccount
data GetAccount
account :: Account
data Account
aApiKeyVersion :: Lens' Account (Maybe Text)
aCloudwatchRoleARN :: Lens' Account (Maybe Text)
aFeatures :: Lens' Account [Text]
aThrottleSettings :: Lens' Account (Maybe ThrottleSettings)

Creating a Request

getAccount :: GetAccount #

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

data GetAccount #

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

See: getAccount smart constructor.

Instances

Eq GetAccount #
Instance details Defined in Network.AWS.APIGateway.GetAccount Methods (==) :: GetAccount -> GetAccount -> Bool # (/=) :: GetAccount -> GetAccount -> Bool #
Data GetAccount #
Instance details Defined in Network.AWS.APIGateway.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 #
Instance details Defined in Network.AWS.APIGateway.GetAccount Methods readsPrec :: Int -> ReadS GetAccount # readList :: ReadS [GetAccount] # readPrec :: ReadPrec GetAccount # readListPrec :: ReadPrec [GetAccount] #
Show GetAccount #
Instance details Defined in Network.AWS.APIGateway.GetAccount Methods showsPrec :: Int -> GetAccount -> ShowS # show :: GetAccount -> String # showList :: [GetAccount] -> ShowS #
Generic GetAccount #
Instance details Defined in Network.AWS.APIGateway.GetAccount Associated Types type Rep GetAccount :: * -> * # Methods from :: GetAccount -> Rep GetAccount x # to :: Rep GetAccount x -> GetAccount #
Hashable GetAccount #
Instance details Defined in Network.AWS.APIGateway.GetAccount Methods hashWithSalt :: Int -> GetAccount -> Int # hash :: GetAccount -> Int #
AWSRequest GetAccount #
Instance details Defined in Network.AWS.APIGateway.GetAccount Associated Types type Rs GetAccount :: * # Methods request :: GetAccount -> Request GetAccount # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetAccount -> ClientResponse -> m (Response GetAccount) #
ToHeaders GetAccount #
Instance details Defined in Network.AWS.APIGateway.GetAccount Methods toHeaders :: GetAccount -> [Header] #
ToPath GetAccount #
Instance details Defined in Network.AWS.APIGateway.GetAccount Methods toPath :: GetAccount -> ByteString #
ToQuery GetAccount #
Instance details Defined in Network.AWS.APIGateway.GetAccount Methods toQuery :: GetAccount -> QueryString #
NFData GetAccount #
Instance details Defined in Network.AWS.APIGateway.GetAccount Methods rnf :: GetAccount -> () #
type Rep GetAccount #
Instance details Defined in Network.AWS.APIGateway.GetAccount type Rep GetAccount = D1 (MetaData "GetAccount" "Network.AWS.APIGateway.GetAccount" "amazonka-apigateway-1.6.0-AZknipQenWKIkkS1rcDzK1" False) (C1 (MetaCons "GetAccount'" PrefixI False) (U1 :: * -> *))
type Rs GetAccount #
Instance details Defined in Network.AWS.APIGateway.GetAccount type Rs GetAccount = Account

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:

aApiKeyVersion - The version of the API keys used for the account.
aCloudwatchRoleARN - The ARN of an Amazon CloudWatch role for the current Account .
aFeatures - A list of features supported for the account. When usage plans are enabled, the features list will include an entry of UsagePlans .
aThrottleSettings - Specifies the API request limits configured for the current Account .

data Account #

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 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 a200 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 #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods (==) :: Account -> Account -> Bool # (/=) :: Account -> Account -> Bool #
Data Account #
Instance details Defined in Network.AWS.APIGateway.Types.Product 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 #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods readsPrec :: Int -> ReadS Account # readList :: ReadS [Account] # readPrec :: ReadPrec Account # readListPrec :: ReadPrec [Account] #
Show Account #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods showsPrec :: Int -> Account -> ShowS # show :: Account -> String # showList :: [Account] -> ShowS #
Generic Account #
Instance details Defined in Network.AWS.APIGateway.Types.Product Associated Types type Rep Account :: * -> * # Methods from :: Account -> Rep Account x # to :: Rep Account x -> Account #
Hashable Account #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods hashWithSalt :: Int -> Account -> Int # hash :: Account -> Int #
FromJSON Account #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods parseJSON :: Value -> Parser Account # parseJSONList :: Value -> Parser [Account] #
NFData Account #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods rnf :: Account -> () #
type Rep Account #
Instance details Defined in Network.AWS.APIGateway.Types.Product type Rep Account = D1 (MetaData "Account" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.0-AZknipQenWKIkkS1rcDzK1" False) (C1 (MetaCons "Account'" PrefixI True) ((S1 (MetaSel (Just "_aApiKeyVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_aCloudwatchRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_aFeatures") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_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 .