| 1 | |||
| 2 | package Paws::ApiGateway::PutMethodResponse; | ||
| 3 | use Moose; | ||
| 4 | has HttpMethod => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'http_method', required => 1); | ||
| 5 | has ResourceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'resource_id', required => 1); | ||
| 6 | has ResponseModels => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'responseModels'); | ||
| 7 | has ResponseParameters => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToBoolean', traits => ['NameInRequest'], request_name => 'responseParameters'); | ||
| 8 | has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restapi_id', required => 1); | ||
| 9 | has StatusCode => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'status_code', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutMethodResponse'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::MethodResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::ApiGateway::PutMethodResponse - Arguments for method PutMethodResponse on L<Paws::ApiGateway> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method PutMethodResponse on the | ||
| 28 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 29 | as arguments to method PutMethodResponse. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutMethodResponse. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $apigateway = Paws->service('ApiGateway'); | ||
| 36 | my $MethodResponse = $apigateway->PutMethodResponse( | ||
| 37 | HttpMethod => 'MyString', | ||
| 38 | ResourceId => 'MyString', | ||
| 39 | RestApiId => 'MyString', | ||
| 40 | StatusCode => 'MyStatusCode', | ||
| 41 | ResponseModels => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 42 | ResponseParameters => { 'MyString' => 1, }, # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $ResponseModels = $MethodResponse->ResponseModels; | ||
| 47 | my $ResponseParameters = $MethodResponse->ResponseParameters; | ||
| 48 | my $StatusCode = $MethodResponse->StatusCode; | ||
| 49 | |||
| 50 | # Returns a L<Paws::ApiGateway::MethodResponse> object. | ||
| 51 | |||
| 52 | 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. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/PutMethodResponse> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> HttpMethod => Str | ||
| 59 | |||
| 60 | [Required] The HTTP verb of the Method resource. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> ResourceId => Str | ||
| 65 | |||
| 66 | [Required] The Resource identifier for the Method resource. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 ResponseModels => L<Paws::ApiGateway::MapOfStringToString> | ||
| 71 | |||
| 72 | Specifies the Model resources used for the response's content type. | ||
| 73 | Response models are represented as a key/value map, with a content type | ||
| 74 | as the key and a Model name as the value. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 ResponseParameters => L<Paws::ApiGateway::MapOfStringToBoolean> | ||
| 79 | |||
| 80 | A key-value map specifying required or optional response parameters | ||
| 81 | that API Gateway can send back to the caller. A key defines a method | ||
| 82 | response header name and the associated value is a Boolean flag | ||
| 83 | indicating whether the method response parameter is required or not. | ||
| 84 | The method response header names must match the pattern of | ||
| 85 | C<method.response.header.{name}>, where C<name> is a valid and unique | ||
| 86 | header name. The response parameter names defined here are available in | ||
| 87 | the integration response to be mapped from an integration response | ||
| 88 | header expressed in C<integration.response.header.{name}>, a static | ||
| 89 | value enclosed within a pair of single quotes (e.g., | ||
| 90 | C<'application/json'>), or a JSON expression from the back-end response | ||
| 91 | payload in the form of C<integration.response.body.{JSON-expression}>, | ||
| 92 | where C<JSON-expression> is a valid JSON expression without the C<$> | ||
| 93 | prefix.) | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 B<REQUIRED> RestApiId => Str | ||
| 98 | |||
| 99 | [Required] The string identifier of the associated RestApi. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 B<REQUIRED> StatusCode => Str | ||
| 104 | |||
| 105 | [Required] The method response's status code. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head1 SEE ALSO | ||
| 111 | |||
| 112 | This class forms part of L<Paws>, documenting arguments for method PutMethodResponse in L<Paws::ApiGateway> | ||
| 113 | |||
| 114 | =head1 BUGS and CONTRIBUTIONS | ||
| 115 | |||
| 116 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 117 | |||
| 118 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 119 | |||
| 120 | =cut | ||
| 121 |