| 1 | |||
| 2 | package Paws::ApiGateway::PutIntegrationResponse; | ||
| 3 | use Moose; | ||
| 4 | has ContentHandling => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'contentHandling'); | ||
| 5 | has HttpMethod => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'http_method', required => 1); | ||
| 6 | has ResourceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'resource_id', required => 1); | ||
| 7 | has ResponseParameters => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'responseParameters'); | ||
| 8 | has ResponseTemplates => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'responseTemplates'); | ||
| 9 | has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restapi_id', required => 1); | ||
| 10 | has SelectionPattern => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'selectionPattern'); | ||
| 11 | has StatusCode => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'status_code', required => 1); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutIntegrationResponse'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::IntegrationResponse'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::ApiGateway::PutIntegrationResponse - Arguments for method PutIntegrationResponse on L<Paws::ApiGateway> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method PutIntegrationResponse on the | ||
| 30 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 31 | as arguments to method PutIntegrationResponse. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutIntegrationResponse. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $apigateway = Paws->service('ApiGateway'); | ||
| 38 | my $IntegrationResponse = $apigateway->PutIntegrationResponse( | ||
| 39 | HttpMethod => 'MyString', | ||
| 40 | ResourceId => 'MyString', | ||
| 41 | RestApiId => 'MyString', | ||
| 42 | StatusCode => 'MyStatusCode', | ||
| 43 | ContentHandling => 'CONVERT_TO_BINARY', # OPTIONAL | ||
| 44 | ResponseParameters => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 45 | ResponseTemplates => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 46 | SelectionPattern => 'MyString', # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $ContentHandling = $IntegrationResponse->ContentHandling; | ||
| 51 | my $ResponseParameters = $IntegrationResponse->ResponseParameters; | ||
| 52 | my $ResponseTemplates = $IntegrationResponse->ResponseTemplates; | ||
| 53 | my $SelectionPattern = $IntegrationResponse->SelectionPattern; | ||
| 54 | my $StatusCode = $IntegrationResponse->StatusCode; | ||
| 55 | |||
| 56 | # Returns a L<Paws::ApiGateway::IntegrationResponse> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/PutIntegrationResponse> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 ContentHandling => Str | ||
| 65 | |||
| 66 | Specifies how to handle response payload content type conversions. | ||
| 67 | Supported values are C<CONVERT_TO_BINARY> and C<CONVERT_TO_TEXT>, with | ||
| 68 | the following behaviors: | ||
| 69 | |||
| 70 | =over | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C<CONVERT_TO_BINARY>: Converts a response payload from a Base64-encoded | ||
| 75 | string to the corresponding binary blob. | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | C<CONVERT_TO_TEXT>: Converts a response payload from a binary blob to a | ||
| 80 | Base64-encoded string. | ||
| 81 | |||
| 82 | =back | ||
| 83 | |||
| 84 | If this property is not defined, the response payload will be passed | ||
| 85 | through from the integration response to the method response without | ||
| 86 | modification. | ||
| 87 | |||
| 88 | Valid values are: C<"CONVERT_TO_BINARY">, C<"CONVERT_TO_TEXT"> | ||
| 89 | |||
| 90 | =head2 B<REQUIRED> HttpMethod => Str | ||
| 91 | |||
| 92 | [Required] Specifies a put integration response request's HTTP method. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 B<REQUIRED> ResourceId => Str | ||
| 97 | |||
| 98 | [Required] Specifies a put integration response request's resource | ||
| 99 | identifier. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 ResponseParameters => L<Paws::ApiGateway::MapOfStringToString> | ||
| 104 | |||
| 105 | A key-value map specifying response parameters that are passed to the | ||
| 106 | method response from the back end. The key is a method response header | ||
| 107 | parameter name and the mapped value is an integration response header | ||
| 108 | value, a static value enclosed within a pair of single quotes, or a | ||
| 109 | JSON expression from the integration response body. The mapping key | ||
| 110 | must match the pattern of C<method.response.header.{name}>, where | ||
| 111 | C<name> is a valid and unique header name. The mapped non-static value | ||
| 112 | must match the pattern of C<integration.response.header.{name}> or | ||
| 113 | C<integration.response.body.{JSON-expression}>, where C<name> must be a | ||
| 114 | valid and unique response header name and C<JSON-expression> a valid | ||
| 115 | JSON expression without the C<$> prefix. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 ResponseTemplates => L<Paws::ApiGateway::MapOfStringToString> | ||
| 120 | |||
| 121 | Specifies a put integration response's templates. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 B<REQUIRED> RestApiId => Str | ||
| 126 | |||
| 127 | [Required] The string identifier of the associated RestApi. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 SelectionPattern => Str | ||
| 132 | |||
| 133 | Specifies the selection pattern of a put integration response. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 B<REQUIRED> StatusCode => Str | ||
| 138 | |||
| 139 | [Required] Specifies the status code that is used to map the | ||
| 140 | integration response to an existing MethodResponse. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head1 SEE ALSO | ||
| 146 | |||
| 147 | This class forms part of L<Paws>, documenting arguments for method PutIntegrationResponse in L<Paws::ApiGateway> | ||
| 148 | |||
| 149 | =head1 BUGS and CONTRIBUTIONS | ||
| 150 | |||
| 151 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 152 | |||
| 153 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 154 | |||
| 155 | =cut | ||
| 156 |