« blib/lib/Paws/ApiGatewayV2/IntegrationParameters.pm
↑ Summary
blib/lib/Paws/ApiGatewayV2/IntegrationResponses.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApiGatewayV2::IntegrationResponse; | ||
| 3 | use Moose; | ||
| 4 | has ContentHandlingStrategy => (is => 'ro', isa => 'Str', request_name => 'contentHandlingStrategy', traits => ['NameInRequest']); | ||
| 5 | has IntegrationResponseId => (is => 'ro', isa => 'Str', request_name => 'integrationResponseId', traits => ['NameInRequest']); | ||
| 6 | has IntegrationResponseKey => (is => 'ro', isa => 'Str', request_name => 'integrationResponseKey', traits => ['NameInRequest'], required => 1); | ||
| 7 | has ResponseParameters => (is => 'ro', isa => 'Paws::ApiGatewayV2::IntegrationParameters', request_name => 'responseParameters', traits => ['NameInRequest']); | ||
| 8 | has ResponseTemplates => (is => 'ro', isa => 'Paws::ApiGatewayV2::TemplateMap', request_name => 'responseTemplates', traits => ['NameInRequest']); | ||
| 9 | has TemplateSelectionExpression => (is => 'ro', isa => 'Str', request_name => 'templateSelectionExpression', traits => ['NameInRequest']); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::ApiGatewayV2::IntegrationResponse | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::ApiGatewayV2::IntegrationResponse object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { ContentHandlingStrategy => $value, ..., TemplateSelectionExpression => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGatewayV2::IntegrationResponse object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->ContentHandlingStrategy | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Represents an integration response. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 ContentHandlingStrategy => Str | ||
| 47 | |||
| 48 | Supported only for WebSocket APIs. Specifies how to handle response | ||
| 49 | payload content type conversions. Supported values are | ||
| 50 | CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: | ||
| 51 | |||
| 52 | CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded | ||
| 53 | string to the corresponding binary blob. | ||
| 54 | |||
| 55 | CONVERT_TO_TEXT: Converts a response payload from a binary blob to a | ||
| 56 | Base64-encoded string. | ||
| 57 | |||
| 58 | If this property is not defined, the response payload will be passed | ||
| 59 | through from the integration response to the route response or method | ||
| 60 | response without modification. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 IntegrationResponseId => Str | ||
| 64 | |||
| 65 | The integration response ID. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> IntegrationResponseKey => Str | ||
| 69 | |||
| 70 | The integration response key. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 ResponseParameters => L<Paws::ApiGatewayV2::IntegrationParameters> | ||
| 74 | |||
| 75 | A key-value map specifying response parameters that are passed to the | ||
| 76 | method response from the backend. The key is a method response header | ||
| 77 | parameter name and the mapped value is an integration response header | ||
| 78 | value, a static value enclosed within a pair of single quotes, or a | ||
| 79 | JSON expression from the integration response body. The mapping key | ||
| 80 | must match the pattern of method.response.header.{name}, where name is | ||
| 81 | a valid and unique header name. The mapped non-static value must match | ||
| 82 | the pattern of integration.response.header.{name} or | ||
| 83 | integration.response.body.{JSON-expression}, where name is a valid and | ||
| 84 | unique response header name and JSON-expression is a valid JSON | ||
| 85 | expression without the $ prefix. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 ResponseTemplates => L<Paws::ApiGatewayV2::TemplateMap> | ||
| 89 | |||
| 90 | The collection of response templates for the integration response as a | ||
| 91 | string-to-string map of key-value pairs. Response templates are | ||
| 92 | represented as a key/value map, with a content-type as the key and a | ||
| 93 | template as the value. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 TemplateSelectionExpression => Str | ||
| 97 | |||
| 98 | The template selection expressions for the integration response. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head1 SEE ALSO | ||
| 103 | |||
| 104 | This class forms part of L<Paws>, describing an object used in L<Paws::ApiGatewayV2> | ||
| 105 | |||
| 106 | =head1 BUGS and CONTRIBUTIONS | ||
| 107 | |||
| 108 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 109 | |||
| 110 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 111 | |||
| 112 | =cut | ||
| 113 |