Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.APIGateway.UpdateAccount

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Changes information about the current Account resource.

Synopsis

data UpdateAccount = UpdateAccount' {
- patchOperations :: Maybe [PatchOperation]
}
newUpdateAccount :: UpdateAccount
updateAccount_patchOperations :: Lens' UpdateAccount (Maybe [PatchOperation])
data Account = Account' {
- apiKeyVersion :: Maybe Text
- cloudwatchRoleArn :: Maybe Text
- features :: Maybe [Text]
- throttleSettings :: Maybe ThrottleSettings
}
newAccount :: Account
account_apiKeyVersion :: Lens' Account (Maybe Text)
account_cloudwatchRoleArn :: Lens' Account (Maybe Text)
account_features :: Lens' Account (Maybe [Text])
account_throttleSettings :: Lens' Account (Maybe ThrottleSettings)

Creating a Request

data UpdateAccount Source #

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

See: newUpdateAccount smart constructor.

Constructors

UpdateAccount'
Fields patchOperations :: Maybe [PatchOperation] For more information about supported patch operations, see Patch Operations.

Instances

Instances details

ToJSON UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods toJSON :: UpdateAccount -> Value # toEncoding :: UpdateAccount -> Encoding # toJSONList :: [UpdateAccount] -> Value # toEncodingList :: [UpdateAccount] -> Encoding #
ToHeaders UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods toHeaders :: UpdateAccount -> [Header] #
ToPath UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods toPath :: UpdateAccount -> ByteString #
ToQuery UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods toQuery :: UpdateAccount -> QueryString #
AWSRequest UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Associated Types type AWSResponse UpdateAccount # Methods request :: (Service -> Service) -> UpdateAccount -> Request UpdateAccount # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateAccount -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateAccount))) #
Generic UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Associated Types type Rep UpdateAccount :: Type -> Type # Methods from :: UpdateAccount -> Rep UpdateAccount x # to :: Rep UpdateAccount x -> UpdateAccount #
Read UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods readsPrec :: Int -> ReadS UpdateAccount # readList :: ReadS [UpdateAccount] # readPrec :: ReadPrec UpdateAccount # readListPrec :: ReadPrec [UpdateAccount] #
Show UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods showsPrec :: Int -> UpdateAccount -> ShowS # show :: UpdateAccount -> String # showList :: [UpdateAccount] -> ShowS #
NFData UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods rnf :: UpdateAccount -> () #
Eq UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods (==) :: UpdateAccount -> UpdateAccount -> Bool # (/=) :: UpdateAccount -> UpdateAccount -> Bool #
Hashable UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods hashWithSalt :: Int -> UpdateAccount -> Int # hash :: UpdateAccount -> Int #
type AWSResponse UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount type AWSResponse UpdateAccount = Account
type Rep UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount type Rep UpdateAccount = D1 ('MetaData "UpdateAccount" "Amazonka.APIGateway.UpdateAccount" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateAccount'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation]))))

newUpdateAccount :: UpdateAccount Source #

Create a value of UpdateAccount 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:patchOperations:UpdateAccount', updateAccount_patchOperations - For more information about supported patch operations, see Patch Operations.

Request Lenses

updateAccount_patchOperations :: Lens' UpdateAccount (Maybe [PatchOperation]) Source #

For more information about supported patch operations, see Patch Operations.

Destructuring the Response

data Account Source #

Represents an AWS account that is associated with API Gateway.

See: newAccount smart constructor.

Constructors

Account'

Fields

apiKeyVersion :: Maybe Text
The version of the API keys used for the account.
cloudwatchRoleArn :: Maybe Text
The ARN of an Amazon CloudWatch role for the current Account.
features :: Maybe [Text]
A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".
throttleSettings :: Maybe ThrottleSettings
Specifies the API request limits configured for the current Account.

Instances

Instances details

FromJSON Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods parseJSON :: Value -> Parser Account # parseJSONList :: Value -> Parser [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 #
Read Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods readsPrec :: Int -> ReadS Account # readList :: ReadS [Account] # readPrec :: ReadPrec Account # readListPrec :: ReadPrec [Account] #
Show Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods showsPrec :: Int -> Account -> ShowS # show :: Account -> String # showList :: [Account] -> ShowS #
NFData Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods rnf :: Account -> () #
Eq Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods (==) :: Account -> Account -> Bool # (/=) :: Account -> Account -> Bool #
Hashable Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods hashWithSalt :: Int -> Account -> Int # hash :: Account -> Int #
type Rep Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account type Rep Account = D1 ('MetaData "Account" "Amazonka.APIGateway.Types.Account" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" '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.