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