Class: Aws::APIGateway::Types::TestInvokeAuthorizerRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::TestInvokeAuthorizerRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-apigateway/types.rb
Overview
When making an API call, you may pass TestInvokeAuthorizerRequest data as a hash:
{
rest_api_id: "String", # required
authorizer_id: "String", # required
headers: {
"String" => "String",
},
multi_value_headers: {
"String" => ["String"],
},
path_with_query_string: "String",
body: "String",
stage_variables: {
"String" => "String",
},
additional_context: {
"String" => "String",
},
}
Make a request to simulate the execution of an Authorizer.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#additional_context ⇒ Hash<String,String>
[Optional] A key-value map of additional context variables.
-
#authorizer_id ⇒ String
[Required] Specifies a test invoke authorizer request’s Authorizer ID.
-
#body ⇒ String
[Optional] The simulated request body of an incoming invocation request.
-
#headers ⇒ Hash<String,String>
[Required] A key-value map of headers to simulate an incoming invocation request.
-
#multi_value_headers ⇒ Hash<String,Array<String>>
[Optional] The headers as a map from string to list of values to simulate an incoming invocation request.
-
#path_with_query_string ⇒ String
[Optional] The URI path, including query string, of the simulated invocation request.
-
#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
#additional_context ⇒ Hash<String,String>
[Optional] A key-value map of additional context variables.
6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6943 class TestInvokeAuthorizerRequest < Struct.new( :rest_api_id, :authorizer_id, :headers, :multi_value_headers, :path_with_query_string, :body, :stage_variables, :additional_context) SENSITIVE = [] include Aws::Structure end |
#authorizer_id ⇒ String
[Required] Specifies a test invoke authorizer request’s Authorizer ID.
6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6943 class TestInvokeAuthorizerRequest < Struct.new( :rest_api_id, :authorizer_id, :headers, :multi_value_headers, :path_with_query_string, :body, :stage_variables, :additional_context) SENSITIVE = [] include Aws::Structure end |
#body ⇒ String
[Optional] The simulated request body of an incoming invocation request.
6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6943 class TestInvokeAuthorizerRequest < Struct.new( :rest_api_id, :authorizer_id, :headers, :multi_value_headers, :path_with_query_string, :body, :stage_variables, :additional_context) SENSITIVE = [] include Aws::Structure end |
#headers ⇒ Hash<String,String>
[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.
6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6943 class TestInvokeAuthorizerRequest < Struct.new( :rest_api_id, :authorizer_id, :headers, :multi_value_headers, :path_with_query_string, :body, :stage_variables, :additional_context) SENSITIVE = [] include Aws::Structure end |
#multi_value_headers ⇒ Hash<String,Array<String>>
[Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.
6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6943 class TestInvokeAuthorizerRequest < Struct.new( :rest_api_id, :authorizer_id, :headers, :multi_value_headers, :path_with_query_string, :body, :stage_variables, :additional_context) SENSITIVE = [] include Aws::Structure end |
#path_with_query_string ⇒ String
[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6943 class TestInvokeAuthorizerRequest < Struct.new( :rest_api_id, :authorizer_id, :headers, :multi_value_headers, :path_with_query_string, :body, :stage_variables, :additional_context) SENSITIVE = [] include Aws::Structure end |
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6943 class TestInvokeAuthorizerRequest < Struct.new( :rest_api_id, :authorizer_id, :headers, :multi_value_headers, :path_with_query_string, :body, :stage_variables, :additional_context) 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.
6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6943 class TestInvokeAuthorizerRequest < Struct.new( :rest_api_id, :authorizer_id, :headers, :multi_value_headers, :path_with_query_string, :body, :stage_variables, :additional_context) SENSITIVE = [] include Aws::Structure end |