« blib/lib/Paws/ApiGatewayV2/CreateIntegrationInput.pm
↑ Summary
blib/lib/Paws/ApiGatewayV2/CreateIntegrationResponseInput.pm »
| 1 | |||
| 2 | package Paws::ApiGatewayV2::CreateIntegrationResponse; | ||
| 3 | use Moose; | ||
| 4 | has ApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'apiId', required => 1); | ||
| 5 | has ContentHandlingStrategy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'contentHandlingStrategy'); | ||
| 6 | has IntegrationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'integrationId', required => 1); | ||
| 7 | has IntegrationResponseKey => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'integrationResponseKey', required => 1); | ||
| 8 | has ResponseParameters => (is => 'ro', isa => 'Paws::ApiGatewayV2::IntegrationParameters', traits => ['NameInRequest'], request_name => 'responseParameters'); | ||
| 9 | has ResponseTemplates => (is => 'ro', isa => 'Paws::ApiGatewayV2::TemplateMap', traits => ['NameInRequest'], request_name => 'responseTemplates'); | ||
| 10 | has TemplateSelectionExpression => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'templateSelectionExpression'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateIntegrationResponse'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGatewayV2::CreateIntegrationResponseResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::ApiGatewayV2::CreateIntegrationResponse - Arguments for method CreateIntegrationResponse on L<Paws::ApiGatewayV2> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method CreateIntegrationResponse on the | ||
| 29 | L<AmazonApiGatewayV2|Paws::ApiGatewayV2> service. Use the attributes of this class | ||
| 30 | as arguments to method CreateIntegrationResponse. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateIntegrationResponse. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $apigateway = Paws->service('ApiGatewayV2'); | ||
| 37 | my $CreateIntegrationResponseResponse = | ||
| 38 | $apigateway->CreateIntegrationResponse( | ||
| 39 | ApiId => 'My__string', | ||
| 40 | IntegrationId => 'My__string', | ||
| 41 | IntegrationResponseKey => 'MySelectionKey', | ||
| 42 | ContentHandlingStrategy => 'CONVERT_TO_BINARY', # OPTIONAL | ||
| 43 | ResponseParameters => | ||
| 44 | { 'My__string' => 'MyStringWithLengthBetween1And512', }, # OPTIONAL | ||
| 45 | ResponseTemplates => | ||
| 46 | { 'My__string' => 'MyStringWithLengthBetween0And32K', }, # OPTIONAL | ||
| 47 | TemplateSelectionExpression => 'MySelectionExpression', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $ContentHandlingStrategy = | ||
| 52 | $CreateIntegrationResponseResponse->ContentHandlingStrategy; | ||
| 53 | my $IntegrationResponseId = | ||
| 54 | $CreateIntegrationResponseResponse->IntegrationResponseId; | ||
| 55 | my $IntegrationResponseKey = | ||
| 56 | $CreateIntegrationResponseResponse->IntegrationResponseKey; | ||
| 57 | my $ResponseParameters = | ||
| 58 | $CreateIntegrationResponseResponse->ResponseParameters; | ||
| 59 | my $ResponseTemplates = | ||
| 60 | $CreateIntegrationResponseResponse->ResponseTemplates; | ||
| 61 | my $TemplateSelectionExpression = | ||
| 62 | $CreateIntegrationResponseResponse->TemplateSelectionExpression; | ||
| 63 | |||
| 64 | # Returns a L<Paws::ApiGatewayV2::CreateIntegrationResponseResponse> object. | ||
| 65 | |||
| 66 | 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. | ||
| 67 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/CreateIntegrationResponse> | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> ApiId => Str | ||
| 73 | |||
| 74 | The API identifier. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 ContentHandlingStrategy => Str | ||
| 79 | |||
| 80 | Specifies how to handle response payload content type conversions. | ||
| 81 | Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the | ||
| 82 | following behaviors: | ||
| 83 | |||
| 84 | CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded | ||
| 85 | string to the corresponding binary blob. | ||
| 86 | |||
| 87 | CONVERT_TO_TEXT: Converts a response payload from a binary blob to a | ||
| 88 | Base64-encoded string. | ||
| 89 | |||
| 90 | If this property is not defined, the response payload will be passed | ||
| 91 | through from the integration response to the route response or method | ||
| 92 | response without modification. | ||
| 93 | |||
| 94 | Valid values are: C<"CONVERT_TO_BINARY">, C<"CONVERT_TO_TEXT"> | ||
| 95 | |||
| 96 | =head2 B<REQUIRED> IntegrationId => Str | ||
| 97 | |||
| 98 | The integration ID. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 B<REQUIRED> IntegrationResponseKey => Str | ||
| 103 | |||
| 104 | The integration response key. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 ResponseParameters => L<Paws::ApiGatewayV2::IntegrationParameters> | ||
| 109 | |||
| 110 | A key-value map specifying response parameters that are passed to the | ||
| 111 | method response from the backend. The key is a method response header | ||
| 112 | parameter name and the mapped value is an integration response header | ||
| 113 | value, a static value enclosed within a pair of single quotes, or a | ||
| 114 | JSON expression from the integration response body. The mapping key | ||
| 115 | must match the pattern of method.response.header.{name}, where {name} | ||
| 116 | is a valid and unique header name. The mapped non-static value must | ||
| 117 | match the pattern of integration.response.header.{name} or | ||
| 118 | integration.response.body.{JSON-expression}, where {name} is a valid | ||
| 119 | and unique response header name and {JSON-expression} is a valid JSON | ||
| 120 | expression without the $ prefix. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 ResponseTemplates => L<Paws::ApiGatewayV2::TemplateMap> | ||
| 125 | |||
| 126 | The collection of response templates for the integration response as a | ||
| 127 | string-to-string map of key-value pairs. Response templates are | ||
| 128 | represented as a key/value map, with a content-type as the key and a | ||
| 129 | template as the value. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 TemplateSelectionExpression => Str | ||
| 134 | |||
| 135 | The template selection expression for the integration response. | ||
| 136 | Supported only for WebSocket APIs. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head1 SEE ALSO | ||
| 142 | |||
| 143 | This class forms part of L<Paws>, documenting arguments for method CreateIntegrationResponse in L<Paws::ApiGatewayV2> | ||
| 144 | |||
| 145 | =head1 BUGS and CONTRIBUTIONS | ||
| 146 | |||
| 147 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 148 | |||
| 149 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 150 | |||
| 151 | =cut | ||
| 152 |