Copyright	(c) 2013-2021 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

Amazonka.APIGateway.CreateApiKey

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Create an ApiKey resource.

AWS CLI

Synopsis

data CreateApiKey = CreateApiKey' {
- enabled :: Maybe Bool
- value :: Maybe Text
- customerId :: Maybe Text
- generateDistinctId :: Maybe Bool
- name :: Maybe Text
- stageKeys :: Maybe [StageKey]
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newCreateApiKey :: CreateApiKey
createApiKey_enabled :: Lens' CreateApiKey (Maybe Bool)
createApiKey_value :: Lens' CreateApiKey (Maybe Text)
createApiKey_customerId :: Lens' CreateApiKey (Maybe Text)
createApiKey_generateDistinctId :: Lens' CreateApiKey (Maybe Bool)
createApiKey_name :: Lens' CreateApiKey (Maybe Text)
createApiKey_stageKeys :: Lens' CreateApiKey (Maybe [StageKey])
createApiKey_description :: Lens' CreateApiKey (Maybe Text)
createApiKey_tags :: Lens' CreateApiKey (Maybe (HashMap Text Text))
data ApiKey = ApiKey' {
- enabled :: Maybe Bool
- value :: Maybe Text
- customerId :: Maybe Text
- createdDate :: Maybe POSIX
- name :: Maybe Text
- id :: Maybe Text
- stageKeys :: Maybe [Text]
- lastUpdatedDate :: Maybe POSIX
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newApiKey :: ApiKey
apiKey_enabled :: Lens' ApiKey (Maybe Bool)
apiKey_value :: Lens' ApiKey (Maybe Text)
apiKey_customerId :: Lens' ApiKey (Maybe Text)
apiKey_createdDate :: Lens' ApiKey (Maybe UTCTime)
apiKey_name :: Lens' ApiKey (Maybe Text)
apiKey_id :: Lens' ApiKey (Maybe Text)
apiKey_stageKeys :: Lens' ApiKey (Maybe [Text])
apiKey_lastUpdatedDate :: Lens' ApiKey (Maybe UTCTime)
apiKey_description :: Lens' ApiKey (Maybe Text)
apiKey_tags :: Lens' ApiKey (Maybe (HashMap Text Text))

Creating a Request

data CreateApiKey Source #

Request to create an ApiKey resource.

See: newCreateApiKey smart constructor.

Constructors

CreateApiKey'

Fields

enabled :: Maybe Bool
Specifies whether the ApiKey can be used by callers.
value :: Maybe Text
Specifies a value of the API key.
customerId :: Maybe Text
An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
generateDistinctId :: Maybe Bool
Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
name :: Maybe Text
The name of the ApiKey.
stageKeys :: Maybe [StageKey]
DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
description :: Maybe Text
The description of the ApiKey.
tags :: Maybe (HashMap Text Text)
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Instances

Instances details

Eq CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods (==) :: CreateApiKey -> CreateApiKey -> Bool # (/=) :: CreateApiKey -> CreateApiKey -> Bool #
Read CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods readsPrec :: Int -> ReadS CreateApiKey # readList :: ReadS [CreateApiKey] # readPrec :: ReadPrec CreateApiKey # readListPrec :: ReadPrec [CreateApiKey] #
Show CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods showsPrec :: Int -> CreateApiKey -> ShowS # show :: CreateApiKey -> String # showList :: [CreateApiKey] -> ShowS #
Generic CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Associated Types type Rep CreateApiKey :: Type -> Type # Methods from :: CreateApiKey -> Rep CreateApiKey x # to :: Rep CreateApiKey x -> CreateApiKey #
NFData CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods rnf :: CreateApiKey -> () #
Hashable CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods hashWithSalt :: Int -> CreateApiKey -> Int # hash :: CreateApiKey -> Int #
ToJSON CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods toJSON :: CreateApiKey -> Value # toEncoding :: CreateApiKey -> Encoding # toJSONList :: [CreateApiKey] -> Value # toEncodingList :: [CreateApiKey] -> Encoding #
AWSRequest CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Associated Types type AWSResponse CreateApiKey # Methods request :: CreateApiKey -> Request CreateApiKey # response :: MonadResource m => Logger -> Service -> Proxy CreateApiKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateApiKey))) #
ToHeaders CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods toHeaders :: CreateApiKey -> [Header] #
ToPath CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods toPath :: CreateApiKey -> ByteString #
ToQuery CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods toQuery :: CreateApiKey -> QueryString #
type Rep CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey type Rep CreateApiKey = D1 ('MetaData "CreateApiKey" "Amazonka.APIGateway.CreateApiKey" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "CreateApiKey'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "customerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "generateDistinctId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stageKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StageKey]))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))
type AWSResponse CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey type AWSResponse CreateApiKey = ApiKey

newCreateApiKey :: CreateApiKey Source #

Create a value of CreateApiKey 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:enabled:CreateApiKey', createApiKey_enabled - Specifies whether the ApiKey can be used by callers.

$sel:value:CreateApiKey', createApiKey_value - Specifies a value of the API key.

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

$sel:generateDistinctId:CreateApiKey', createApiKey_generateDistinctId - Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

$sel:name:CreateApiKey', createApiKey_name - The name of the ApiKey.

$sel:stageKeys:CreateApiKey', createApiKey_stageKeys - DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

$sel:description:CreateApiKey', createApiKey_description - The description of the ApiKey.

$sel:tags:CreateApiKey', createApiKey_tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Request Lenses

createApiKey_enabled :: Lens' CreateApiKey (Maybe Bool) Source #

Specifies whether the ApiKey can be used by callers.

createApiKey_value :: Lens' CreateApiKey (Maybe Text) Source #

Specifies a value of the API key.

createApiKey_customerId :: Lens' CreateApiKey (Maybe Text) Source #

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

createApiKey_generateDistinctId :: Lens' CreateApiKey (Maybe Bool) Source #

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

createApiKey_name :: Lens' CreateApiKey (Maybe Text) Source #

The name of the ApiKey.

createApiKey_stageKeys :: Lens' CreateApiKey (Maybe [StageKey]) Source #

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

createApiKey_description :: Lens' CreateApiKey (Maybe Text) Source #

The description of the ApiKey.

createApiKey_tags :: Lens' CreateApiKey (Maybe (HashMap Text Text)) Source #

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Destructuring the Response

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.

Use API Keys

See: newApiKey smart constructor.

Constructors

ApiKey'

Fields

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

Instances

Instances details

Eq ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods (==) :: ApiKey -> ApiKey -> Bool # (/=) :: ApiKey -> ApiKey -> Bool #
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 #
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 #
NFData ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods rnf :: ApiKey -> () #
Hashable ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods hashWithSalt :: Int -> ApiKey -> Int # hash :: ApiKey -> Int #
FromJSON ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods parseJSON :: Value -> Parser ApiKey # parseJSONList :: Value -> Parser [ApiKey] #
type Rep ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey type Rep ApiKey = D1 ('MetaData "ApiKey" "Amazonka.APIGateway.Types.ApiKey" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "ApiKey'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "customerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stageKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text 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:enabled:ApiKey', apiKey_enabled - Specifies whether the API Key can be used by callers.

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

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

$sel:createdDate:ApiKey', apiKey_createdDate - The timestamp when the API Key was created.

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

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

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

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

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

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

Response Lenses

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

Specifies whether the API Key can be used by callers.

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

The value of the API Key.

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

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

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

The timestamp when the API Key was created.

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

The name of the API Key.

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

The identifier of the API Key.

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

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

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

The timestamp when the API Key was last updated.

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

The description of the API Key.

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

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