You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::APIGateway::Types::TestInvokeMethodRequest

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

Overview

Note:

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

{
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  path_with_query_string: "String",
  body: "String",
  headers: {
    "String" => "String",
  },
  client_certificate_id: "String",
  stage_variables: {
    "String" => "String",
  },
}

Make a request to simulate the execution of a Method.

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

The simulated request body of an incoming invocation request.

Returns:

  • (String)


5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5724

class TestInvokeMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :path_with_query_string,
  :body,
  :headers,
  :client_certificate_id,
  :stage_variables)
  include Aws::Structure
end

#client_certificate_idString

A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

Returns:

  • (String)


5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5724

class TestInvokeMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :path_with_query_string,
  :body,
  :headers,
  :client_certificate_id,
  :stage_variables)
  include Aws::Structure
end

#headersHash<String,String>

A key-value map of headers to simulate an incoming invocation request.

Returns:

  • (Hash<String,String>)


5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5724

class TestInvokeMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :path_with_query_string,
  :body,
  :headers,
  :client_certificate_id,
  :stage_variables)
  include Aws::Structure
end

#http_methodString

Specifies a test invoke method request's HTTP method.

Returns:

  • (String)


5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5724

class TestInvokeMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :path_with_query_string,
  :body,
  :headers,
  :client_certificate_id,
  :stage_variables)
  include Aws::Structure
end

#path_with_query_stringString

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

Returns:

  • (String)


5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5724

class TestInvokeMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :path_with_query_string,
  :body,
  :headers,
  :client_certificate_id,
  :stage_variables)
  include Aws::Structure
end

#resource_idString

Specifies a test invoke method request's resource ID.

Returns:

  • (String)


5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5724

class TestInvokeMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :path_with_query_string,
  :body,
  :headers,
  :client_certificate_id,
  :stage_variables)
  include Aws::Structure
end

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5724

class TestInvokeMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :path_with_query_string,
  :body,
  :headers,
  :client_certificate_id,
  :stage_variables)
  include Aws::Structure
end

#stage_variablesHash<String,String>

A key-value map of stage variables to simulate an invocation on a deployed Stage.

Returns:

  • (Hash<String,String>)


5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5724

class TestInvokeMethodRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :path_with_query_string,
  :body,
  :headers,
  :client_certificate_id,
  :stage_variables)
  include Aws::Structure
end