Network.AWS.APIGateway.PutIntegration

Sets up a method's integration.

Creating a Request

putIntegration

Arguments

:: Text

pRestAPIId

-> Text

pResourceId

-> Text

pHttpMethod

-> IntegrationType

pType

-> PutIntegration

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

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

• pRequestTemplates - 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.
• pCredentials - Specifies whether credentials are required for a put integration.
• pRequestParameters - 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.
• pContentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: * CONVERT_TO_BINARY : Converts a request payload from a Base64-encoded string to the corresponding binary blob. * CONVERT_TO_TEXT : Converts a request payload from a binary blob to a Base64-encoded string. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
• pPassthroughBehavior - Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH , WHEN_NO_TEMPLATES , and NEVER . * WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation. * NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response. * WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.
• pUri - 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 / .
• pCacheNamespace - Specifies a put integration input's cache namespace.
• pIntegrationHTTPMethod - Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
• pCacheKeyParameters - Specifies a put integration input's cache key parameters.
• pRestAPIId - The string identifier of the associated RestApi .
• pResourceId - Specifies a put integration request's resource ID.
• pHttpMethod - Specifies a put integration request's HTTP method.
• pType - Specifies a put integration input's type.

data PutIntegration

Sets up a method's integration.

See: putIntegration smart constructor.

Instances

Eq PutIntegration

Methods

(==) :: PutIntegration -> PutIntegration -> Bool

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

Data PutIntegration

Methods

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

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

toConstr :: PutIntegration -> Constr

dataTypeOf :: PutIntegration -> DataType

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

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

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

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

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

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

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

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

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

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

Read PutIntegration

Methods

readsPrec :: Int -> ReadS PutIntegration

readList :: ReadS [PutIntegration]

readPrec :: ReadPrec PutIntegration

readListPrec :: ReadPrec [PutIntegration]

Show PutIntegration

Methods

showsPrec :: Int -> PutIntegration -> ShowS

show :: PutIntegration -> String

showList :: [PutIntegration] -> ShowS

Generic PutIntegration

Associated Types

type Rep PutIntegration :: * -> *

Methods

from :: PutIntegration -> Rep PutIntegration x

to :: Rep PutIntegration x -> PutIntegration

Hashable PutIntegration

Methods

hashWithSalt :: Int -> PutIntegration -> Int

hash :: PutIntegration -> Int

ToJSON PutIntegration

Methods

toJSON :: PutIntegration -> Value

toEncoding :: PutIntegration -> Encoding

toJSONList :: [PutIntegration] -> Value

toEncodingList :: [PutIntegration] -> Encoding

NFData PutIntegration

Methods

rnf :: PutIntegration -> ()

AWSRequest PutIntegration

Associated Types

type Rs PutIntegration :: *

Methods

request :: PutIntegration -> Request PutIntegration

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

ToQuery PutIntegration

Methods

toQuery :: PutIntegration -> QueryString

ToPath PutIntegration

Methods

toPath :: PutIntegration -> ByteString

ToHeaders PutIntegration

Methods

toHeaders :: PutIntegration -> [Header]

type Rep PutIntegration

type Rep PutIntegration = D1 (MetaData "PutIntegration" "Network.AWS.APIGateway.PutIntegration" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "PutIntegration'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pRequestTemplates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_pCredentials") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pRequestParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))))) ((:*:) (S1 (MetaSel (Just Symbol "_pContentHandling") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy))) ((:*:) (S1 (MetaSel (Just Symbol "_pPassthroughBehavior") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pUri") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pCacheNamespace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_pIntegrationHTTPMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pCacheKeyParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_pResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_pHttpMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_pType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 IntegrationType)))))))

type Rs PutIntegration

type Rs PutIntegration = Integration

Request Lenses

pRequestTemplates :: Lens' PutIntegration (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.

pCredentials :: Lens' PutIntegration (Maybe Text)

Specifies whether credentials are required for a put integration.

pRequestParameters :: Lens' PutIntegration (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.

pContentHandling :: Lens' PutIntegration (Maybe ContentHandlingStrategy)

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: * CONVERT_TO_BINARY : Converts a request payload from a Base64-encoded string to the corresponding binary blob. * CONVERT_TO_TEXT : Converts a request payload from a binary blob to a Base64-encoded string. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.

pPassthroughBehavior :: Lens' PutIntegration (Maybe Text)

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH , WHEN_NO_TEMPLATES , and NEVER . * WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation. * NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response. * WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

pUri :: Lens' PutIntegration (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 / .

pCacheNamespace :: Lens' PutIntegration (Maybe Text)

Specifies a put integration input's cache namespace.

pIntegrationHTTPMethod :: Lens' PutIntegration (Maybe Text)

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

pCacheKeyParameters :: Lens' PutIntegration [Text]

Specifies a put integration input's cache key parameters.

pRestAPIId :: Lens' PutIntegration Text

The string identifier of the associated RestApi .

pResourceId :: Lens' PutIntegration Text

Specifies a put integration request's resource ID.

pHttpMethod :: Lens' PutIntegration Text

Specifies a put integration request's HTTP method.

pType :: Lens' PutIntegration IntegrationType

Specifies a put integration input's type.

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 - Specifies the integration's HTTP method type.
• iRequestTemplates - 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 - 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 - 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.
• iContentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: * CONVERT_TO_BINARY : Converts a request payload from a Base64-encoded string to the corresponding binary blob. * CONVERT_TO_TEXT : Converts a request payload from a binary blob to a Base64-encoded string. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
• iPassthroughBehavior - 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 - 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 - Specifies the integration's responses. Example: Get integration responses of a method Request @GET restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200 HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}20160607us-east-1apigateway/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": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200", "title": "200" }, "integrationresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" }, "integrationresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" } }, "responseParameters": { "method.response.header.Content-Type": "'applicationxml'" }, "responseTemplates": { "applicationjson": "$util.urlDecode("%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3Cname%3E%3Cstream%3E#end%3CkinesisStreams%3E")n" }, "statusCode": "200" } @ Creating an API
• iCacheNamespace - Specifies the integration's cache namespace.
• iType - Specifies the integration's type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.
• iCacheKeyParameters - Specifies the integration's cache key parameters.

data Integration

Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, 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

FromJSON Integration

Methods

parseJSON :: Value -> Parser Integration

parseJSONList :: Value -> Parser [Integration]

NFData Integration

Methods

rnf :: Integration -> ()

type Rep Integration

type Rep Integration = D1 (MetaData "Integration" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" 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 "_iContentHandling") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy)))))) ((:*:) ((:*:) (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.

iContentHandling :: Lens' Integration (Maybe ContentHandlingStrategy)

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: * CONVERT_TO_BINARY : Converts a request payload from a Base64-encoded string to the corresponding binary blob. * CONVERT_TO_TEXT : Converts a request payload from a binary blob to a Base64-encoded string. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.

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 restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200 HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}20160607us-east-1apigateway/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": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200", "title": "200" }, "integrationresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" }, "integrationresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" } }, "responseParameters": { "method.response.header.Content-Type": "'applicationxml'" }, "responseTemplates": { "applicationjson": "$util.urlDecode("%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3Cname%3E%3Cstream%3E#end%3CkinesisStreams%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 for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.

iCacheKeyParameters :: Lens' Integration [Text]

Specifies the integration's cache key parameters.