Class: Aws::APIGateway::Types::TestInvokeMethodRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::TestInvokeMethodRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-apigateway/types.rb
Overview
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",
},
multi_value_headers: {
"String" => ["String"],
},
client_certificate_id: "String",
stage_variables: {
"String" => "String",
},
}
Make a request to simulate the execution of a Method.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#body ⇒ String
The simulated request body of an incoming invocation request.
-
#client_certificate_id ⇒ String
A ClientCertificate identifier to use in the test invocation.
-
#headers ⇒ 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.
-
#multi_value_headers ⇒ 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.
-
#resource_id ⇒ String
[Required] Specifies a test invoke method request’s resource ID.
-
#rest_api_id ⇒ 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.
Instance Attribute Details
#body ⇒ String
The simulated request body of an incoming invocation request.
7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 |
# File 'lib/aws-sdk-apigateway/types.rb', line 7008 class TestInvokeMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :path_with_query_string, :body, :headers, :multi_value_headers, :client_certificate_id, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#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.
7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 |
# File 'lib/aws-sdk-apigateway/types.rb', line 7008 class TestInvokeMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :path_with_query_string, :body, :headers, :multi_value_headers, :client_certificate_id, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#headers ⇒ Hash<String,String>
A key-value map of headers to simulate an incoming invocation request.
7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 |
# File 'lib/aws-sdk-apigateway/types.rb', line 7008 class TestInvokeMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :path_with_query_string, :body, :headers, :multi_value_headers, :client_certificate_id, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#http_method ⇒ String
[Required] Specifies a test invoke method request’s HTTP method.
7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 |
# File 'lib/aws-sdk-apigateway/types.rb', line 7008 class TestInvokeMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :path_with_query_string, :body, :headers, :multi_value_headers, :client_certificate_id, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#multi_value_headers ⇒ Hash<String,Array<String>>
The headers as a map from string to list of values to simulate an incoming invocation request.
7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 |
# File 'lib/aws-sdk-apigateway/types.rb', line 7008 class TestInvokeMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :path_with_query_string, :body, :headers, :multi_value_headers, :client_certificate_id, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#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.
7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 |
# File 'lib/aws-sdk-apigateway/types.rb', line 7008 class TestInvokeMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :path_with_query_string, :body, :headers, :multi_value_headers, :client_certificate_id, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#resource_id ⇒ String
[Required] Specifies a test invoke method request’s resource ID.
7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 |
# File 'lib/aws-sdk-apigateway/types.rb', line 7008 class TestInvokeMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :path_with_query_string, :body, :headers, :multi_value_headers, :client_certificate_id, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 |
# File 'lib/aws-sdk-apigateway/types.rb', line 7008 class TestInvokeMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :path_with_query_string, :body, :headers, :multi_value_headers, :client_certificate_id, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#stage_variables ⇒ Hash<String,String>
A key-value map of stage variables to simulate an invocation on a deployed Stage.
7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 |
# File 'lib/aws-sdk-apigateway/types.rb', line 7008 class TestInvokeMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :path_with_query_string, :body, :headers, :multi_value_headers, :client_certificate_id, :stage_variables) SENSITIVE = [] include Aws::Structure end |