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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing TestInvokeMethodRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  path_with_query_string: "String",
  body: "String",
  headers: {
    "String" => "String",
  },
  multi_value_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

#body ⇒ String

The simulated request body of an incoming invocation request.

Returns:

  • (String) —

    The simulated request body of an incoming invocation request.

#client_certificate_id ⇒ String

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:

#headers ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) —

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

#http_method ⇒ String

[Required] Specifies a test invoke method request\'s HTTP method.

Returns:

  • (String) —

    [Required] Specifies a test invoke method request\'s HTTP method.

#multi_value_headers ⇒ Hash<String,Array<String>>

The headers as a map from string to list of values to simulate an incoming invocation request.

Returns:

  • (Hash<String,Array<String>>) —

    The headers as a map from string to list of values to simulate an incoming invocation request.

#path_with_query_string ⇒ String

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

Returns:

  • (String) —

    The URI path, including query string, of the simulated invocation request.

#resource_id ⇒ String

[Required] Specifies a test invoke method request\'s resource ID.

Returns:

  • (String) —

    [Required] Specifies a test invoke method request\'s resource ID.

#rest_api_id ⇒ String

[Required] The string identifier of the associated RestApi.

Returns:

  • (String) —

    [Required] The string identifier of the associated RestApi.

#stage_variables ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) —

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