| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.APIGateway.UpdateIntegration
Description
Represents an update integration.
Synopsis
- data UpdateIntegration = UpdateIntegration' {
- patchOperations :: Maybe [PatchOperation]
- restApiId :: Text
- resourceId :: Text
- httpMethod :: Text
- newUpdateIntegration :: Text -> Text -> Text -> UpdateIntegration
- updateIntegration_patchOperations :: Lens' UpdateIntegration (Maybe [PatchOperation])
- updateIntegration_restApiId :: Lens' UpdateIntegration Text
- updateIntegration_resourceId :: Lens' UpdateIntegration Text
- updateIntegration_httpMethod :: Lens' UpdateIntegration Text
- data Integration = Integration' {
- cacheKeyParameters :: Maybe [Text]
- cacheNamespace :: Maybe Text
- connectionId :: Maybe Text
- connectionType :: Maybe ConnectionType
- contentHandling :: Maybe ContentHandlingStrategy
- credentials :: Maybe Text
- httpMethod :: Maybe Text
- integrationResponses :: Maybe (HashMap Text IntegrationResponse)
- passthroughBehavior :: Maybe Text
- requestParameters :: Maybe (HashMap Text Text)
- requestTemplates :: Maybe (HashMap Text Text)
- timeoutInMillis :: Maybe Int
- tlsConfig :: Maybe TlsConfig
- type' :: Maybe IntegrationType
- uri :: Maybe Text
- newIntegration :: Integration
- integration_cacheKeyParameters :: Lens' Integration (Maybe [Text])
- integration_cacheNamespace :: Lens' Integration (Maybe Text)
- integration_connectionId :: Lens' Integration (Maybe Text)
- integration_connectionType :: Lens' Integration (Maybe ConnectionType)
- integration_contentHandling :: Lens' Integration (Maybe ContentHandlingStrategy)
- integration_credentials :: Lens' Integration (Maybe Text)
- integration_httpMethod :: Lens' Integration (Maybe Text)
- integration_integrationResponses :: Lens' Integration (Maybe (HashMap Text IntegrationResponse))
- integration_passthroughBehavior :: Lens' Integration (Maybe Text)
- integration_requestParameters :: Lens' Integration (Maybe (HashMap Text Text))
- integration_requestTemplates :: Lens' Integration (Maybe (HashMap Text Text))
- integration_timeoutInMillis :: Lens' Integration (Maybe Int)
- integration_tlsConfig :: Lens' Integration (Maybe TlsConfig)
- integration_type :: Lens' Integration (Maybe IntegrationType)
- integration_uri :: Lens' Integration (Maybe Text)
Creating a Request
data UpdateIntegration Source #
Represents an update integration request.
See: newUpdateIntegration smart constructor.
Constructors
| UpdateIntegration' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UpdateIntegration |
Create a value of UpdateIntegration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:patchOperations:UpdateIntegration', updateIntegration_patchOperations - For more information about supported patch operations, see
Patch Operations.
UpdateIntegration, updateIntegration_restApiId - The string identifier of the associated RestApi.
$sel:resourceId:UpdateIntegration', updateIntegration_resourceId - Represents an update integration request's resource identifier.
UpdateIntegration, updateIntegration_httpMethod - Represents an update integration request's HTTP method.
Request Lenses
updateIntegration_patchOperations :: Lens' UpdateIntegration (Maybe [PatchOperation]) Source #
For more information about supported patch operations, see Patch Operations.
updateIntegration_restApiId :: Lens' UpdateIntegration Text Source #
The string identifier of the associated RestApi.
updateIntegration_resourceId :: Lens' UpdateIntegration Text Source #
Represents an update integration request's resource identifier.
updateIntegration_httpMethod :: Lens' UpdateIntegration Text Source #
Represents an update integration request's HTTP method.
Destructuring the Response
data Integration Source #
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
See: newIntegration smart constructor.
Constructors
| Integration' | |
Fields
| |
Instances
newIntegration :: Integration Source #
Create a value of Integration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cacheKeyParameters:Integration', integration_cacheKeyParameters - A list of request parameters whose values API Gateway caches. To be
valid values for cacheKeyParameters, these parameters must also be
specified for Method requestParameters.
$sel:cacheNamespace:Integration', integration_cacheNamespace - Specifies a group of related cached parameters. By default, API Gateway
uses the resource ID as the cacheNamespace. You can specify the same
cacheNamespace across resources to return the same cached data for
requests to different resources.
$sel:connectionId:Integration', integration_connectionId - The ID of the VpcLink used for the integration when
connectionType=VPC_LINK and undefined, otherwise.
$sel:connectionType:Integration', integration_connectionType - 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.
Integration, integration_contentHandling - Specifies how to handle request payload content type conversions.
Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
following behaviors:
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 passthroughBehavior is configured to
support payload pass-through.
$sel:credentials:Integration', integration_credentials - 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.
$sel:httpMethod:Integration', integration_httpMethod - Specifies the integration's HTTP method type.
$sel:integrationResponses:Integration', integration_integrationResponses - Specifies the integration's responses.
$sel:passthroughBehavior:Integration', integration_passthroughBehavior - 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.
$sel:requestParameters:Integration', integration_requestParameters - 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.
$sel:requestTemplates:Integration', integration_requestTemplates - 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.
$sel:timeoutInMillis:Integration', integration_timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds. The default value is
29,000 milliseconds or 29 seconds.
$sel:tlsConfig:Integration', integration_tlsConfig - Specifies the TLS configuration for an integration.
$sel:type':Integration', integration_type - Specifies an API method integration type. The valid value is one of the
following:
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.
$sel:uri:Integration', integration_uri - 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 Amazon Web Services service (e.g., s3); and
{subdomain} is a designated subdomain supported by certain Amazon Web
Services service for fast host-name lookup. action can be used for an
Amazon Web Services 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 Amazon
Web Services service resource, including the region of the integrated
Amazon Web Services 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}
Response Lenses
integration_cacheKeyParameters :: Lens' Integration (Maybe [Text]) Source #
A list of request parameters whose values API Gateway caches. To be
valid values for cacheKeyParameters, these parameters must also be
specified for Method requestParameters.
integration_cacheNamespace :: Lens' Integration (Maybe Text) Source #
Specifies a group of related cached parameters. By default, API Gateway
uses the resource ID as the cacheNamespace. You can specify the same
cacheNamespace across resources to return the same cached data for
requests to different resources.
integration_connectionId :: Lens' Integration (Maybe Text) Source #
The ID of the VpcLink used for the integration when
connectionType=VPC_LINK and undefined, otherwise.
integration_connectionType :: 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.
integration_contentHandling :: 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:
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 passthroughBehavior is configured to
support payload pass-through.
integration_credentials :: 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.
integration_httpMethod :: Lens' Integration (Maybe Text) Source #
Specifies the integration's HTTP method type.
integration_integrationResponses :: Lens' Integration (Maybe (HashMap Text IntegrationResponse)) Source #
Specifies the integration's responses.
integration_passthroughBehavior :: 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.
integration_requestParameters :: Lens' Integration (Maybe (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.
integration_requestTemplates :: Lens' Integration (Maybe (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.
integration_timeoutInMillis :: Lens' Integration (Maybe Int) Source #
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
integration_tlsConfig :: Lens' Integration (Maybe TlsConfig) Source #
Specifies the TLS configuration for an integration.
integration_type :: Lens' Integration (Maybe IntegrationType) Source #
Specifies an API method integration type. The valid value is one of the following:
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.
integration_uri :: 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 Amazon Web Services service (e.g., s3); and
{subdomain} is a designated subdomain supported by certain Amazon Web
Services service for fast host-name lookup. action can be used for an
Amazon Web Services 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 Amazon
Web Services service resource, including the region of the integrated
Amazon Web Services 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}