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.Types.ApiKey

Description

Synopsis

data ApiKey = ApiKey' {
- createdDate :: Maybe POSIX
- customerId :: Maybe Text
- description :: Maybe Text
- enabled :: Maybe Bool
- id :: Maybe Text
- lastUpdatedDate :: Maybe POSIX
- name :: Maybe Text
- stageKeys :: Maybe [Text]
- tags :: Maybe (HashMap Text Text)
- value :: Maybe Text
}
newApiKey :: ApiKey
apiKey_createdDate :: Lens' ApiKey (Maybe UTCTime)
apiKey_customerId :: Lens' ApiKey (Maybe Text)
apiKey_description :: Lens' ApiKey (Maybe Text)
apiKey_enabled :: Lens' ApiKey (Maybe Bool)
apiKey_id :: Lens' ApiKey (Maybe Text)
apiKey_lastUpdatedDate :: Lens' ApiKey (Maybe UTCTime)
apiKey_name :: Lens' ApiKey (Maybe Text)
apiKey_stageKeys :: Lens' ApiKey (Maybe [Text])
apiKey_tags :: Lens' ApiKey (Maybe (HashMap Text Text))
apiKey_value :: Lens' ApiKey (Maybe Text)

Documentation

data ApiKey Source #

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

See: newApiKey smart constructor.

Constructors

ApiKey'

Fields

createdDate :: Maybe POSIX
The timestamp when the API Key was created.
customerId :: Maybe Text
An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
description :: Maybe Text
The description of the API Key.
enabled :: Maybe Bool
Specifies whether the API Key can be used by callers.
id :: Maybe Text
The identifier of the API Key.
lastUpdatedDate :: Maybe POSIX
The timestamp when the API Key was last updated.
name :: Maybe Text
The name of the API Key.
stageKeys :: Maybe [Text]
A list of Stage resources that are associated with the ApiKey resource.
tags :: Maybe (HashMap Text Text)
The collection of tags. Each tag element is associated with a given resource.
value :: Maybe Text
The value of the API Key.

Instances

Instances details

FromJSON ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods parseJSON :: Value -> Parser ApiKey # parseJSONList :: Value -> Parser [ApiKey] #
Generic ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Associated Types type Rep ApiKey :: Type -> Type # Methods from :: ApiKey -> Rep ApiKey x # to :: Rep ApiKey x -> ApiKey #
Read ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods readsPrec :: Int -> ReadS ApiKey # readList :: ReadS [ApiKey] # readPrec :: ReadPrec ApiKey # readListPrec :: ReadPrec [ApiKey] #
Show ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods showsPrec :: Int -> ApiKey -> ShowS # show :: ApiKey -> String # showList :: [ApiKey] -> ShowS #
NFData ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods rnf :: ApiKey -> () #
Eq ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods (==) :: ApiKey -> ApiKey -> Bool # (/=) :: ApiKey -> ApiKey -> Bool #
Hashable ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods hashWithSalt :: Int -> ApiKey -> Int # hash :: ApiKey -> Int #
type Rep ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey type Rep ApiKey = D1 ('MetaData "ApiKey" "Amazonka.APIGateway.Types.ApiKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ApiKey'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "customerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "stageKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newApiKey :: ApiKey Source #

Create a value of ApiKey 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:createdDate:ApiKey', apiKey_createdDate - The timestamp when the API Key was created.

$sel:customerId:ApiKey', apiKey_customerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

$sel:description:ApiKey', apiKey_description - The description of the API Key.

$sel:enabled:ApiKey', apiKey_enabled - Specifies whether the API Key can be used by callers.

$sel:id:ApiKey', apiKey_id - The identifier of the API Key.

$sel:lastUpdatedDate:ApiKey', apiKey_lastUpdatedDate - The timestamp when the API Key was last updated.

$sel:name:ApiKey', apiKey_name - The name of the API Key.

$sel:stageKeys:ApiKey', apiKey_stageKeys - A list of Stage resources that are associated with the ApiKey resource.

$sel:tags:ApiKey', apiKey_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:value:ApiKey', apiKey_value - The value of the API Key.

apiKey_createdDate :: Lens' ApiKey (Maybe UTCTime) Source #

The timestamp when the API Key was created.

apiKey_customerId :: Lens' ApiKey (Maybe Text) Source #

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

apiKey_description :: Lens' ApiKey (Maybe Text) Source #

The description of the API Key.

apiKey_enabled :: Lens' ApiKey (Maybe Bool) Source #

Specifies whether the API Key can be used by callers.

apiKey_id :: Lens' ApiKey (Maybe Text) Source #

The identifier of the API Key.

apiKey_lastUpdatedDate :: Lens' ApiKey (Maybe UTCTime) Source #

The timestamp when the API Key was last updated.

apiKey_name :: Lens' ApiKey (Maybe Text) Source #

The name of the API Key.

apiKey_stageKeys :: Lens' ApiKey (Maybe [Text]) Source #

A list of Stage resources that are associated with the ApiKey resource.

apiKey_tags :: Lens' ApiKey (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

apiKey_value :: Lens' ApiKey (Maybe Text) Source #

The value of the API Key.