You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::TestInvokeAuthorizerRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::TestInvokeAuthorizerRequest
- Defined in:
- (unknown)
Overview
When passing TestInvokeAuthorizerRequest as input to an Aws::Client method, you can use a vanilla 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.
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.
#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. This is where the incoming authorization token, or identity source, should be specified.
#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.
#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.
#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.