File Coverage

blib/lib/Paws/ApiGateway/IntegrationResponse.pm

Criterion	Covered	Total	%
statement	3	3	100.0
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	4	4	100.0

line	stmt	sub	time	code
1
2				package Paws::ApiGateway::IntegrationResponse;
3	1	1	414	use Moose;
	1		2
	1		6
4				has ContentHandling => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'contentHandling');
5				has ResponseParameters => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'responseParameters');
6				has ResponseTemplates => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'responseTemplates');
7				has SelectionPattern => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'selectionPattern');
8				has StatusCode => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'statusCode');
9
10				has _request_id => (is => 'ro', isa => 'Str');
11				1;
12
13				### main pod documentation begin ###
14
15				=head1 NAME
16
17				Paws::ApiGateway::IntegrationResponse
18
19				=head1 ATTRIBUTES
20
21
22				=head2 ContentHandling => Str
23
24				Specifies how to handle response payload content type conversions.
25				Supported values are C<CONVERT_TO_BINARY> and C<CONVERT_TO_TEXT>, with
26				the following behaviors:
27
28				=over
29
30				=item *
31
32				C<CONVERT_TO_BINARY>: Converts a response payload from a Base64-encoded
33				string to the corresponding binary blob.
34
35				=item *
36
37				C<CONVERT_TO_TEXT>: Converts a response payload from a binary blob to a
38				Base64-encoded string.
39
40				=back
41
42				If this property is not defined, the response payload will be passed
43				through from the integration response to the method response without
44				modification.
45
46				Valid values are: C<"CONVERT_TO_BINARY">, C<"CONVERT_TO_TEXT">
47				=head2 ResponseParameters => L<Paws::ApiGateway::MapOfStringToString>
48
49				A key-value map specifying response parameters that are passed to the
50				method response from the back end. The key is a method response header
51				parameter name and the mapped value is an integration response header
52				value, a static value enclosed within a pair of single quotes, or a
53				JSON expression from the integration response body. The mapping key
54				must match the pattern of C<method.response.header.{name}>, where
55				C<name> is a valid and unique header name. The mapped non-static value
56				must match the pattern of C<integration.response.header.{name}> or
57				C<integration.response.body.{JSON-expression}>, where C<name> is a
58				valid and unique response header name and C<JSON-expression> is a valid
59				JSON expression without the C<$> prefix.
60
61
62				=head2 ResponseTemplates => L<Paws::ApiGateway::MapOfStringToString>
63
64				Specifies the templates used to transform the integration response
65				body. Response templates are represented as a key/value map, with a
66				content-type as the key and a template as the value.
67
68
69				=head2 SelectionPattern => Str
70
71				Specifies the regular expression (regex) pattern used to choose an
72				integration response based on the response from the back end. For
73				example, if the success response returns nothing and the error response
74				returns some string, you could use the C<.+> regex to match error
75				response. However, make sure that the error response does not contain
76				any newline (C<\n>) character in such cases. If the back end is an AWS
77				Lambda function, the AWS Lambda function error header is matched. For
78				all other HTTP and AWS back ends, the HTTP status code is matched.
79
80
81				=head2 StatusCode => Str
82
83				Specifies the status code that is used to map the integration response
84				to an existing MethodResponse.
85
86
87				=head2 _request_id => Str
88
89
90				=cut
91