NAME

Paws::ApiGatewayV2::CreateIntegrationResponse - Arguments for method CreateIntegrationResponse on Paws::ApiGatewayV2

DESCRIPTION

This class represents the parameters used for calling the method CreateIntegrationResponse on the AmazonApiGatewayV2 service. Use the attributes of this class as arguments to method CreateIntegrationResponse.

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

SYNOPSIS

    my $apigateway = Paws->service('ApiGatewayV2');
    my $CreateIntegrationResponseResponse =
      $apigateway->CreateIntegrationResponse(
      ApiId                   => 'My__string',
      IntegrationId           => 'My__string',
      IntegrationResponseKey  => 'MySelectionKey',
      ContentHandlingStrategy => 'CONVERT_TO_BINARY',    # OPTIONAL
      ResponseParameters =>
        { 'My__string' => 'MyStringWithLengthBetween1And512', },    # OPTIONAL
      ResponseTemplates =>
        { 'My__string' => 'MyStringWithLengthBetween0And32K', },    # OPTIONAL
      TemplateSelectionExpression => 'MySelectionExpression',       # OPTIONAL
      );

    # Results:
    my $ContentHandlingStrategy =
      $CreateIntegrationResponseResponse->ContentHandlingStrategy;
    my $IntegrationResponseId =
      $CreateIntegrationResponseResponse->IntegrationResponseId;
    my $IntegrationResponseKey =
      $CreateIntegrationResponseResponse->IntegrationResponseKey;
    my $ResponseParameters =
      $CreateIntegrationResponseResponse->ResponseParameters;
    my $ResponseTemplates =
      $CreateIntegrationResponseResponse->ResponseTemplates;
    my $TemplateSelectionExpression =
      $CreateIntegrationResponseResponse->TemplateSelectionExpression;

    # Returns a L<Paws::ApiGatewayV2::CreateIntegrationResponseResponse> 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 https://docs.aws.amazon.com/goto/WebAPI/apigateway/CreateIntegrationResponse

ATTRIBUTES

REQUIRED ApiId => Str

The API identifier.

ContentHandlingStrategy => Str

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Valid values are: "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"

REQUIRED IntegrationId => Str

The integration ID.

REQUIRED IntegrationResponseKey => Str

The integration response key.

ResponseParameters => Paws::ApiGatewayV2::IntegrationParameters

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

ResponseTemplates => Paws::ApiGatewayV2::TemplateMap

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

TemplateSelectionExpression => Str

The template selection expression for the integration response.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateIntegrationResponse in Paws::ApiGatewayV2

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws::SDK::Config

perl -MCPAN -e shell
install Paws::SDK::Config