« blib/lib/Paws/ApiGatewayV2/Integration.pm
↑ Summary
blib/lib/Paws/ApiGatewayV2/IntegrationResponse.pm »
| 1 | package Paws::ApiGatewayV2::IntegrationParameters; | ||
| 2 | use Moose; | ||
| 3 | with 'Paws::API::StrToNativeMapParser'; | ||
| 4 | |||
| 5 | has Map => (is => 'ro', isa => 'HashRef[Maybe[Str]]'); | ||
| 6 | 1; | ||
| 7 | |||
| 8 | ### main pod documentation begin ### | ||
| 9 | |||
| 10 | =head1 NAME | ||
| 11 | |||
| 12 | Paws::ApiGatewayV2::IntegrationParameters | ||
| 13 | |||
| 14 | =head1 USAGE | ||
| 15 | |||
| 16 | This class represents one of two things: | ||
| 17 | |||
| 18 | =head3 Arguments in a call to a service | ||
| 19 | |||
| 20 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 21 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 22 | |||
| 23 | As an example, if Att1 is expected to be a Paws::ApiGatewayV2::IntegrationParameters object: | ||
| 24 | |||
| 25 | $service_obj->Method(Att1 => { key1 => $value, ..., keyN => $value }); | ||
| 26 | |||
| 27 | =head3 Results returned from an API call | ||
| 28 | |||
| 29 | Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGatewayV2::IntegrationParameters object: | ||
| 30 | |||
| 31 | $result = $service_obj->Method(...); | ||
| 32 | $result->Att1->Map->{ key1 } | ||
| 33 | |||
| 34 | =head1 DESCRIPTION | ||
| 35 | |||
| 36 | For WebSocket APIs, a key-value map specifying request parameters that | ||
| 37 | are passed from the method request to the backend. The key is an | ||
| 38 | integration request parameter name and the associated value is a method | ||
| 39 | request parameter value or static value that must be enclosed within | ||
| 40 | single quotes and pre-encoded as required by the backend. The method | ||
| 41 | request parameter value must match the pattern of | ||
| 42 | method.request.{location}.{name} , where {location} is querystring, | ||
| 43 | path, or header; and {name} must be a valid and unique method request | ||
| 44 | parameter name. | ||
| 45 | |||
| 46 | For HTTP API integrations with a specified integrationSubtype, request | ||
| 47 | parameters are a key-value map specifying parameters that are passed to | ||
| 48 | AWS_PROXY integrations. You can provide static values, or map request | ||
| 49 | data, stage variables, or context variables that are evaluated at | ||
| 50 | runtime. To learn more, see Working with AWS service integrations for | ||
| 51 | HTTP APIs | ||
| 52 | (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html). | ||
| 53 | |||
| 54 | For HTTP API integrations without a specified integrationSubtype | ||
| 55 | request parameters are a key-value map specifying how to transform HTTP | ||
| 56 | requests before sending them to the backend. The key should follow the | ||
| 57 | pattern | ||
| 58 | E<lt>actionE<gt>:E<lt>header|querystring|pathE<gt>.E<lt>locationE<gt> | ||
| 59 | where action can be append, overwrite or remove. For values, you can | ||
| 60 | provide static values, or map request data, stage variables, or context | ||
| 61 | variables that are evaluated at runtime. To learn more, see | ||
| 62 | Transforming API requests and responses | ||
| 63 | (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html). | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | =head2 Map => Str | ||
| 68 | |||
| 69 | Use the Map method to retrieve a HashRef to the map | ||
| 70 | |||
| 71 | =head1 SEE ALSO | ||
| 72 | |||
| 73 | This class forms part of L<Paws>, describing an object used in L<Paws::ApiGatewayV2> | ||
| 74 | |||
| 75 | =head1 BUGS and CONTRIBUTIONS | ||
| 76 | |||
| 77 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 78 | |||
| 79 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 80 | |||
| 81 | =cut | ||
| 82 |