Class: Aws::APIGateway::Types::PutMethodRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass PutMethodRequest data as a hash:

{
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  authorization_type: "String", # required
  authorizer_id: "String",
  api_key_required: false,
  operation_name: "String",
  request_parameters: {
    "String" => false,
  },
  request_models: {
    "String" => "String",
  },
  request_validator_id: "String",
  authorization_scopes: ["String"],
}

Request to add a method to an existing Resource resource.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_key_requiredBoolean

Specifies whether the method required a valid ApiKey.

Returns:

  • (Boolean)

5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
# File 'lib/aws-sdk-apigateway/types.rb', line 5301

class PutMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :operation_name,
  :request_parameters,
  :request_models,
  :request_validator_id,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end

#authorization_scopesArray<String>

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.

Returns:

  • (Array<String>)

5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
# File 'lib/aws-sdk-apigateway/types.rb', line 5301

class PutMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :operation_name,
  :request_parameters,
  :request_models,
  :request_validator_id,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end

#authorization_typeString

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.

Returns:

  • (String)

5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
# File 'lib/aws-sdk-apigateway/types.rb', line 5301

class PutMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :operation_name,
  :request_parameters,
  :request_models,
  :request_validator_id,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end

#authorizer_idString

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.

Returns:

  • (String)

5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
# File 'lib/aws-sdk-apigateway/types.rb', line 5301

class PutMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :operation_name,
  :request_parameters,
  :request_models,
  :request_validator_id,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end

#http_methodString

Specifies the method request's HTTP method type.

Returns:

  • (String)

5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
# File 'lib/aws-sdk-apigateway/types.rb', line 5301

class PutMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :operation_name,
  :request_parameters,
  :request_models,
  :request_validator_id,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end

#operation_nameString

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

Returns:

  • (String)

5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
# File 'lib/aws-sdk-apigateway/types.rb', line 5301

class PutMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :operation_name,
  :request_parameters,
  :request_models,
  :request_validator_id,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end

#request_modelsHash<String,String>

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.

Returns:

  • (Hash<String,String>)

5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
# File 'lib/aws-sdk-apigateway/types.rb', line 5301

class PutMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :operation_name,
  :request_parameters,
  :request_models,
  :request_validator_id,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end

#request_parametersHash<String,Boolean>

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.

Returns:

  • (Hash<String,Boolean>)

5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
# File 'lib/aws-sdk-apigateway/types.rb', line 5301

class PutMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :operation_name,
  :request_parameters,
  :request_models,
  :request_validator_id,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end

#request_validator_idString

The identifier of a RequestValidator for validating the method request.

Returns:

  • (String)

5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
# File 'lib/aws-sdk-apigateway/types.rb', line 5301

class PutMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :operation_name,
  :request_parameters,
  :request_models,
  :request_validator_id,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end

#resource_idString

The Resource identifier for the new Method resource.

Returns:

  • (String)

5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
# File 'lib/aws-sdk-apigateway/types.rb', line 5301

class PutMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :operation_name,
  :request_parameters,
  :request_models,
  :request_validator_id,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)

5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
# File 'lib/aws-sdk-apigateway/types.rb', line 5301

class PutMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :operation_name,
  :request_parameters,
  :request_models,
  :request_validator_id,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end