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

Class: Aws::APIGateway::Types::TestInvokeAuthorizerRequest

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::TestInvokeAuthorizerRequest

Defined in:

gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

Note:

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",
  },
  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

• #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.

• #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.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6431

class TestInvokeAuthorizerRequest < Struct.new(
  :rest_api_id,
  :authorizer_id,
  :headers,
  :path_with_query_string,
  :body,
  :stage_variables,
  :additional_context)
  include Aws::Structure
end

#authorizer_id ⇒ String

[Required] Specifies a test invoke authorizer request's Authorizer ID.

Returns:

• (String)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6431

class TestInvokeAuthorizerRequest < Struct.new(
  :rest_api_id,
  :authorizer_id,
  :headers,
  :path_with_query_string,
  :body,
  :stage_variables,
  :additional_context)
  include Aws::Structure
end

#body ⇒ String

[Optional] The simulated request body of an incoming invocation request.

Returns:

• (String)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6431

class TestInvokeAuthorizerRequest < Struct.new(
  :rest_api_id,
  :authorizer_id,
  :headers,
  :path_with_query_string,
  :body,
  :stage_variables,
  :additional_context)
  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.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6431

class TestInvokeAuthorizerRequest < Struct.new(
  :rest_api_id,
  :authorizer_id,
  :headers,
  :path_with_query_string,
  :body,
  :stage_variables,
  :additional_context)
  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.

Returns:

• (String)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6431

class TestInvokeAuthorizerRequest < Struct.new(
  :rest_api_id,
  :authorizer_id,
  :headers,
  :path_with_query_string,
  :body,
  :stage_variables,
  :additional_context)
  include Aws::Structure
end

#rest_api_id ⇒ String

[Required] The string identifier of the associated RestApi.

Returns:

• (String)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6431

class TestInvokeAuthorizerRequest < Struct.new(
  :rest_api_id,
  :authorizer_id,
  :headers,
  :path_with_query_string,
  :body,
  :stage_variables,
  :additional_context)
  include Aws::Structure
end

#stage_variables ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6431

class TestInvokeAuthorizerRequest < Struct.new(
  :rest_api_id,
  :authorizer_id,
  :headers,
  :path_with_query_string,
  :body,
  :stage_variables,
  :additional_context)
  include Aws::Structure
end