Network.AWS.APIGateway.PutMethod

Add a method to an existing Resource resource.

See: AWS API Reference for PutMethod.

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
• putApiKeyRequired
• putRestAPIId
• putResourceId
• putHttpMethod
• putAuthorizationType

data PutMethod

Request to add a method to an existing Resource resource.

See: putMethod smart constructor.

Instances

Eq PutMethod

Data PutMethod

Read PutMethod

Show PutMethod

Generic PutMethod

ToJSON PutMethod

AWSRequest PutMethod

ToPath PutMethod

ToHeaders PutMethod

ToQuery PutMethod

type Rep 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.

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
• mAuthorizationType
• mApiKeyRequired
• mMethodIntegration

data Method

Represents a method.

See: method smart constructor.

Instances

Eq Method

Data Method

Read Method

Show Method

Generic Method

FromJSON Method

type Rep Method

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.

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.