Paws::ApiGateway::PutMethod - Arguments for method PutMethod on Paws::ApiGateway


This class represents the parameters used for calling the method PutMethod on the Amazon API Gateway service. Use the attributes of this class as arguments to method PutMethod.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutMethod.


    my $apigateway = Paws->service('ApiGateway');
    my $Method = $apigateway->PutMethod(
      AuthorizationType   => 'MyString',
      HttpMethod          => 'MyString',
      ResourceId          => 'MyString',
      RestApiId           => 'MyString',
      ApiKeyRequired      => 1,                                # OPTIONAL
      AuthorizationScopes => [ 'MyString', ... ],              # OPTIONAL
      AuthorizerId        => 'MyString',                       # OPTIONAL
      OperationName       => 'MyString',                       # OPTIONAL
      RequestModels       => { 'MyString' => 'MyString', },    # OPTIONAL
      RequestParameters   => { 'MyString' => 1, },             # OPTIONAL
      RequestValidatorId  => 'MyString',                       # OPTIONAL

    # Results:
    my $ApiKeyRequired      = $Method->ApiKeyRequired;
    my $AuthorizationScopes = $Method->AuthorizationScopes;
    my $AuthorizationType   = $Method->AuthorizationType;
    my $AuthorizerId        = $Method->AuthorizerId;
    my $HttpMethod          = $Method->HttpMethod;
    my $MethodIntegration   = $Method->MethodIntegration;
    my $MethodResponses     = $Method->MethodResponses;
    my $OperationName       = $Method->OperationName;
    my $RequestModels       = $Method->RequestModels;
    my $RequestParameters   = $Method->RequestParameters;
    my $RequestValidatorId  = $Method->RequestValidatorId;

    # Returns a L<Paws::ApiGateway::Method> object.

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. For the AWS API documentation, see


ApiKeyRequired => Bool

Specifies whether the method required a valid ApiKey.

AuthorizationScopes => ArrayRef[Str|Undef]

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

REQUIRED AuthorizationType => Str

[Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

AuthorizerId => Str

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

REQUIRED HttpMethod => Str

[Required] Specifies the method request's HTTP method type.

OperationName => Str

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in PetStore ( example.

RequestModels => Paws::ApiGateway::MapOfStringToString

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

RequestParameters => Paws::ApiGateway::MapOfStringToBoolean

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

RequestValidatorId => Str

The identifier of a RequestValidator for validating the method request.

REQUIRED ResourceId => Str

[Required] The Resource identifier for the new Method resource.

REQUIRED RestApiId => Str

[Required] The string identifier of the associated RestApi.


This class forms part of Paws, documenting arguments for method PutMethod in Paws::ApiGateway


The source code is located here:

Please report bugs to: