Network.AWS.APIGateway.GetIntegration

Represents a get integration.

Creating a Request

getIntegration

Arguments

:: Text

giRestAPIId

-> Text

giResourceId

-> Text

giHttpMethod

-> GetIntegration

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

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

• giRestAPIId
• giResourceId
• giHttpMethod

data GetIntegration

Represents a get integration request.

See: getIntegration smart constructor.

Instances

Eq GetIntegration

Methods

(==) :: GetIntegration -> GetIntegration -> Bool

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

Data GetIntegration

Methods

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

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

toConstr :: GetIntegration -> Constr

dataTypeOf :: GetIntegration -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetIntegration

Methods

readsPrec :: Int -> ReadS GetIntegration

readList :: ReadS [GetIntegration]

readPrec :: ReadPrec GetIntegration

readListPrec :: ReadPrec [GetIntegration]

Show GetIntegration

Methods

showsPrec :: Int -> GetIntegration -> ShowS

show :: GetIntegration -> String

showList :: [GetIntegration] -> ShowS

Generic GetIntegration

Associated Types

type Rep GetIntegration :: * -> *

Methods

from :: GetIntegration -> Rep GetIntegration x

to :: Rep GetIntegration x -> GetIntegration

Hashable GetIntegration

Methods

hashWithSalt :: Int -> GetIntegration -> Int

hash :: GetIntegration -> Int

NFData GetIntegration

Methods

rnf :: GetIntegration -> ()

AWSRequest GetIntegration

Associated Types

type Rs GetIntegration :: *

Methods

request :: GetIntegration -> Request GetIntegration

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

ToPath GetIntegration

Methods

toPath :: GetIntegration -> ByteString

ToHeaders GetIntegration

Methods

toHeaders :: GetIntegration -> [Header]

ToQuery GetIntegration

Methods

toQuery :: GetIntegration -> QueryString

type Rep GetIntegration

type Rep GetIntegration = D1 (MetaData "GetIntegration" "Network.AWS.APIGateway.GetIntegration" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" False) (C1 (MetaCons "GetIntegration'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_giRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_giResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_giHttpMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs GetIntegration

type Rs GetIntegration = Integration

Request Lenses

giRestAPIId :: Lens' GetIntegration Text

Specifies a get integration request's API identifier.

giResourceId :: Lens' GetIntegration Text

Specifies a get integration request's resource identifier

giHttpMethod :: Lens' GetIntegration Text

Specifies a get integration request's HTTP method.

Destructuring the Response

integration :: Integration

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

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

• iHttpMethod
• iRequestTemplates
• iCredentials
• iRequestParameters
• iPassthroughBehavior
• iUri
• iIntegrationResponses
• iCacheNamespace
• iType
• iCacheKeyParameters

data Integration

Represents an HTTP, AWS, or Mock integration.

In the API Gateway console, the built-in Lambda integration is an AWS integration.

Creating an API

See: integration smart constructor.

Instances

Eq Integration

Methods

(==) :: Integration -> Integration -> Bool

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

Data Integration

Methods

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

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

toConstr :: Integration -> Constr

dataTypeOf :: Integration -> DataType

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

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

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

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

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

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

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

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

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

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

Read Integration

Methods

readsPrec :: Int -> ReadS Integration

readList :: ReadS [Integration]

readPrec :: ReadPrec Integration

readListPrec :: ReadPrec [Integration]

Show Integration

Methods

showsPrec :: Int -> Integration -> ShowS

show :: Integration -> String

showList :: [Integration] -> ShowS

Generic Integration

Associated Types

type Rep Integration :: * -> *

Methods

from :: Integration -> Rep Integration x

to :: Rep Integration x -> Integration

Hashable Integration

Methods

hashWithSalt :: Int -> Integration -> Int

hash :: Integration -> Int

NFData Integration

Methods

rnf :: Integration -> ()

FromJSON Integration

Methods

parseJSON :: Value -> Parser Integration

type Rep Integration

type Rep Integration = D1 (MetaData "Integration" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" False) (C1 (MetaCons "Integration'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_iHttpMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_iRequestTemplates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_iCredentials") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_iRequestParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_iPassthroughBehavior") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_iUri") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_iIntegrationResponses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text IntegrationResponse))))) ((:*:) (S1 (MetaSel (Just Symbol "_iCacheNamespace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_iType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe IntegrationType))) (S1 (MetaSel (Just Symbol "_iCacheKeyParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))))))

Response Lenses

iHttpMethod :: Lens' Integration (Maybe Text)

Specifies the integration's HTTP method type.

iRequestTemplates :: Lens' Integration (HashMap Text Text)

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

iCredentials :: Lens' Integration (Maybe Text)

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string 'arn:aws:iam::\\*:user\/\\*'. To use resource-based permissions on supported AWS services, specify null.

iRequestParameters :: Lens' Integration (HashMap Text Text)

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of 'method.request.{location}.{name}', where location is querystring, path, or header and name must be a valid and unique method request parameter name.

iPassthroughBehavior :: Lens' Integration (Maybe Text)

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

• WHEN_NO_MATCH passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
• WHEN_NO_TEMPLATES passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP '415 Unsupported Media Type' response.
• NEVER rejects the method request with an HTTP '415 Unsupported Media Type' response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

iUri :: Lens' Integration (Maybe Text)

Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification. For AWS integrations, the URI should be of the form 'arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}'. Region, subdomain and service are used to determine the right endpoint. For AWS services that use the 'Action=' query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial \/.

iIntegrationResponses :: Lens' Integration (HashMap Text IntegrationResponse)

Specifies the integration's responses.

Example: Get integration responses of a method

Request

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}

Response

The successful response returns '200 OK' status and a payload as follows:

{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": ">util.urlDecode(\"%3CkinesisStreams%3E#foreach(>stream in >input.path('>.StreamNames'))%3Cstream%3E%3Cname%3E>stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }

Creating an API

iCacheNamespace :: Lens' Integration (Maybe Text)

Specifies the integration's cache namespace.

iType :: Lens' Integration (Maybe IntegrationType)

Specifies the integration's type. The valid value is HTTP, AWS, or MOCK.

iCacheKeyParameters :: Lens' Integration [Text]

Specifies the integration's cache key parameters.