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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a usage plan key for adding an existing API key to a usage plan.

Synopsis

data CreateUsagePlanKey = CreateUsagePlanKey' {
- usagePlanId :: Text
- keyId :: Text
- keyType :: Text
}
newCreateUsagePlanKey :: Text -> Text -> Text -> CreateUsagePlanKey
createUsagePlanKey_usagePlanId :: Lens' CreateUsagePlanKey Text
createUsagePlanKey_keyId :: Lens' CreateUsagePlanKey Text
createUsagePlanKey_keyType :: Lens' CreateUsagePlanKey Text
data UsagePlanKey = UsagePlanKey' {
- value :: Maybe Text
- name :: Maybe Text
- id :: Maybe Text
- type' :: Maybe Text
}
newUsagePlanKey :: UsagePlanKey
usagePlanKey_value :: Lens' UsagePlanKey (Maybe Text)
usagePlanKey_name :: Lens' UsagePlanKey (Maybe Text)
usagePlanKey_id :: Lens' UsagePlanKey (Maybe Text)
usagePlanKey_type :: Lens' UsagePlanKey (Maybe Text)

Creating a Request

data CreateUsagePlanKey Source #

The POST request to create a usage plan key for adding an existing API key to a usage plan.

See: newCreateUsagePlanKey smart constructor.

Constructors

CreateUsagePlanKey'
Fields usagePlanId :: Text Required The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer. keyId :: Text Required The identifier of a UsagePlanKey resource for a plan customer. keyType :: Text Required The type of a UsagePlanKey resource for a plan customer.

Instances

Instances details

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

newCreateUsagePlanKey Source #

Arguments

:: Text	`$sel:usagePlanId:CreateUsagePlanKey'`
-> Text	`$sel:keyId:CreateUsagePlanKey'`
-> Text	`$sel:keyType:CreateUsagePlanKey'`
-> CreateUsagePlanKey

Create a value of CreateUsagePlanKey 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:usagePlanId:CreateUsagePlanKey', createUsagePlanKey_usagePlanId - [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.

$sel:keyId:CreateUsagePlanKey', createUsagePlanKey_keyId - [Required] The identifier of a UsagePlanKey resource for a plan customer.

$sel:keyType:CreateUsagePlanKey', createUsagePlanKey_keyType - [Required] The type of a UsagePlanKey resource for a plan customer.

Request Lenses

createUsagePlanKey_usagePlanId :: Lens' CreateUsagePlanKey Text Source #

Required: The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.

createUsagePlanKey_keyId :: Lens' CreateUsagePlanKey Text Source #

Required: The identifier of a UsagePlanKey resource for a plan customer.

createUsagePlanKey_keyType :: Lens' CreateUsagePlanKey Text Source #

Required: The type of a UsagePlanKey resource for a plan customer.

Destructuring the Response

data UsagePlanKey Source #

Represents a usage plan key to identify a plan customer.

To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.

"

Create and Use Usage Plans

See: newUsagePlanKey smart constructor.

Constructors

UsagePlanKey'
Fields value :: Maybe Text The value of a usage plan key. name :: Maybe Text The name of a usage plan key. id :: Maybe Text The Id of a usage plan key. type' :: Maybe Text The type of a usage plan key. Currently, the valid key type is `API_KEY`.

Instances

Instances details

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

newUsagePlanKey :: UsagePlanKey Source #

Create a value of UsagePlanKey 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:value:UsagePlanKey', usagePlanKey_value - The value of a usage plan key.

$sel:name:UsagePlanKey', usagePlanKey_name - The name of a usage plan key.

$sel:id:UsagePlanKey', usagePlanKey_id - The Id of a usage plan key.

$sel:type':UsagePlanKey', usagePlanKey_type - The type of a usage plan key. Currently, the valid key type is API_KEY.

Response Lenses

usagePlanKey_value :: Lens' UsagePlanKey (Maybe Text) Source #

The value of a usage plan key.

usagePlanKey_name :: Lens' UsagePlanKey (Maybe Text) Source #

The name of a usage plan key.

usagePlanKey_id :: Lens' UsagePlanKey (Maybe Text) Source #

The Id of a usage plan key.

usagePlanKey_type :: Lens' UsagePlanKey (Maybe Text) Source #

The type of a usage plan key. Currently, the valid key type is API_KEY.