« blib/lib/Paws/ApiGateway/PutIntegrationResponse.pm
↑ Summary
blib/lib/Paws/ApiGateway/PutMethodResponse.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::PutMethod; | ||
| 3 | use Moose; | ||
| 4 | has ApiKeyRequired => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'apiKeyRequired'); | ||
| 5 | has AuthorizationScopes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'authorizationScopes'); | ||
| 6 | has AuthorizationType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authorizationType', required => 1); | ||
| 7 | has AuthorizerId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authorizerId'); | ||
| 8 | has HttpMethod => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'http_method', required => 1); | ||
| 9 | has OperationName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'operationName'); | ||
| 10 | has RequestModels => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'requestModels'); | ||
| 11 | has RequestParameters => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToBoolean', traits => ['NameInRequest'], request_name => 'requestParameters'); | ||
| 12 | has RequestValidatorId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'requestValidatorId'); | ||
| 13 | has ResourceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'resource_id', required => 1); | ||
| 14 | has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restapi_id', required => 1); | ||
| 15 | |||
| 16 | use MooseX::ClassAttribute; | ||
| 17 | |||
| 18 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutMethod'); | ||
| 19 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}'); | ||
| 20 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::Method'); | ||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::ApiGateway::PutMethod - Arguments for method PutMethod on L<Paws::ApiGateway> | ||
| 29 | |||
| 30 | =head1 DESCRIPTION | ||
| 31 | |||
| 32 | This class represents the parameters used for calling the method PutMethod on the | ||
| 33 | L<Amazon API Gateway|Paws::ApiGateway> 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 | =head1 SYNOPSIS | ||
| 39 | |||
| 40 | my $apigateway = Paws->service('ApiGateway'); | ||
| 41 | my $Method = $apigateway->PutMethod( | ||
| 42 | AuthorizationType => 'MyString', | ||
| 43 | HttpMethod => 'MyString', | ||
| 44 | ResourceId => 'MyString', | ||
| 45 | RestApiId => 'MyString', | ||
| 46 | ApiKeyRequired => 1, # OPTIONAL | ||
| 47 | AuthorizationScopes => [ 'MyString', ... ], # OPTIONAL | ||
| 48 | AuthorizerId => 'MyString', # OPTIONAL | ||
| 49 | OperationName => 'MyString', # OPTIONAL | ||
| 50 | RequestModels => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 51 | RequestParameters => { 'MyString' => 1, }, # OPTIONAL | ||
| 52 | RequestValidatorId => 'MyString', # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $ApiKeyRequired = $Method->ApiKeyRequired; | ||
| 57 | my $AuthorizationScopes = $Method->AuthorizationScopes; | ||
| 58 | my $AuthorizationType = $Method->AuthorizationType; | ||
| 59 | my $AuthorizerId = $Method->AuthorizerId; | ||
| 60 | my $HttpMethod = $Method->HttpMethod; | ||
| 61 | my $MethodIntegration = $Method->MethodIntegration; | ||
| 62 | my $MethodResponses = $Method->MethodResponses; | ||
| 63 | my $OperationName = $Method->OperationName; | ||
| 64 | my $RequestModels = $Method->RequestModels; | ||
| 65 | my $RequestParameters = $Method->RequestParameters; | ||
| 66 | my $RequestValidatorId = $Method->RequestValidatorId; | ||
| 67 | |||
| 68 | # Returns a L<Paws::ApiGateway::Method> object. | ||
| 69 | |||
| 70 | 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. | ||
| 71 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/PutMethod> | ||
| 72 | |||
| 73 | =head1 ATTRIBUTES | ||
| 74 | |||
| 75 | |||
| 76 | =head2 ApiKeyRequired => Bool | ||
| 77 | |||
| 78 | Specifies whether the method required a valid ApiKey. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 AuthorizationScopes => ArrayRef[Str|Undef] | ||
| 83 | |||
| 84 | A list of authorization scopes configured on the method. The scopes are | ||
| 85 | used with a C<COGNITO_USER_POOLS> authorizer to authorize the method | ||
| 86 | invocation. The authorization works by matching the method scopes | ||
| 87 | against the scopes parsed from the access token in the incoming | ||
| 88 | request. The method invocation is authorized if any method scopes | ||
| 89 | matches a claimed scope in the access token. Otherwise, the invocation | ||
| 90 | is not authorized. When the method scope is configured, the client must | ||
| 91 | provide an access token instead of an identity token for authorization | ||
| 92 | purposes. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 B<REQUIRED> AuthorizationType => Str | ||
| 97 | |||
| 98 | [Required] The method's authorization type. Valid values are C<NONE> | ||
| 99 | for open access, C<AWS_IAM> for using AWS IAM permissions, C<CUSTOM> | ||
| 100 | for using a custom authorizer, or C<COGNITO_USER_POOLS> for using a | ||
| 101 | Cognito user pool. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 AuthorizerId => Str | ||
| 106 | |||
| 107 | Specifies the identifier of an Authorizer to use on this Method, if the | ||
| 108 | type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is | ||
| 109 | generated by API Gateway when you created the authorizer. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 B<REQUIRED> HttpMethod => Str | ||
| 114 | |||
| 115 | [Required] Specifies the method request's HTTP method type. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 OperationName => Str | ||
| 120 | |||
| 121 | A human-friendly operation identifier for the method. For example, you | ||
| 122 | can assign the C<operationName> of C<ListPets> for the C<GET /pets> | ||
| 123 | method in the C<PetStore> example. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 RequestModels => L<Paws::ApiGateway::MapOfStringToString> | ||
| 128 | |||
| 129 | Specifies the Model resources used for the request's content type. | ||
| 130 | Request models are represented as a key/value map, with a content type | ||
| 131 | as the key and a Model name as the value. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 RequestParameters => L<Paws::ApiGateway::MapOfStringToBoolean> | ||
| 136 | |||
| 137 | A key-value map defining required or optional method request parameters | ||
| 138 | that can be accepted by API Gateway. A key defines a method request | ||
| 139 | parameter name matching the pattern of | ||
| 140 | C<method.request.{location}.{name}>, where C<location> is | ||
| 141 | C<querystring>, C<path>, or C<header> and C<name> is a valid and unique | ||
| 142 | parameter name. The value associated with the key is a Boolean flag | ||
| 143 | indicating whether the parameter is required (C<true>) or optional | ||
| 144 | (C<false>). The method request parameter names defined here are | ||
| 145 | available in Integration to be mapped to integration request parameters | ||
| 146 | or body-mapping templates. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 RequestValidatorId => Str | ||
| 151 | |||
| 152 | The identifier of a RequestValidator for validating the method request. | ||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | =head2 B<REQUIRED> ResourceId => Str | ||
| 157 | |||
| 158 | [Required] The Resource identifier for the new Method resource. | ||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | =head2 B<REQUIRED> RestApiId => Str | ||
| 163 | |||
| 164 | [Required] The string identifier of the associated RestApi. | ||
| 165 | |||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | =head1 SEE ALSO | ||
| 170 | |||
| 171 | This class forms part of L<Paws>, documenting arguments for method PutMethod in L<Paws::ApiGateway> | ||
| 172 | |||
| 173 | =head1 BUGS and CONTRIBUTIONS | ||
| 174 | |||
| 175 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 176 | |||
| 177 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 178 | |||
| 179 | =cut | ||
| 180 |