Class: Aws::APIGateway::Types::TestInvokeAuthorizerResponse

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::TestInvokeAuthorizerResponse

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

Represents the response of the test invoke request for a custom Authorizer

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #authorization ⇒ Hash<String,Array<String>>

  The authorization response.

• #claims ⇒ Hash<String,String>

  The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.

• #client_status ⇒ Integer

  The HTTP status code that the client would have received.

• #latency ⇒ Integer

  The execution latency, in ms, of the test authorizer request.

• #log ⇒ String

  The API Gateway execution log for the test authorizer request.

• #policy ⇒ String

  The JSON policy document returned by the Authorizer.

• #principal_id ⇒ String

  The principal identity returned by the Authorizer.

Instance Attribute Details

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

The authorization response.

Returns:

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

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

class TestInvokeAuthorizerResponse < Struct.new(
  :client_status,
  :log,
  :latency,
  :principal_id,
  :policy,
  :authorization,
  :claims)
  SENSITIVE = []
  include Aws::Structure
end

#claims ⇒ Hash<String,String>

The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.

Returns:

• (Hash<String,String>)

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

class TestInvokeAuthorizerResponse < Struct.new(
  :client_status,
  :log,
  :latency,
  :principal_id,
  :policy,
  :authorization,
  :claims)
  SENSITIVE = []
  include Aws::Structure
end

#client_status ⇒ Integer

The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.

Returns:

• (Integer)

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

class TestInvokeAuthorizerResponse < Struct.new(
  :client_status,
  :log,
  :latency,
  :principal_id,
  :policy,
  :authorization,
  :claims)
  SENSITIVE = []
  include Aws::Structure
end

#latency ⇒ Integer

The execution latency, in ms, of the test authorizer request.

Returns:

• (Integer)

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

class TestInvokeAuthorizerResponse < Struct.new(
  :client_status,
  :log,
  :latency,
  :principal_id,
  :policy,
  :authorization,
  :claims)
  SENSITIVE = []
  include Aws::Structure
end

#log ⇒ String

The API Gateway execution log for the test authorizer request.

Returns:

• (String)

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

class TestInvokeAuthorizerResponse < Struct.new(
  :client_status,
  :log,
  :latency,
  :principal_id,
  :policy,
  :authorization,
  :claims)
  SENSITIVE = []
  include Aws::Structure
end

#policy ⇒ String

The JSON policy document returned by the Authorizer

Returns:

• (String)

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

class TestInvokeAuthorizerResponse < Struct.new(
  :client_status,
  :log,
  :latency,
  :principal_id,
  :policy,
  :authorization,
  :claims)
  SENSITIVE = []
  include Aws::Structure
end

#principal_id ⇒ String

The principal identity returned by the Authorizer

Returns:

• (String)

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

class TestInvokeAuthorizerResponse < Struct.new(
  :client_status,
  :log,
  :latency,
  :principal_id,
  :policy,
  :authorization,
  :claims)
  SENSITIVE = []
  include Aws::Structure
end