Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Represents an update integration.
Synopsis
- updateIntegration :: Text -> Text -> Text -> UpdateIntegration
- data UpdateIntegration
- updPatchOperations :: Lens' UpdateIntegration [PatchOperation]
- updRestAPIId :: Lens' UpdateIntegration Text
- updResourceId :: Lens' UpdateIntegration Text
- updHttpMethod :: Lens' UpdateIntegration Text
- integration :: Integration
- data Integration
- iHttpMethod :: Lens' Integration (Maybe Text)
- iRequestTemplates :: Lens' Integration (HashMap Text Text)
- iCredentials :: Lens' Integration (Maybe Text)
- iConnectionId :: Lens' Integration (Maybe Text)
- iRequestParameters :: Lens' Integration (HashMap Text Text)
- iContentHandling :: Lens' Integration (Maybe ContentHandlingStrategy)
- iPassthroughBehavior :: Lens' Integration (Maybe Text)
- iUri :: Lens' Integration (Maybe Text)
- iIntegrationResponses :: Lens' Integration (HashMap Text IntegrationResponse)
- iCacheNamespace :: Lens' Integration (Maybe Text)
- iTimeoutInMillis :: Lens' Integration (Maybe Int)
- iType :: Lens' Integration (Maybe IntegrationType)
- iConnectionType :: Lens' Integration (Maybe ConnectionType)
- iCacheKeyParameters :: Lens' Integration [Text]
Creating a Request
Creates a value of UpdateIntegration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
updPatchOperations
- A list of update operations to be applied to the specified resource and in the order specified in this list.updRestAPIId
- [Required] The string identifier of the associatedRestApi
.updResourceId
- [Required] Represents an update integration request's resource identifier.updHttpMethod
- [Required] Represents an update integration request's HTTP method.
data UpdateIntegration Source #
Represents an update integration request.
See: updateIntegration
smart constructor.
Instances
Request Lenses
updPatchOperations :: Lens' UpdateIntegration [PatchOperation] Source #
A list of update operations to be applied to the specified resource and in the order specified in this list.
updRestAPIId :: Lens' UpdateIntegration Text Source #
- Required
- The string identifier of the associated
RestApi
.
updResourceId :: Lens' UpdateIntegration Text Source #
- Required
- Represents an update integration request's resource identifier.
updHttpMethod :: Lens' UpdateIntegration Text Source #
- Required
- Represents an update integration request's HTTP method.
Destructuring the Response
integration :: Integration Source #
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 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 stringarn:aws:iam::*:user/*
. To use resource-based permissions on supported AWS services, specify null.iConnectionId
- The (@id@ ) of theVpcLink
used for the integration whenconnectionType=VPC_LINK
and undefined, otherwise.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 ofmethod.request.{location}.{name}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name.iContentHandling
- Specifies how to handle request payload content type conversions. Supported values areCONVERT_TO_BINARY
andCONVERT_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 thepassthroughBehaviors
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 inrequestTemplates
. The valid value is one of the following: *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 HTTP415 Unsupported Media Type
response. *NEVER
: rejects the method request with an HTTP415 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 Uniform Resource Identifier (URI) of the integration endpoint. * ForHTTP
orHTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification , for either standard integration, whereconnectionType
is notVPC_LINK
, or private integration, whereconnectionType
isVPC_LINK
. For a private HTTP integration, the URI is not used for routing. * ForAWS
orAWS_PROXY
integrations, the URI is of the formarn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}
. Here,{Region}
is the API Gateway region (e.g.,us-east-1
);{service}
is the name of the integrated AWS service (e.g.,s3
); and{subdomain}
is a designated subdomain supported by certain AWS service for fast host-name lookup.action
can be used for an AWS service action-based API, using anAction={name}&{p1}={v1}&p2={v2}...
query string. The ensuing{service_api}
refers to a supported action{name}
plus any required input parameters. Alternatively,path
can be used for an AWS service path-based API. The ensuingservice_api
refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API ofGetObject
, theuri
can be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn:aws:apigateway:us-west-2:s3:path{bucket}{key}
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 OKstatus 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 APIiCacheNamespace
- Specifies the integration's cache namespace.iTimeoutInMillis
- Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.iType
- Specifies an API method integration type. The valid value is one of the following: *AWS
: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. *AWS_PROXY
: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration. *HTTP
: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration. *HTTP_PROXY
: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration. *MOCK
: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend. For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https
), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with aconnectionType
ofVPC_LINK
is referred to as a private integration and uses aVpcLink
to connect API Gateway to a network load balancer of a VPC.iConnectionType
- The type of the network connection to the integration endpoint. The valid value isINTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
.iCacheKeyParameters
- Specifies the integration's cache key parameters.
data Integration Source #
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
Response Lenses
iHttpMethod :: Lens' Integration (Maybe Text) Source #
Specifies the integration's HTTP method type.
iRequestTemplates :: Lens' Integration (HashMap Text Text) Source #
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) Source #
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for 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.
iConnectionId :: Lens' Integration (Maybe Text) Source #
The (@id@ ) of the VpcLink
used for the integration when connectionType=VPC_LINK
and undefined, otherwise.
iRequestParameters :: Lens' Integration (HashMap Text Text) Source #
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) Source #
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) Source #
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
. The valid value is one of the following: * 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) Source #
Specifies Uniform Resource Identifier (URI) of the integration endpoint. * For HTTP
or HTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification , for either standard integration, where connectionType
is not VPC_LINK
, or private integration, where connectionType
is VPC_LINK
. For a private HTTP integration, the URI is not used for routing. * For AWS
or AWS_PROXY
integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}
. Here, {Region}
is the API Gateway region (e.g., us-east-1
); {service}
is the name of the integrated AWS service (e.g., s3
); and {subdomain}
is a designated subdomain supported by certain AWS service for fast host-name lookup. action
can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}...
query string. The ensuing {service_api}
refers to a supported action {name}
plus any required input parameters. Alternatively, path
can be used for an AWS service path-based API. The ensuing service_api
refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject
, the uri
can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
or arn:aws:apigateway:us-west-2:s3:path{bucket}{key}
iIntegrationResponses :: Lens' Integration (HashMap Text IntegrationResponse) Source #
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) Source #
Specifies the integration's cache namespace.
iTimeoutInMillis :: Lens' Integration (Maybe Int) Source #
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
iType :: Lens' Integration (Maybe IntegrationType) Source #
Specifies an API method integration type. The valid value is one of the following: * AWS
: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. * AWS_PROXY
: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration. * HTTP
: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration. * HTTP_PROXY
: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration. * MOCK
: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend. For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https
), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType
of VPC_LINK
is referred to as a private integration and uses a VpcLink
to connect API Gateway to a network load balancer of a VPC.
iConnectionType :: Lens' Integration (Maybe ConnectionType) Source #
The type of the network connection to the integration endpoint. The valid value is INTERNET
for connections through the public routable internet or VPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET
.
iCacheKeyParameters :: Lens' Integration [Text] Source #
Specifies the integration's cache key parameters.