blib/lib/Paws/ApiGatewayV2/UpdateIntegration.pm untested

filter: Statementstmt 0.0% 0 / 48 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 50 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::ApiGatewayV2::UpdateIntegration;
3 use Moose;
4 has ApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'apiId', required => 1);
5 has ConnectionId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'connectionId');
6 has ConnectionType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'connectionType');
7 has ContentHandlingStrategy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'contentHandlingStrategy');
8 has CredentialsArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'credentialsArn');
9 has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description');
10 has IntegrationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'integrationId', required => 1);
11 has IntegrationMethod => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'integrationMethod');
12 has IntegrationSubtype => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'integrationSubtype');
13 has IntegrationType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'integrationType');
14 has IntegrationUri => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'integrationUri');
15 has PassthroughBehavior => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'passthroughBehavior');
16 has PayloadFormatVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'payloadFormatVersion');
17 has RequestParameters => (is => 'ro', isa => 'Paws::ApiGatewayV2::IntegrationParameters', traits => ['NameInRequest'], request_name => 'requestParameters');
18 has RequestTemplates => (is => 'ro', isa => 'Paws::ApiGatewayV2::TemplateMap', traits => ['NameInRequest'], request_name => 'requestTemplates');
19 has ResponseParameters => (is => 'ro', isa => 'Paws::ApiGatewayV2::ResponseParameters', traits => ['NameInRequest'], request_name => 'responseParameters');
20 has TemplateSelectionExpression => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'templateSelectionExpression');
21 has TimeoutInMillis => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'timeoutInMillis');
22 has TlsConfig => (is => 'ro', isa => 'Paws::ApiGatewayV2::TlsConfigInput', traits => ['NameInRequest'], request_name => 'tlsConfig');
23  
24 use MooseX::ClassAttribute;
25  
26 class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateIntegration');
27 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v2/apis/{apiId}/integrations/{integrationId}');
28 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH');
29 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGatewayV2::UpdateIntegrationResponseShape');
30 1;
31  
32 ### main pod documentation begin ###
33  
34 =head1 NAME
35  
36 Paws::ApiGatewayV2::UpdateIntegration - Arguments for method UpdateIntegration on L<Paws::ApiGatewayV2>
37  
38 =head1 DESCRIPTION
39  
40 This class represents the parameters used for calling the method UpdateIntegration on the
41 L<AmazonApiGatewayV2|Paws::ApiGatewayV2> service. Use the attributes of this class
42 as arguments to method UpdateIntegration.
43  
44 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateIntegration.
45  
46 =head1 SYNOPSIS
47  
48 my $apigateway = Paws->service('ApiGatewayV2');
49 my $UpdateIntegrationResponseShape = $apigateway->UpdateIntegration(
50 ApiId => 'My__string',
51 IntegrationId => 'My__string',
52 ConnectionId => 'MyStringWithLengthBetween1And1024', # OPTIONAL
53 ConnectionType => 'INTERNET', # OPTIONAL
54 ContentHandlingStrategy => 'CONVERT_TO_BINARY', # OPTIONAL
55 CredentialsArn => 'MyArn', # OPTIONAL
56 Description => 'MyStringWithLengthBetween0And1024', # OPTIONAL
57 IntegrationMethod => 'MyStringWithLengthBetween1And64', # OPTIONAL
58 IntegrationSubtype => 'MyStringWithLengthBetween1And128', # OPTIONAL
59 IntegrationType => 'AWS', # OPTIONAL
60 IntegrationUri => 'MyUriWithLengthBetween1And2048', # OPTIONAL
61 PassthroughBehavior => 'WHEN_NO_MATCH', # OPTIONAL
62 PayloadFormatVersion => 'MyStringWithLengthBetween1And64', # OPTIONAL
63 RequestParameters =>
64 { 'My__string' => 'MyStringWithLengthBetween1And512', }, # OPTIONAL
65 RequestTemplates =>
66 { 'My__string' => 'MyStringWithLengthBetween0And32K', }, # OPTIONAL
67 ResponseParameters => {
68 'My__string' => { 'My__string' => 'MyStringWithLengthBetween1And512', },
69 }, # OPTIONAL
70 TemplateSelectionExpression => 'MySelectionExpression', # OPTIONAL
71 TimeoutInMillis => 1, # OPTIONAL
72 TlsConfig => { ServerNameToVerify => 'MyStringWithLengthBetween1And512', }
73 , # OPTIONAL
74 );
75  
76 # Results:
77 my $ApiGatewayManaged = $UpdateIntegrationResponseShape->ApiGatewayManaged;
78 my $ConnectionId = $UpdateIntegrationResponseShape->ConnectionId;
79 my $ConnectionType = $UpdateIntegrationResponseShape->ConnectionType;
80 my $ContentHandlingStrategy =
81 $UpdateIntegrationResponseShape->ContentHandlingStrategy;
82 my $CredentialsArn = $UpdateIntegrationResponseShape->CredentialsArn;
83 my $Description = $UpdateIntegrationResponseShape->Description;
84 my $IntegrationId = $UpdateIntegrationResponseShape->IntegrationId;
85 my $IntegrationMethod = $UpdateIntegrationResponseShape->IntegrationMethod;
86 my $IntegrationResponseSelectionExpression =
87 $UpdateIntegrationResponseShape->IntegrationResponseSelectionExpression;
88 my $IntegrationSubtype =
89 $UpdateIntegrationResponseShape->IntegrationSubtype;
90 my $IntegrationType = $UpdateIntegrationResponseShape->IntegrationType;
91 my $IntegrationUri = $UpdateIntegrationResponseShape->IntegrationUri;
92 my $PassthroughBehavior =
93 $UpdateIntegrationResponseShape->PassthroughBehavior;
94 my $PayloadFormatVersion =
95 $UpdateIntegrationResponseShape->PayloadFormatVersion;
96 my $RequestParameters = $UpdateIntegrationResponseShape->RequestParameters;
97 my $RequestTemplates = $UpdateIntegrationResponseShape->RequestTemplates;
98 my $ResponseParameters =
99 $UpdateIntegrationResponseShape->ResponseParameters;
100 my $TemplateSelectionExpression =
101 $UpdateIntegrationResponseShape->TemplateSelectionExpression;
102 my $TimeoutInMillis = $UpdateIntegrationResponseShape->TimeoutInMillis;
103 my $TlsConfig = $UpdateIntegrationResponseShape->TlsConfig;
104  
105 # Returns a L<Paws::ApiGatewayV2::UpdateIntegrationResponseShape> object.
106  
107 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.
108 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/UpdateIntegration>
109  
110 =head1 ATTRIBUTES
111  
112  
113 =head2 B<REQUIRED> ApiId => Str
114  
115 The API identifier.
116  
117  
118  
119 =head2 ConnectionId => Str
120  
121 The ID of the VPC link for a private integration. Supported only for
122 HTTP APIs.
123  
124  
125  
126 =head2 ConnectionType => Str
127  
128 The type of the network connection to the integration endpoint. Specify
129 INTERNET for connections through the public routable internet or
130 VPC_LINK for private connections between API Gateway and resources in a
131 VPC. The default value is INTERNET.
132  
133 Valid values are: C<"INTERNET">, C<"VPC_LINK">
134  
135 =head2 ContentHandlingStrategy => Str
136  
137 Supported only for WebSocket APIs. Specifies how to handle response
138 payload content type conversions. Supported values are
139 CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
140  
141 CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded
142 string to the corresponding binary blob.
143  
144 CONVERT_TO_TEXT: Converts a response payload from a binary blob to a
145 Base64-encoded string.
146  
147 If this property is not defined, the response payload will be passed
148 through from the integration response to the route response or method
149 response without modification.
150  
151 Valid values are: C<"CONVERT_TO_BINARY">, C<"CONVERT_TO_TEXT">
152  
153 =head2 CredentialsArn => Str
154  
155 Specifies the credentials required for the integration, if any. For AWS
156 integrations, three options are available. To specify an IAM Role for
157 API Gateway to assume, use the role's Amazon Resource Name (ARN). To
158 require that the caller's identity be passed through from the request,
159 specify the string arn:aws:iam::*:user/*. To use resource-based
160 permissions on supported AWS services, specify null.
161  
162  
163  
164 =head2 Description => Str
165  
166 The description of the integration
167  
168  
169  
170 =head2 B<REQUIRED> IntegrationId => Str
171  
172 The integration ID.
173  
174  
175  
176 =head2 IntegrationMethod => Str
177  
178 Specifies the integration's HTTP method type.
179  
180  
181  
182 =head2 IntegrationSubtype => Str
183  
184 Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS
185 service action to invoke. To learn more, see Integration subtype
186 reference
187 (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html).
188  
189  
190  
191 =head2 IntegrationType => Str
192  
193 The integration type of an integration. One of the following:
194  
195 AWS: for integrating the route or method request with an AWS service
196 action, including the Lambda function-invoking action. With the Lambda
197 function-invoking action, this is referred to as the Lambda custom
198 integration. With any other AWS service action, this is known as AWS
199 integration. Supported only for WebSocket APIs.
200  
201 AWS_PROXY: for integrating the route or method request with a Lambda
202 function or other AWS service action. This integration is also referred
203 to as a Lambda proxy integration.
204  
205 HTTP: for integrating the route or method request with an HTTP
206 endpoint. This integration is also referred to as the HTTP custom
207 integration. Supported only for WebSocket APIs.
208  
209 HTTP_PROXY: for integrating the route or method request with an HTTP
210 endpoint, with the client request passed through as-is. This is also
211 referred to as HTTP proxy integration. For HTTP API private
212 integrations, use an HTTP_PROXY integration.
213  
214 MOCK: for integrating the route or method request with API Gateway as a
215 "loopback" endpoint without invoking any backend. Supported only for
216 WebSocket APIs.
217  
218 Valid values are: C<"AWS">, C<"HTTP">, C<"MOCK">, C<"HTTP_PROXY">, C<"AWS_PROXY">
219  
220 =head2 IntegrationUri => Str
221  
222 For a Lambda integration, specify the URI of a Lambda function.
223  
224 For an HTTP integration, specify a fully-qualified URL.
225  
226 For an HTTP API private integration, specify the ARN of an Application
227 Load Balancer listener, Network Load Balancer listener, or AWS Cloud
228 Map service. If you specify the ARN of an AWS Cloud Map service, API
229 Gateway uses DiscoverInstances to identify resources. You can use query
230 parameters to target specific resources. To learn more, see
231 DiscoverInstances
232 (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html).
233 For private integrations, all resources must be owned by the same AWS
234 account.
235  
236  
237  
238 =head2 PassthroughBehavior => Str
239  
240 Specifies the pass-through behavior for incoming requests based on the
241 Content-Type header in the request, and the available mapping templates
242 specified as the requestTemplates property on the Integration resource.
243 There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
244 NEVER. Supported only for WebSocket APIs.
245  
246 WHEN_NO_MATCH passes the request body for unmapped content types
247 through to the integration backend without transformation.
248  
249 NEVER rejects unmapped content types with an HTTP 415 Unsupported Media
250 Type response.
251  
252 WHEN_NO_TEMPLATES allows pass-through when the integration has no
253 content types mapped to templates. However, if there is at least one
254 content type defined, unmapped content types will be rejected with the
255 same HTTP 415 Unsupported Media Type response.
256  
257 Valid values are: C<"WHEN_NO_MATCH">, C<"NEVER">, C<"WHEN_NO_TEMPLATES">
258  
259 =head2 PayloadFormatVersion => Str
260  
261 Specifies the format of the payload sent to an integration. Required
262 for HTTP APIs.
263  
264  
265  
266 =head2 RequestParameters => L<Paws::ApiGatewayV2::IntegrationParameters>
267  
268 For WebSocket APIs, a key-value map specifying request parameters that
269 are passed from the method request to the backend. The key is an
270 integration request parameter name and the associated value is a method
271 request parameter value or static value that must be enclosed within
272 single quotes and pre-encoded as required by the backend. The method
273 request parameter value must match the pattern of
274 method.request.{location}.{name} , where {location} is querystring,
275 path, or header; and {name} must be a valid and unique method request
276 parameter name.
277  
278 For HTTP API integrations with a specified integrationSubtype, request
279 parameters are a key-value map specifying parameters that are passed to
280 AWS_PROXY integrations. You can provide static values, or map request
281 data, stage variables, or context variables that are evaluated at
282 runtime. To learn more, see Working with AWS service integrations for
283 HTTP APIs
284 (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html).
285  
286 For HTTP API integrations, without a specified integrationSubtype
287 request parameters are a key-value map specifying how to transform HTTP
288 requests before sending them to the backend. The key should follow the
289 pattern
290 E<lt>actionE<gt>:E<lt>header|querystring|pathE<gt>.E<lt>locationE<gt>
291 where action can be append, overwrite or remove. For values, you can
292 provide static values, or map request data, stage variables, or context
293 variables that are evaluated at runtime. To learn more, see
294 Transforming API requests and responses
295 (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.).
296  
297  
298  
299 =head2 RequestTemplates => L<Paws::ApiGatewayV2::TemplateMap>
300  
301 Represents a map of Velocity templates that are applied on the request
302 payload based on the value of the Content-Type header sent by the
303 client. The content type value is the key in this map, and the template
304 (as a String) is the value. Supported only for WebSocket APIs.
305  
306  
307  
308 =head2 ResponseParameters => L<Paws::ApiGatewayV2::ResponseParameters>
309  
310 Supported only for HTTP APIs. You use response parameters to transform
311 the HTTP response from a backend integration before returning the
312 response to clients. Specify a key-value map from a selection key to
313 response parameters. The selection key must be a valid HTTP status code
314 within the range of 200-599. Response parameters are a key-value map.
315 The key must match pattern
316 E<lt>actionE<gt>:E<lt>headerE<gt>.E<lt>locationE<gt> or
317 overwrite.statuscode. The action can be append, overwrite or remove.
318 The value can be a static value, or map to response data, stage
319 variables, or context variables that are evaluated at runtime. To learn
320 more, see Transforming API requests and responses
321 (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html).
322  
323  
324  
325 =head2 TemplateSelectionExpression => Str
326  
327 The template selection expression for the integration.
328  
329  
330  
331 =head2 TimeoutInMillis => Int
332  
333 Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs
334 and between 50 and 30,000 milliseconds for HTTP APIs. The default
335 timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
336  
337  
338  
339 =head2 TlsConfig => L<Paws::ApiGatewayV2::TlsConfigInput>
340  
341 The TLS configuration for a private integration. If you specify a TLS
342 configuration, private integration traffic uses the HTTPS protocol.
343 Supported only for HTTP APIs.
344  
345  
346  
347  
348 =head1 SEE ALSO
349  
350 This class forms part of L<Paws>, documenting arguments for method UpdateIntegration in L<Paws::ApiGatewayV2>
351  
352 =head1 BUGS and CONTRIBUTIONS
353  
354 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
355  
356 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
357  
358 =cut
359