Network.AWS.APIGateway.GetMethod

Describe an existing Method resource.

Creating a Request

getMethod

Arguments

:: Text

gmmRestAPIId

-> Text

gmmResourceId

-> Text

gmmHttpMethod

-> GetMethod

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

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

• gmmRestAPIId
• gmmResourceId
• gmmHttpMethod

data GetMethod

Request to describe an existing Method resource.

See: getMethod smart constructor.

Instances

Eq GetMethod

Methods

(==) :: GetMethod -> GetMethod -> Bool

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

Data GetMethod

Methods

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

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

toConstr :: GetMethod -> Constr

dataTypeOf :: GetMethod -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetMethod

Methods

readsPrec :: Int -> ReadS GetMethod

readList :: ReadS [GetMethod]

readPrec :: ReadPrec GetMethod

readListPrec :: ReadPrec [GetMethod]

Show GetMethod

Methods

showsPrec :: Int -> GetMethod -> ShowS

show :: GetMethod -> String

showList :: [GetMethod] -> ShowS

Generic GetMethod

Associated Types

type Rep GetMethod :: * -> *

Methods

from :: GetMethod -> Rep GetMethod x

to :: Rep GetMethod x -> GetMethod

Hashable GetMethod

Methods

hashWithSalt :: Int -> GetMethod -> Int

hash :: GetMethod -> Int

NFData GetMethod

Methods

rnf :: GetMethod -> ()

AWSRequest GetMethod

Associated Types

type Rs GetMethod :: *

Methods

request :: GetMethod -> Request GetMethod

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

ToQuery GetMethod

Methods

toQuery :: GetMethod -> QueryString

ToPath GetMethod

Methods

toPath :: GetMethod -> ByteString

ToHeaders GetMethod

Methods

toHeaders :: GetMethod -> [Header]

type Rep GetMethod

type Rep GetMethod = D1 (MetaData "GetMethod" "Network.AWS.APIGateway.GetMethod" "amazonka-apigateway-1.4.1-9LwN6bvDRGjBL5d3wQjvoh" False) (C1 (MetaCons "GetMethod'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gmmRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_gmmResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_gmmHttpMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs GetMethod

type Rs GetMethod = Method

Request Lenses

gmmRestAPIId :: Lens' GetMethod Text

The RestApi identifier for the Method resource.

gmmResourceId :: Lens' GetMethod Text

The Resource identifier for the Method resource.

gmmHttpMethod :: Lens' GetMethod Text

Specifies the put method request's HTTP method type.

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

Hashable Method

Methods

hashWithSalt :: Int -> Method -> Int

hash :: Method -> Int

FromJSON Method

Methods

parseJSON :: Value -> Parser Method

parseJSONList :: Value -> Parser [Method]

NFData Method

Methods

rnf :: Method -> ()

type Rep Method

type Rep Method = D1 (MetaData "Method" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.1-9LwN6bvDRGjBL5d3wQjvoh" 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.