File Coverage

blib/lib/Paws/ApiGateway/PutIntegration.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::ApiGateway::PutIntegration;
3 1     1   614 use Moose;
  1         2  
  1         8  
4             has CacheKeyParameters => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             has CacheNamespace => (is => 'ro', isa => 'Str');
6             has ContentHandling => (is => 'ro', isa => 'Str');
7             has Credentials => (is => 'ro', isa => 'Str');
8             has HttpMethod => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'httpMethod' , required => 1);
9             has IntegrationHttpMethod => (is => 'ro', isa => 'Str');
10             has PassthroughBehavior => (is => 'ro', isa => 'Str');
11             has RequestParameters => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString');
12             has RequestTemplates => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString');
13             has ResourceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'resourceId' , required => 1);
14             has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restApiId' , required => 1);
15             has Type => (is => 'ro', isa => 'Str', required => 1);
16             has Uri => (is => 'ro', isa => 'Str');
17              
18 1     1   7104 use MooseX::ClassAttribute;
  1         5  
  1         12  
19              
20             class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutIntegration');
21             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration');
22             class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
23             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::Integration');
24             class_has _result_key => (isa => 'Str', is => 'ro');
25             1;
26              
27             ### main pod documentation begin ###
28              
29             =head1 NAME
30              
31             Paws::ApiGateway::PutIntegration - Arguments for method PutIntegration on Paws::ApiGateway
32              
33             =head1 DESCRIPTION
34              
35             This class represents the parameters used for calling the method PutIntegration on the
36             Amazon API Gateway service. Use the attributes of this class
37             as arguments to method PutIntegration.
38              
39             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutIntegration.
40              
41             As an example:
42              
43             $service_obj->PutIntegration(Att1 => $value1, Att2 => $value2, ...);
44              
45             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.
46              
47             =head1 ATTRIBUTES
48              
49              
50             =head2 CacheKeyParameters => ArrayRef[Str|Undef]
51              
52             Specifies a put integration input's cache key parameters.
53              
54              
55              
56             =head2 CacheNamespace => Str
57              
58             Specifies a put integration input's cache namespace.
59              
60              
61              
62             =head2 ContentHandling => Str
63              
64             Specifies how to handle request payload content type conversions.
65             Supported values are C<CONVERT_TO_BINARY> and C<CONVERT_TO_TEXT>, with
66             the following behaviors:
67              
68             =over
69              
70             =item *
71              
72             C<CONVERT_TO_BINARY>: Converts a request payload from a Base64-encoded
73             string to the corresponding binary blob.
74              
75             =item *
76              
77             C<CONVERT_TO_TEXT>: Converts a request payload from a binary blob to a
78             Base64-encoded string.
79              
80             =back
81              
82             If this property is not defined, the request payload will be passed
83             through from the method request to integration request without
84             modification, provided that the C<passthroughBehaviors> is configured
85             to support payload pass-through.
86              
87             Valid values are: C<"CONVERT_TO_BINARY">, C<"CONVERT_TO_TEXT">
88              
89             =head2 Credentials => Str
90              
91             Specifies whether credentials are required for a put integration.
92              
93              
94              
95             =head2 B<REQUIRED> HttpMethod => Str
96              
97             Specifies a put integration request's HTTP method.
98              
99              
100              
101             =head2 IntegrationHttpMethod => Str
102              
103             Specifies a put integration HTTP method. When the integration type is
104             HTTP or AWS, this field is required.
105              
106              
107              
108             =head2 PassthroughBehavior => Str
109              
110             Specifies the pass-through behavior for incoming requests based on the
111             Content-Type header in the request, and the available mapping templates
112             specified as the C<requestTemplates> property on the Integration
113             resource. There are three valid values: C<WHEN_NO_MATCH>,
114             C<WHEN_NO_TEMPLATES>, and C<NEVER>.
115              
116             =over
117              
118             =item *
119              
120             C<WHEN_NO_MATCH> passes the request body for unmapped content types
121             through to the integration back end without transformation.
122              
123             =item *
124              
125             C<NEVER> rejects unmapped content types with an HTTP 415 'Unsupported
126             Media Type' response.
127              
128             =item *
129              
130             C<WHEN_NO_TEMPLATES> allows pass-through when the integration has NO
131             content types mapped to templates. However if there is at least one
132             content type defined, unmapped content types will be rejected with the
133             same 415 response.
134              
135             =back
136              
137              
138              
139              
140             =head2 RequestParameters => L<Paws::ApiGateway::MapOfStringToString>
141              
142             A key-value map specifying request parameters that are passed from the
143             method request to the back end. The key is an integration request
144             parameter name and the associated value is a method request parameter
145             value or static value that must be enclosed within single quotes and
146             pre-encoded as required by the back end. The method request parameter
147             value must match the pattern of C<method.request.{location}.{name}>,
148             where C<location> is C<querystring>, C<path>, or C<header> and C<name>
149             must be a valid and unique method request parameter name.
150              
151              
152              
153             =head2 RequestTemplates => L<Paws::ApiGateway::MapOfStringToString>
154              
155             Represents a map of Velocity templates that are applied on the request
156             payload based on the value of the Content-Type header sent by the
157             client. The content type value is the key in this map, and the template
158             (as a String) is the value.
159              
160              
161              
162             =head2 B<REQUIRED> ResourceId => Str
163              
164             Specifies a put integration request's resource ID.
165              
166              
167              
168             =head2 B<REQUIRED> RestApiId => Str
169              
170             The string identifier of the associated RestApi.
171              
172              
173              
174             =head2 B<REQUIRED> Type => Str
175              
176             Specifies a put integration input's type.
177              
178             Valid values are: C<"HTTP">, C<"AWS">, C<"MOCK">, C<"HTTP_PROXY">, C<"AWS_PROXY">
179              
180             =head2 Uri => Str
181              
182             Specifies the integration's Uniform Resource Identifier (URI). For HTTP
183             integrations, the URI must be a fully formed, encoded HTTP(S) URL
184             according to the RFC-3986 specification. For AWS integrations, the URI
185             should be of the form
186             C<arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}>.
187             C<Region>, C<subdomain> and C<service> are used to determine the right
188             endpoint. For AWS services that use the C<Action=> query string
189             parameter, C<service_api> should be a valid action for the desired
190             service. For RESTful AWS service APIs, C<path> is used to indicate that
191             the remaining substring in the URI should be treated as the path to the
192             resource, including the initial C</>.
193              
194              
195              
196              
197             =head1 SEE ALSO
198              
199             This class forms part of L<Paws>, documenting arguments for method PutIntegration in L<Paws::ApiGateway>
200              
201             =head1 BUGS and CONTRIBUTIONS
202              
203             The source code is located here: https://github.com/pplu/aws-sdk-perl
204              
205             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
206              
207             =cut
208