Network.AWS.APIGateway.CreateUsagePlanKey

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

Creating a Request

createUsagePlanKey

Arguments

:: Text

cupkUsagePlanId

-> Text

cupkKeyId

-> Text

cupkKeyType

-> CreateUsagePlanKey

Creates a value of CreateUsagePlanKey with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cupkUsagePlanId - The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.
• cupkKeyId - The identifier of a UsagePlanKey resource for a plan customer.
• cupkKeyType - The type of a UsagePlanKey resource for a plan customer.

data CreateUsagePlanKey

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

See: createUsagePlanKey smart constructor.

Instances

Eq CreateUsagePlanKey

Methods

(==) :: CreateUsagePlanKey -> CreateUsagePlanKey -> Bool

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

Data CreateUsagePlanKey

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateUsagePlanKey -> c CreateUsagePlanKey

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateUsagePlanKey

toConstr :: CreateUsagePlanKey -> Constr

dataTypeOf :: CreateUsagePlanKey -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateUsagePlanKey)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateUsagePlanKey)

gmapT :: (forall b. Data b => b -> b) -> CreateUsagePlanKey -> CreateUsagePlanKey

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateUsagePlanKey -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateUsagePlanKey -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateUsagePlanKey -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateUsagePlanKey -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateUsagePlanKey -> m CreateUsagePlanKey

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateUsagePlanKey -> m CreateUsagePlanKey

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateUsagePlanKey -> m CreateUsagePlanKey

Read CreateUsagePlanKey

Methods

readsPrec :: Int -> ReadS CreateUsagePlanKey

readList :: ReadS [CreateUsagePlanKey]

readPrec :: ReadPrec CreateUsagePlanKey

readListPrec :: ReadPrec [CreateUsagePlanKey]

Show CreateUsagePlanKey

Methods

showsPrec :: Int -> CreateUsagePlanKey -> ShowS

show :: CreateUsagePlanKey -> String

showList :: [CreateUsagePlanKey] -> ShowS

Generic CreateUsagePlanKey

Associated Types

type Rep CreateUsagePlanKey :: * -> *

Methods

from :: CreateUsagePlanKey -> Rep CreateUsagePlanKey x

to :: Rep CreateUsagePlanKey x -> CreateUsagePlanKey

Hashable CreateUsagePlanKey

Methods

hashWithSalt :: Int -> CreateUsagePlanKey -> Int

hash :: CreateUsagePlanKey -> Int

ToJSON CreateUsagePlanKey

Methods

toJSON :: CreateUsagePlanKey -> Value

toEncoding :: CreateUsagePlanKey -> Encoding

toJSONList :: [CreateUsagePlanKey] -> Value

toEncodingList :: [CreateUsagePlanKey] -> Encoding

NFData CreateUsagePlanKey

Methods

rnf :: CreateUsagePlanKey -> ()

AWSRequest CreateUsagePlanKey

Associated Types

type Rs CreateUsagePlanKey :: *

Methods

request :: CreateUsagePlanKey -> Request CreateUsagePlanKey

response :: MonadResource m => Logger -> Service -> Proxy * CreateUsagePlanKey -> ClientResponse -> m (Response CreateUsagePlanKey)

ToPath CreateUsagePlanKey

Methods

toPath :: CreateUsagePlanKey -> ByteString

ToHeaders CreateUsagePlanKey

Methods

toHeaders :: CreateUsagePlanKey -> [Header]

ToQuery CreateUsagePlanKey

Methods

toQuery :: CreateUsagePlanKey -> QueryString

type Rep CreateUsagePlanKey

type Rep CreateUsagePlanKey = D1 (MetaData "CreateUsagePlanKey" "Network.AWS.APIGateway.CreateUsagePlanKey" "amazonka-apigateway-1.4.5-BIK2fycuXdJFBbWQ9Hqf16" False) (C1 (MetaCons "CreateUsagePlanKey'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cupkUsagePlanId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_cupkKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cupkKeyType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs CreateUsagePlanKey

type Rs CreateUsagePlanKey = UsagePlanKey

Request Lenses

cupkUsagePlanId :: Lens' CreateUsagePlanKey Text

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

cupkKeyId :: Lens' CreateUsagePlanKey Text

The identifier of a UsagePlanKey resource for a plan customer.

cupkKeyType :: Lens' CreateUsagePlanKey Text

The type of a UsagePlanKey resource for a plan customer.

Destructuring the Response

usagePlanKey :: UsagePlanKey

Creates a value of UsagePlanKey with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• upkValue - The value of a usage plan key.
• upkName - The name of a usage plan key.
• upkId - The Id of a usage plan key.
• upkType - The type of a usage plan key. Currently, the valid key type is API_KEY .

data UsagePlanKey

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: usagePlanKey smart constructor.

Instances

Eq UsagePlanKey

Methods

(==) :: UsagePlanKey -> UsagePlanKey -> Bool

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

Data UsagePlanKey

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UsagePlanKey -> c UsagePlanKey

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UsagePlanKey

toConstr :: UsagePlanKey -> Constr

dataTypeOf :: UsagePlanKey -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UsagePlanKey)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UsagePlanKey)

gmapT :: (forall b. Data b => b -> b) -> UsagePlanKey -> UsagePlanKey

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UsagePlanKey -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UsagePlanKey -> r

gmapQ :: (forall d. Data d => d -> u) -> UsagePlanKey -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UsagePlanKey -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UsagePlanKey -> m UsagePlanKey

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UsagePlanKey -> m UsagePlanKey

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UsagePlanKey -> m UsagePlanKey

Read UsagePlanKey

Methods

readsPrec :: Int -> ReadS UsagePlanKey

readList :: ReadS [UsagePlanKey]

readPrec :: ReadPrec UsagePlanKey

readListPrec :: ReadPrec [UsagePlanKey]

Show UsagePlanKey

Methods

showsPrec :: Int -> UsagePlanKey -> ShowS

show :: UsagePlanKey -> String

showList :: [UsagePlanKey] -> ShowS

Generic UsagePlanKey

Associated Types

type Rep UsagePlanKey :: * -> *

Methods

from :: UsagePlanKey -> Rep UsagePlanKey x

to :: Rep UsagePlanKey x -> UsagePlanKey

Hashable UsagePlanKey

Methods

hashWithSalt :: Int -> UsagePlanKey -> Int

hash :: UsagePlanKey -> Int

FromJSON UsagePlanKey

Methods

parseJSON :: Value -> Parser UsagePlanKey

parseJSONList :: Value -> Parser [UsagePlanKey]

NFData UsagePlanKey

Methods

rnf :: UsagePlanKey -> ()

type Rep UsagePlanKey

type Rep UsagePlanKey = D1 (MetaData "UsagePlanKey" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.5-BIK2fycuXdJFBbWQ9Hqf16" False) (C1 (MetaCons "UsagePlanKey'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_upkValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_upkName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_upkId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_upkType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

Response Lenses

upkValue :: Lens' UsagePlanKey (Maybe Text)

The value of a usage plan key.

upkName :: Lens' UsagePlanKey (Maybe Text)

The name of a usage plan key.

upkId :: Lens' UsagePlanKey (Maybe Text)

The Id of a usage plan key.

upkType :: Lens' UsagePlanKey (Maybe Text)

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