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.UpdateAccount

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Changes information about the current Account resource.

Synopsis

updateAccount :: UpdateAccount
data UpdateAccount
uaPatchOperations :: Lens' UpdateAccount [PatchOperation]
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

updateAccount :: UpdateAccount #

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

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

uaPatchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.

data UpdateAccount #

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

See: updateAccount smart constructor.

Instances

Eq UpdateAccount #
Instance details Defined in Network.AWS.APIGateway.UpdateAccount Methods (==) :: UpdateAccount -> UpdateAccount -> Bool # (/=) :: UpdateAccount -> UpdateAccount -> Bool #
Data UpdateAccount #
Instance details Defined in Network.AWS.APIGateway.UpdateAccount Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateAccount -> c UpdateAccount # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateAccount # toConstr :: UpdateAccount -> Constr # dataTypeOf :: UpdateAccount -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateAccount) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateAccount) # gmapT :: (forall b. Data b => b -> b) -> UpdateAccount -> UpdateAccount # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateAccount -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateAccount -> r # gmapQ :: (forall d. Data d => d -> u) -> UpdateAccount -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateAccount -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateAccount -> m UpdateAccount # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateAccount -> m UpdateAccount # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateAccount -> m UpdateAccount #
Read UpdateAccount #
Instance details Defined in Network.AWS.APIGateway.UpdateAccount Methods readsPrec :: Int -> ReadS UpdateAccount # readList :: ReadS [UpdateAccount] # readPrec :: ReadPrec UpdateAccount # readListPrec :: ReadPrec [UpdateAccount] #
Show UpdateAccount #
Instance details Defined in Network.AWS.APIGateway.UpdateAccount Methods showsPrec :: Int -> UpdateAccount -> ShowS # show :: UpdateAccount -> String # showList :: [UpdateAccount] -> ShowS #
Generic UpdateAccount #
Instance details Defined in Network.AWS.APIGateway.UpdateAccount Associated Types type Rep UpdateAccount :: * -> * # Methods from :: UpdateAccount -> Rep UpdateAccount x # to :: Rep UpdateAccount x -> UpdateAccount #
Hashable UpdateAccount #
Instance details Defined in Network.AWS.APIGateway.UpdateAccount Methods hashWithSalt :: Int -> UpdateAccount -> Int # hash :: UpdateAccount -> Int #
ToJSON UpdateAccount #
Instance details Defined in Network.AWS.APIGateway.UpdateAccount Methods toJSON :: UpdateAccount -> Value # toEncoding :: UpdateAccount -> Encoding # toJSONList :: [UpdateAccount] -> Value # toEncodingList :: [UpdateAccount] -> Encoding #
AWSRequest UpdateAccount #
Instance details Defined in Network.AWS.APIGateway.UpdateAccount Associated Types type Rs UpdateAccount :: * # Methods request :: UpdateAccount -> Request UpdateAccount # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UpdateAccount -> ClientResponse -> m (Response UpdateAccount) #
ToHeaders UpdateAccount #
Instance details Defined in Network.AWS.APIGateway.UpdateAccount Methods toHeaders :: UpdateAccount -> [Header] #
ToPath UpdateAccount #
Instance details Defined in Network.AWS.APIGateway.UpdateAccount Methods toPath :: UpdateAccount -> ByteString #
ToQuery UpdateAccount #
Instance details Defined in Network.AWS.APIGateway.UpdateAccount Methods toQuery :: UpdateAccount -> QueryString #
NFData UpdateAccount #
Instance details Defined in Network.AWS.APIGateway.UpdateAccount Methods rnf :: UpdateAccount -> () #
type Rep UpdateAccount #
Instance details Defined in Network.AWS.APIGateway.UpdateAccount type Rep UpdateAccount = D1 (MetaData "UpdateAccount" "Network.AWS.APIGateway.UpdateAccount" "amazonka-apigateway-1.6.0-AZknipQenWKIkkS1rcDzK1" True) (C1 (MetaCons "UpdateAccount'" PrefixI True) (S1 (MetaSel (Just "_uaPatchOperations") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [PatchOperation]))))
type Rs UpdateAccount #
Instance details Defined in Network.AWS.APIGateway.UpdateAccount type Rs UpdateAccount = Account

Request Lenses

uaPatchOperations :: Lens' UpdateAccount [PatchOperation] #

A list of update operations to be applied to the specified resource and in the order specified in this list.

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 .