blib/lib/Paws/ApiGateway/PutIntegration.pm untested

filter: Statementstmt 0.0% 0 / 44 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 46 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::ApiGateway::PutIntegration;
3 use Moose;
4 has CacheKeyParameters => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'cacheKeyParameters');
5 has CacheNamespace => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cacheNamespace');
6 has ConnectionId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'connectionId');
7 has ConnectionType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'connectionType');
8 has ContentHandling => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'contentHandling');
9 has Credentials => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'credentials');
10 has HttpMethod => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'http_method', required => 1);
11 has IntegrationHttpMethod => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'httpMethod');
12 has PassthroughBehavior => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'passthroughBehavior');
13 has RequestParameters => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'requestParameters');
14 has RequestTemplates => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'requestTemplates');
15 has ResourceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'resource_id', required => 1);
16 has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restapi_id', required => 1);
17 has TimeoutInMillis => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'timeoutInMillis');
18 has TlsConfig => (is => 'ro', isa => 'Paws::ApiGateway::TlsConfig', traits => ['NameInRequest'], request_name => 'tlsConfig');
19 has Type => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'type', required => 1);
20 has Uri => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'uri');
21  
22 use MooseX::ClassAttribute;
23  
24 class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutIntegration');
25 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration');
26 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
27 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::Integration');
28 1;
29  
30 ### main pod documentation begin ###
31  
32 =head1 NAME
33  
34 Paws::ApiGateway::PutIntegration - Arguments for method PutIntegration on L<Paws::ApiGateway>
35  
36 =head1 DESCRIPTION
37  
38 This class represents the parameters used for calling the method PutIntegration on the
39 L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class
40 as arguments to method PutIntegration.
41  
42 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutIntegration.
43  
44 =head1 SYNOPSIS
45  
46 my $apigateway = Paws->service('ApiGateway');
47 my $Integration = $apigateway->PutIntegration(
48 HttpMethod => 'MyString',
49 ResourceId => 'MyString',
50 RestApiId => 'MyString',
51 Type => 'HTTP',
52 CacheKeyParameters => [ 'MyString', ... ], # OPTIONAL
53 CacheNamespace => 'MyString', # OPTIONAL
54 ConnectionId => 'MyString', # OPTIONAL
55 ConnectionType => 'INTERNET', # OPTIONAL
56 ContentHandling => 'CONVERT_TO_BINARY', # OPTIONAL
57 Credentials => 'MyString', # OPTIONAL
58 IntegrationHttpMethod => 'MyString', # OPTIONAL
59 PassthroughBehavior => 'MyString', # OPTIONAL
60 RequestParameters => { 'MyString' => 'MyString', }, # OPTIONAL
61 RequestTemplates => { 'MyString' => 'MyString', }, # OPTIONAL
62 TimeoutInMillis => 1, # OPTIONAL
63 TlsConfig => {
64 InsecureSkipVerification => 1, # OPTIONAL
65 }, # OPTIONAL
66 Uri => 'MyString', # OPTIONAL
67 );
68  
69 # Results:
70 my $CacheKeyParameters = $Integration->CacheKeyParameters;
71 my $CacheNamespace = $Integration->CacheNamespace;
72 my $ConnectionId = $Integration->ConnectionId;
73 my $ConnectionType = $Integration->ConnectionType;
74 my $ContentHandling = $Integration->ContentHandling;
75 my $Credentials = $Integration->Credentials;
76 my $HttpMethod = $Integration->HttpMethod;
77 my $IntegrationResponses = $Integration->IntegrationResponses;
78 my $PassthroughBehavior = $Integration->PassthroughBehavior;
79 my $RequestParameters = $Integration->RequestParameters;
80 my $RequestTemplates = $Integration->RequestTemplates;
81 my $TimeoutInMillis = $Integration->TimeoutInMillis;
82 my $TlsConfig = $Integration->TlsConfig;
83 my $Type = $Integration->Type;
84 my $Uri = $Integration->Uri;
85  
86 # Returns a L<Paws::ApiGateway::Integration> object.
87  
88 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.
89 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/PutIntegration>
90  
91 =head1 ATTRIBUTES
92  
93  
94 =head2 CacheKeyParameters => ArrayRef[Str|Undef]
95  
96 A list of request parameters whose values API Gateway caches. To be
97 valid values for C<cacheKeyParameters>, these parameters must also be
98 specified for Method C<requestParameters>.
99  
100  
101  
102 =head2 CacheNamespace => Str
103  
104 Specifies a group of related cached parameters. By default, API Gateway
105 uses the resource ID as the C<cacheNamespace>. You can specify the same
106 C<cacheNamespace> across resources to return the same cached data for
107 requests to different resources.
108  
109  
110  
111 =head2 ConnectionId => Str
112  
113 The (C<id>
114 (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id))
115 of the VpcLink used for the integration when C<connectionType=VPC_LINK>
116 and undefined, otherwise.
117  
118  
119  
120 =head2 ConnectionType => Str
121  
122 The type of the network connection to the integration endpoint. The
123 valid value is C<INTERNET> for connections through the public routable
124 internet or C<VPC_LINK> for private connections between API Gateway and
125 a network load balancer in a VPC. The default value is C<INTERNET>.
126  
127 Valid values are: C<"INTERNET">, C<"VPC_LINK">
128  
129 =head2 ContentHandling => Str
130  
131 Specifies how to handle request payload content type conversions.
132 Supported values are C<CONVERT_TO_BINARY> and C<CONVERT_TO_TEXT>, with
133 the following behaviors:
134  
135 =over
136  
137 =item *
138  
139 C<CONVERT_TO_BINARY>: Converts a request payload from a Base64-encoded
140 string to the corresponding binary blob.
141  
142 =item *
143  
144 C<CONVERT_TO_TEXT>: Converts a request payload from a binary blob to a
145 Base64-encoded string.
146  
147 =back
148  
149 If this property is not defined, the request payload will be passed
150 through from the method request to integration request without
151 modification, provided that the C<passthroughBehavior> is configured to
152 support payload pass-through.
153  
154 Valid values are: C<"CONVERT_TO_BINARY">, C<"CONVERT_TO_TEXT">
155  
156 =head2 Credentials => Str
157  
158 Specifies whether credentials are required for a put integration.
159  
160  
161  
162 =head2 B<REQUIRED> HttpMethod => Str
163  
164 [Required] Specifies a put integration request's HTTP method.
165  
166  
167  
168 =head2 IntegrationHttpMethod => Str
169  
170 Specifies a put integration HTTP method. When the integration type is
171 HTTP or AWS, this field is required.
172  
173  
174  
175 =head2 PassthroughBehavior => Str
176  
177 Specifies the pass-through behavior for incoming requests based on the
178 Content-Type header in the request, and the available mapping templates
179 specified as the C<requestTemplates> property on the Integration
180 resource. There are three valid values: C<WHEN_NO_MATCH>,
181 C<WHEN_NO_TEMPLATES>, and C<NEVER>.
182  
183 =over
184  
185 =item *
186  
187 C<WHEN_NO_MATCH> passes the request body for unmapped content types
188 through to the integration back end without transformation.
189  
190 =item *
191  
192 C<NEVER> rejects unmapped content types with an HTTP 415 'Unsupported
193 Media Type' response.
194  
195 =item *
196  
197 C<WHEN_NO_TEMPLATES> allows pass-through when the integration has NO
198 content types mapped to templates. However if there is at least one
199 content type defined, unmapped content types will be rejected with the
200 same 415 response.
201  
202 =back
203  
204  
205  
206  
207 =head2 RequestParameters => L<Paws::ApiGateway::MapOfStringToString>
208  
209 A key-value map specifying request parameters that are passed from the
210 method request to the back end. The key is an integration request
211 parameter name and the associated value is a method request parameter
212 value or static value that must be enclosed within single quotes and
213 pre-encoded as required by the back end. The method request parameter
214 value must match the pattern of C<method.request.{location}.{name}>,
215 where C<location> is C<querystring>, C<path>, or C<header> and C<name>
216 must be a valid and unique method request parameter name.
217  
218  
219  
220 =head2 RequestTemplates => L<Paws::ApiGateway::MapOfStringToString>
221  
222 Represents a map of Velocity templates that are applied on the request
223 payload based on the value of the Content-Type header sent by the
224 client. The content type value is the key in this map, and the template
225 (as a String) is the value.
226  
227  
228  
229 =head2 B<REQUIRED> ResourceId => Str
230  
231 [Required] Specifies a put integration request's resource ID.
232  
233  
234  
235 =head2 B<REQUIRED> RestApiId => Str
236  
237 [Required] The string identifier of the associated RestApi.
238  
239  
240  
241 =head2 TimeoutInMillis => Int
242  
243 Custom timeout between 50 and 29,000 milliseconds. The default value is
244 29,000 milliseconds or 29 seconds.
245  
246  
247  
248 =head2 TlsConfig => L<Paws::ApiGateway::TlsConfig>
249  
250  
251  
252  
253  
254 =head2 B<REQUIRED> Type => Str
255  
256 [Required] Specifies a put integration input's type.
257  
258 Valid values are: C<"HTTP">, C<"AWS">, C<"MOCK">, C<"HTTP_PROXY">, C<"AWS_PROXY">
259  
260 =head2 Uri => Str
261  
262 Specifies Uniform Resource Identifier (URI) of the integration
263 endpoint.
264  
265 =over
266  
267 =item *
268  
269 For C<HTTP> or C<HTTP_PROXY> integrations, the URI must be a fully
270 formed, encoded HTTP(S) URL according to the RFC-3986 specification
271 (https://en.wikipedia.org/wiki/Uniform_Resource_Identifier), for either
272 standard integration, where C<connectionType> is not C<VPC_LINK>, or
273 private integration, where C<connectionType> is C<VPC_LINK>. For a
274 private HTTP integration, the URI is not used for routing.
275  
276 =item *
277  
278 For C<AWS> or C<AWS_PROXY> integrations, the URI is of the form
279 C<arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}>.
280 Here, C<{Region}> is the API Gateway region (e.g., C<us-east-1>);
281 C<{service}> is the name of the integrated AWS service (e.g., C<s3>);
282 and C<{subdomain}> is a designated subdomain supported by certain AWS
283 service for fast host-name lookup. C<action> can be used for an AWS
284 service action-based API, using an
285 C<Action={name}&{p1}={v1}&p2={v2}...> query string. The ensuing
286 C<{service_api}> refers to a supported action C<{name}> plus any
287 required input parameters. Alternatively, C<path> can be used for an
288 AWS service path-based API. The ensuing C<service_api> refers to the
289 path to an AWS service resource, including the region of the integrated
290 AWS service, if applicable. For example, for integration with the S3
291 API of C<GetObject
292 (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html)>,
293 the C<uri> can be either
294 C<arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}>
295 or C<arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}>
296  
297 =back
298  
299  
300  
301  
302  
303 =head1 SEE ALSO
304  
305 This class forms part of L<Paws>, documenting arguments for method PutIntegration in L<Paws::ApiGateway>
306  
307 =head1 BUGS and CONTRIBUTIONS
308  
309 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
310  
311 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
312  
313 =cut
314