File Coverage

blib/lib/Paws/ApiGateway/PutMethod.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::ApiGateway::PutMethod;
3 1     1   418 use Moose;
  1         2  
  1         9  
4             has ApiKeyRequired => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'apiKeyRequired');
5             has AuthorizationType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authorizationType', required => 1);
6             has AuthorizerId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authorizerId');
7             has HttpMethod => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'httpMethod', required => 1);
8             has OperationName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'operationName');
9             has RequestModels => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'requestModels');
10             has RequestParameters => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToBoolean', traits => ['NameInRequest'], request_name => 'requestParameters');
11             has RequestValidatorId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'requestValidatorId');
12             has ResourceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'resourceId', required => 1);
13             has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restApiId', required => 1);
14              
15 1     1   6487 use MooseX::ClassAttribute;
  1         3  
  1         9  
16              
17             class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutMethod');
18             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}');
19             class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
20             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::Method');
21             class_has _result_key => (isa => 'Str', is => 'ro');
22             1;
23              
24             ### main pod documentation begin ###
25              
26             =head1 NAME
27              
28             Paws::ApiGateway::PutMethod - Arguments for method PutMethod on Paws::ApiGateway
29              
30             =head1 DESCRIPTION
31              
32             This class represents the parameters used for calling the method PutMethod on the
33             Amazon API Gateway service. Use the attributes of this class
34             as arguments to method PutMethod.
35              
36             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutMethod.
37              
38             As an example:
39              
40             $service_obj->PutMethod(Att1 => $value1, Att2 => $value2, ...);
41              
42             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.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 ApiKeyRequired => Bool
48              
49             Specifies whether the method required a valid ApiKey.
50              
51              
52              
53             =head2 B<REQUIRED> AuthorizationType => Str
54              
55             The method's authorization type. Valid values are C<NONE> for open
56             access, C<AWS_IAM> for using AWS IAM permissions, C<CUSTOM> for using a
57             custom authorizer, or C<COGNITO_USER_POOLS> for using a Cognito user
58             pool.
59              
60              
61              
62             =head2 AuthorizerId => Str
63              
64             Specifies the identifier of an Authorizer to use on this Method, if the
65             type is CUSTOM.
66              
67              
68              
69             =head2 B<REQUIRED> HttpMethod => Str
70              
71             Specifies the method request's HTTP method type.
72              
73              
74              
75             =head2 OperationName => Str
76              
77             A human-friendly operation identifier for the method. For example, you
78             can assign the C<operationName> of C<ListPets> for the C<GET /pets>
79             method in PetStore example.
80              
81              
82              
83             =head2 RequestModels => L<Paws::ApiGateway::MapOfStringToString>
84              
85             Specifies the Model resources used for the request's content type.
86             Request models are represented as a key/value map, with a content type
87             as the key and a Model name as the value.
88              
89              
90              
91             =head2 RequestParameters => L<Paws::ApiGateway::MapOfStringToBoolean>
92              
93             A key-value map defining required or optional method request parameters
94             that can be accepted by Amazon API Gateway. A key defines a method
95             request parameter name matching the pattern of
96             C<method.request.{location}.{name}>, where C<location> is
97             C<querystring>, C<path>, or C<header> and C<name> is a valid and unique
98             parameter name. The value associated with the key is a Boolean flag
99             indicating whether the parameter is required (C<true>) or optional
100             (C<false>). The method request parameter names defined here are
101             available in Integration to be mapped to integration request parameters
102             or body-mapping templates.
103              
104              
105              
106             =head2 RequestValidatorId => Str
107              
108             The identifier of a RequestValidator for validating the method request.
109              
110              
111              
112             =head2 B<REQUIRED> ResourceId => Str
113              
114             The Resource identifier for the new Method resource.
115              
116              
117              
118             =head2 B<REQUIRED> RestApiId => Str
119              
120             The string identifier of the associated RestApi.
121              
122              
123              
124              
125             =head1 SEE ALSO
126              
127             This class forms part of L<Paws>, documenting arguments for method PutMethod in L<Paws::ApiGateway>
128              
129             =head1 BUGS and CONTRIBUTIONS
130              
131             The source code is located here: https://github.com/pplu/aws-sdk-perl
132              
133             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
134              
135             =cut
136