Paws::ApiGateway::PutIntegration - Arguments for method PutIntegration on Paws::ApiGateway


This class represents the parameters used for calling the method PutIntegration on the Amazon API Gateway service. Use the attributes of this class as arguments to method PutIntegration.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutIntegration.


    my $apigateway = Paws->service('ApiGateway');
    my $Integration = $apigateway->PutIntegration(
      HttpMethod            => 'MyString',
      ResourceId            => 'MyString',
      RestApiId             => 'MyString',
      Type                  => 'HTTP',
      CacheKeyParameters    => [ 'MyString', ... ],              # OPTIONAL
      CacheNamespace        => 'MyString',                       # OPTIONAL
      ConnectionId          => 'MyString',                       # OPTIONAL
      ConnectionType        => 'INTERNET',                       # OPTIONAL
      ContentHandling       => 'CONVERT_TO_BINARY',              # OPTIONAL
      Credentials           => 'MyString',                       # OPTIONAL
      IntegrationHttpMethod => 'MyString',                       # OPTIONAL
      PassthroughBehavior   => 'MyString',                       # OPTIONAL
      RequestParameters     => { 'MyString' => 'MyString', },    # OPTIONAL
      RequestTemplates      => { 'MyString' => 'MyString', },    # OPTIONAL
      TimeoutInMillis       => 1,                                # OPTIONAL
      Uri                   => 'MyString',                       # OPTIONAL

    # Results:
    my $CacheKeyParameters   = $Integration->CacheKeyParameters;
    my $CacheNamespace       = $Integration->CacheNamespace;
    my $ConnectionId         = $Integration->ConnectionId;
    my $ConnectionType       = $Integration->ConnectionType;
    my $ContentHandling      = $Integration->ContentHandling;
    my $Credentials          = $Integration->Credentials;
    my $HttpMethod           = $Integration->HttpMethod;
    my $IntegrationResponses = $Integration->IntegrationResponses;
    my $PassthroughBehavior  = $Integration->PassthroughBehavior;
    my $RequestParameters    = $Integration->RequestParameters;
    my $RequestTemplates     = $Integration->RequestTemplates;
    my $TimeoutInMillis      = $Integration->TimeoutInMillis;
    my $Type                 = $Integration->Type;
    my $Uri                  = $Integration->Uri;

    # Returns a L<Paws::ApiGateway::Integration> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see


CacheKeyParameters => ArrayRef[Str|Undef]

An API-specific tag group of related cached parameters.

CacheNamespace => Str

A list of request parameters whose values are to be cached.

ConnectionId => Str

The (id ( of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

ConnectionType => Str

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.

Valid values are: "INTERNET", "VPC_LINK"

ContentHandling => Str

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 passthroughBehavior is configured to support payload pass-through.


Credentials => Str

Specifies whether credentials are required for a put integration.

REQUIRED HttpMethod => Str

[Required] Specifies a put integration request's HTTP method.

IntegrationHttpMethod => Str

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

PassthroughBehavior => Str

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.

RequestParameters => Paws::ApiGateway::MapOfStringToString

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.

RequestTemplates => Paws::ApiGateway::MapOfStringToString

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.

REQUIRED ResourceId => Str

[Required] Specifies a put integration request's resource ID.

REQUIRED RestApiId => Str

[Required] The string identifier of the associated RestApi.

TimeoutInMillis => Int

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

REQUIRED Type => Str

[Required] Specifies a put integration input's type.

Valid values are: "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"

Uri => Str

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}


This class forms part of Paws, documenting arguments for method PutIntegration in Paws::ApiGateway


The source code is located here:

Please report bugs to: