Network.AWS.APIGateway.UpdateMethod

Updates an existing Method resource.

See: AWS API Reference for UpdateMethod.

Creating a Request

updateMethod

Arguments

:: Text

ummRestAPIId

-> Text

ummResourceId

-> Text

ummHttpMethod

-> UpdateMethod

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

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

• ummPatchOperations
• ummRestAPIId
• ummResourceId
• ummHttpMethod

data UpdateMethod

Request to update an existing Method resource.

See: updateMethod smart constructor.

Instances

Eq UpdateMethod

Data UpdateMethod

Read UpdateMethod

Show UpdateMethod

Generic UpdateMethod

ToJSON UpdateMethod

AWSRequest UpdateMethod

ToPath UpdateMethod

ToHeaders UpdateMethod

ToQuery UpdateMethod

type Rep UpdateMethod

type Rs UpdateMethod = Method

Request Lenses

ummPatchOperations :: Lens' UpdateMethod [PatchOperation]

A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.

ummRestAPIId :: Lens' UpdateMethod Text

The RestApi identifier for the Method resource.

ummResourceId :: Lens' UpdateMethod Text

The Resource identifier for the Method resource.

ummHttpMethod :: Lens' UpdateMethod Text

The HTTP verb that identifies the Method resource.

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.