GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::ApiGateway::PutIntegrationResponse(3) User Contributed Perl Documentation Paws::ApiGateway::PutIntegrationResponse(3)

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

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

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

    my $apigateway = Paws->service('ApiGateway');
    my $IntegrationResponse = $apigateway->PutIntegrationResponse(
      HttpMethod         => 'MyString',
      ResourceId         => 'MyString',
      RestApiId          => 'MyString',
      StatusCode         => 'MyStatusCode',
      ContentHandling    => 'CONVERT_TO_BINARY',              # OPTIONAL
      ResponseParameters => { 'MyString' => 'MyString', },    # OPTIONAL
      ResponseTemplates  => { 'MyString' => 'MyString', },    # OPTIONAL
      SelectionPattern   => 'MyString',                       # OPTIONAL
    );
    # Results:
    my $ContentHandling    = $IntegrationResponse->ContentHandling;
    my $ResponseParameters = $IntegrationResponse->ResponseParameters;
    my $ResponseTemplates  = $IntegrationResponse->ResponseTemplates;
    my $SelectionPattern   = $IntegrationResponse->SelectionPattern;
    my $StatusCode         = $IntegrationResponse->StatusCode;
    # Returns a L<Paws::ApiGateway::IntegrationResponse> 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/PutIntegrationResponse>

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 method response without modification.

Valid values are: "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"

REQUIRED HttpMethod => Str

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

REQUIRED ResourceId => Str

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

A key-value map specifying response parameters that are passed to the method response from the back end. 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" must be a valid and unique response header name and "JSON-expression" a valid JSON expression without the "$" prefix.

Specifies a put integration response's templates.

REQUIRED RestApiId => Str

[Required] The string identifier of the associated RestApi.

Specifies the selection pattern of a put integration response.

REQUIRED StatusCode => Str

[Required] Specifies the status code that is used to map the integration response to an existing MethodResponse.

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

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>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.