Amazonka.APIGateway.Types.Account

Documentation

data Account

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

FromJSON Account

Defined in Amazonka.APIGateway.Types.Account

Methods

parseJSON :: Value -> Parser Account

parseJSONList :: Value -> Parser [Account]

Generic Account

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

Defined in Amazonka.APIGateway.Types.Account

Methods

readsPrec :: Int -> ReadS Account

readList :: ReadS [Account]

readPrec :: ReadPrec Account

readListPrec :: ReadPrec [Account]

Show Account

Defined in Amazonka.APIGateway.Types.Account

Methods

showsPrec :: Int -> Account -> ShowS

show :: Account -> String

showList :: [Account] -> ShowS

NFData Account

Defined in Amazonka.APIGateway.Types.Account

Methods

rnf :: Account -> ()

Eq Account

Defined in Amazonka.APIGateway.Types.Account

Methods

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

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

Hashable Account

Defined in Amazonka.APIGateway.Types.Account

Methods

hashWithSalt :: Int -> Account -> Int

hash :: Account -> Int

type Rep Account

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

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.

account_apiKeyVersion :: Lens' Account (Maybe Text)

The version of the API keys used for the account.

account_cloudwatchRoleArn :: Lens' Account (Maybe Text)

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

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

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)

Specifies the API request limits configured for the current Account.