putIntegration method
- required String httpMethod,
- required String resourceId,
- required String restApiId,
- required IntegrationType type,
- List<
String> ? cacheKeyParameters, - String? cacheNamespace,
- String? connectionId,
- ConnectionType? connectionType,
- ContentHandlingStrategy? contentHandling,
- String? credentials,
- String? integrationHttpMethod,
- String? passthroughBehavior,
- Map<
String, String> ? requestParameters, - Map<
String, String> ? requestTemplates, - int? timeoutInMillis,
- TlsConfig? tlsConfig,
- String? uri,
Sets up a method's integration.
May throw UnauthorizedException. May throw BadRequestException. May throw ConflictException. May throw NotFoundException. May throw TooManyRequestsException.
Parameter httpMethod
:
Required
Specifies a put integration request's HTTP method.
Parameter resourceId
:
Required
Specifies a put integration request's resource ID.
Parameter restApiId
:
Required
The string identifier of the associated RestApi.
Parameter type
:
Required
Specifies a put integration input's type.
Parameter 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
.
Parameter 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.
Parameter connectionId
:
The (id
)
of the VpcLink used for the integration when
connectionType=VPC_LINK
and undefined, otherwise.
Parameter 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
.
Parameter contentHandling
:
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.
passthroughBehavior
is
configured to support payload pass-through.
Parameter credentials
:
Specifies whether credentials are required for a put integration.
Parameter integrationHttpMethod
:
Specifies a put integration HTTP method. When the integration type is HTTP
or AWS, this field is required.
Parameter passthroughBehavior
:
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.
Parameter 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.
Parameter 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.
Parameter timeoutInMillis
:
Custom timeout between 50 and 29,000 milliseconds. The default value is
29,000 milliseconds or 29 seconds.
Parameter uri
:
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
-
For
HTTP
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. -
For
AWS
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}
Implementation
Future<Integration> putIntegration({
required String httpMethod,
required String resourceId,
required String restApiId,
required IntegrationType type,
List<String>? cacheKeyParameters,
String? cacheNamespace,
String? connectionId,
ConnectionType? connectionType,
ContentHandlingStrategy? contentHandling,
String? credentials,
String? integrationHttpMethod,
String? passthroughBehavior,
Map<String, String>? requestParameters,
Map<String, String>? requestTemplates,
int? timeoutInMillis,
TlsConfig? tlsConfig,
String? uri,
}) async {
ArgumentError.checkNotNull(httpMethod, 'httpMethod');
ArgumentError.checkNotNull(resourceId, 'resourceId');
ArgumentError.checkNotNull(restApiId, 'restApiId');
ArgumentError.checkNotNull(type, 'type');
final $payload = <String, dynamic>{
'type': type.toValue(),
if (cacheKeyParameters != null) 'cacheKeyParameters': cacheKeyParameters,
if (cacheNamespace != null) 'cacheNamespace': cacheNamespace,
if (connectionId != null) 'connectionId': connectionId,
if (connectionType != null) 'connectionType': connectionType.toValue(),
if (contentHandling != null) 'contentHandling': contentHandling.toValue(),
if (credentials != null) 'credentials': credentials,
if (integrationHttpMethod != null) 'httpMethod': integrationHttpMethod,
if (passthroughBehavior != null)
'passthroughBehavior': passthroughBehavior,
if (requestParameters != null) 'requestParameters': requestParameters,
if (requestTemplates != null) 'requestTemplates': requestTemplates,
if (timeoutInMillis != null) 'timeoutInMillis': timeoutInMillis,
if (tlsConfig != null) 'tlsConfig': tlsConfig,
if (uri != null) 'uri': uri,
};
final response = await _protocol.send(
payload: $payload,
method: 'PUT',
requestUri:
'/restapis/${Uri.encodeComponent(restApiId)}/resources/${Uri.encodeComponent(resourceId)}/methods/${Uri.encodeComponent(httpMethod)}/integration',
exceptionFnMap: _exceptionFns,
);
return Integration.fromJson(response);
}