Network.AWS.APIGateway.PutMethod

Add a method to an existing Resource resource.

Creating a Request

putMethod

Arguments

:: Text

putRestAPIId

-> Text

putResourceId

-> Text

putHttpMethod

-> Text

putAuthorizationType

-> PutMethod

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

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

• putRequestModels
• putRequestParameters
• putAuthorizerId
• putApiKeyRequired
• putRestAPIId
• putResourceId
• putHttpMethod
• putAuthorizationType

data PutMethod

Request to add a method to an existing Resource resource.

See: putMethod smart constructor.

Instances

Eq PutMethod

Methods

(==) :: PutMethod -> PutMethod -> Bool

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

Data PutMethod

Methods

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

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

toConstr :: PutMethod -> Constr

dataTypeOf :: PutMethod -> DataType

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

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

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

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

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

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

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

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

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

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

Read PutMethod

Methods

readsPrec :: Int -> ReadS PutMethod

readList :: ReadS [PutMethod]

readPrec :: ReadPrec PutMethod

readListPrec :: ReadPrec [PutMethod]

Show PutMethod

Methods

showsPrec :: Int -> PutMethod -> ShowS

show :: PutMethod -> String

showList :: [PutMethod] -> ShowS

Generic PutMethod

Associated Types

type Rep PutMethod :: * -> *

Methods

from :: PutMethod -> Rep PutMethod x

to :: Rep PutMethod x -> PutMethod

ToJSON PutMethod

Methods

toJSON :: PutMethod -> Value

toEncoding :: PutMethod -> Encoding

Hashable PutMethod

Methods

hashWithSalt :: Int -> PutMethod -> Int

hash :: PutMethod -> Int

NFData PutMethod

Methods

rnf :: PutMethod -> ()

AWSRequest PutMethod

Associated Types

type Rs PutMethod :: *

Methods

request :: PutMethod -> Request PutMethod

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

ToPath PutMethod

Methods

toPath :: PutMethod -> ByteString

ToHeaders PutMethod

Methods

toHeaders :: PutMethod -> [Header]

ToQuery PutMethod

Methods

toQuery :: PutMethod -> QueryString

type Rep PutMethod

type Rep PutMethod = D1 (MetaData "PutMethod" "Network.AWS.APIGateway.PutMethod" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "PutMethod'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_putRequestModels") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_putRequestParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Bool))))) ((:*:) (S1 (MetaSel (Just Symbol "_putAuthorizerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_putApiKeyRequired") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_putRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_putResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_putHttpMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_putAuthorizationType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs PutMethod

type Rs PutMethod = Method

Request Lenses

putRequestModels :: Lens' PutMethod (HashMap Text Text)

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

putRequestParameters :: Lens' PutMethod (HashMap Text Bool)

Represents requests parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern 'integration.request.{location}.{name}', where location is either querystring, path, or header. name must be a valid, unique parameter name.

putAuthorizerId :: Lens' PutMethod (Maybe Text)

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.

putApiKeyRequired :: Lens' PutMethod (Maybe Bool)

Specifies whether the method required a valid ApiKey.

putRestAPIId :: Lens' PutMethod Text

The RestApi identifier for the new Method resource.

putResourceId :: Lens' PutMethod Text

The Resource identifier for the new Method resource.

putHttpMethod :: Lens' PutMethod Text

Specifies the put method request's HTTP method type.

putAuthorizationType :: Lens' PutMethod Text

Specifies the type of authorization used for the method.

Destructuring the Response

method :: Method

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

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

• mMethodResponses
• mHttpMethod
• mRequestModels
• mRequestParameters
• mAuthorizerId
• mAuthorizationType
• mApiKeyRequired
• mMethodIntegration

data Method

Represents a method.

See: method smart constructor.

Instances

Eq Method

Methods

(==) :: Method -> Method -> Bool

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

Data Method

Methods

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

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

toConstr :: Method -> Constr

dataTypeOf :: Method -> DataType

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

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

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

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

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

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

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

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

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

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

Read Method

Methods

readsPrec :: Int -> ReadS Method

readList :: ReadS [Method]

readPrec :: ReadPrec Method

readListPrec :: ReadPrec [Method]

Show Method

Methods

showsPrec :: Int -> Method -> ShowS

show :: Method -> String

showList :: [Method] -> ShowS

Generic Method

Associated Types

type Rep Method :: * -> *

Methods

from :: Method -> Rep Method x

to :: Rep Method x -> Method

FromJSON Method

Methods

parseJSON :: Value -> Parser Method

Hashable Method

Methods

hashWithSalt :: Int -> Method -> Int

hash :: Method -> Int

NFData Method

Methods

rnf :: Method -> ()

type Rep Method

type Rep Method = D1 (MetaData "Method" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "Method'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_mMethodResponses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text MethodResponse)))) (S1 (MetaSel (Just Symbol "_mHttpMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_mRequestModels") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_mRequestParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Bool)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_mAuthorizerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mAuthorizationType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_mApiKeyRequired") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_mMethodIntegration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integration)))))))

Response Lenses

mMethodResponses :: Lens' Method (HashMap Text MethodResponse)

Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.

mHttpMethod :: Lens' Method (Maybe Text)

The HTTP method.

mRequestModels :: Lens' Method (HashMap Text Text)

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

mRequestParameters :: Lens' Method (HashMap Text Bool)

Represents request parameters that can be accepted by Amazon API Gateway. Request parameters are represented as a key/value map, with a source as the key and a Boolean flag as the value. The Boolean flag is used to specify whether the parameter is required. A source must match the pattern 'method.request.{location}.{name}', where location is either querystring, path, or header. name is a valid, unique parameter name. Sources specified here are available to the integration for mapping to integration request parameters or templates.

mAuthorizerId :: Lens' Method (Maybe Text)

Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.

mAuthorizationType :: Lens' Method (Maybe Text)

The method's authorization type.

mApiKeyRequired :: Lens' Method (Maybe Bool)

Specifies whether the method requires a valid ApiKey.

mMethodIntegration :: Lens' Method (Maybe Integration)

The method's integration.