Class: Aws::BedrockAgentCoreControl::Types::UpdateGatewayRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCoreControl::Types::UpdateGatewayRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:name, :description]

Instance Attribute Summary

• #authorizer_configuration ⇒ Types::AuthorizerConfiguration

  The updated authorizer configuration for the gateway.

• #authorizer_type ⇒ String

  The updated authorizer type for the gateway.

• #description ⇒ String

  The updated description for the gateway.

• #exception_level ⇒ String

  The level of detail in error messages returned when invoking the gateway.

• #gateway_identifier ⇒ String

  The identifier of the gateway to update.

• #interceptor_configurations ⇒ Array<Types::GatewayInterceptorConfiguration>

  The updated interceptor configurations for the gateway.

• #kms_key_arn ⇒ String

  The updated ARN of the KMS key used to encrypt the gateway.

• #name ⇒ String

  The name of the gateway.

• #policy_engine_configuration ⇒ Types::GatewayPolicyEngineConfiguration

  The updated policy engine configuration for the gateway.

• #protocol_configuration ⇒ Types::GatewayProtocolConfiguration

  The configuration for a gateway protocol.

• #protocol_type ⇒ String

  The updated protocol type for the gateway.

• #role_arn ⇒ String

  The updated IAM role ARN that provides permissions for the gateway.

Instance Attribute Details

#authorizer_configuration ⇒ Types::AuthorizerConfiguration

The updated authorizer configuration for the gateway.

Returns:

• (Types::AuthorizerConfiguration)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 16191

class UpdateGatewayRequest < Struct.new(
  :gateway_identifier,
  :name,
  :description,
  :role_arn,
  :protocol_type,
  :protocol_configuration,
  :authorizer_type,
  :authorizer_configuration,
  :kms_key_arn,
  :interceptor_configurations,
  :policy_engine_configuration,
  :exception_level)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#authorizer_type ⇒ String

The updated authorizer type for the gateway.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 16191

class UpdateGatewayRequest < Struct.new(
  :gateway_identifier,
  :name,
  :description,
  :role_arn,
  :protocol_type,
  :protocol_configuration,
  :authorizer_type,
  :authorizer_configuration,
  :kms_key_arn,
  :interceptor_configurations,
  :policy_engine_configuration,
  :exception_level)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#description ⇒ String

The updated description for the gateway.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 16191

class UpdateGatewayRequest < Struct.new(
  :gateway_identifier,
  :name,
  :description,
  :role_arn,
  :protocol_type,
  :protocol_configuration,
  :authorizer_type,
  :authorizer_configuration,
  :kms_key_arn,
  :interceptor_configurations,
  :policy_engine_configuration,
  :exception_level)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#exception_level ⇒ String

The level of detail in error messages returned when invoking the gateway.

• If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

• If the value is omitted, a generic error message is returned to the end user.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 16191

class UpdateGatewayRequest < Struct.new(
  :gateway_identifier,
  :name,
  :description,
  :role_arn,
  :protocol_type,
  :protocol_configuration,
  :authorizer_type,
  :authorizer_configuration,
  :kms_key_arn,
  :interceptor_configurations,
  :policy_engine_configuration,
  :exception_level)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#gateway_identifier ⇒ String

The identifier of the gateway to update.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 16191

class UpdateGatewayRequest < Struct.new(
  :gateway_identifier,
  :name,
  :description,
  :role_arn,
  :protocol_type,
  :protocol_configuration,
  :authorizer_type,
  :authorizer_configuration,
  :kms_key_arn,
  :interceptor_configurations,
  :policy_engine_configuration,
  :exception_level)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#interceptor_configurations ⇒ Array<Types::GatewayInterceptorConfiguration>

The updated interceptor configurations for the gateway.

Returns:

• (Array<Types::GatewayInterceptorConfiguration>)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 16191

class UpdateGatewayRequest < Struct.new(
  :gateway_identifier,
  :name,
  :description,
  :role_arn,
  :protocol_type,
  :protocol_configuration,
  :authorizer_type,
  :authorizer_configuration,
  :kms_key_arn,
  :interceptor_configurations,
  :policy_engine_configuration,
  :exception_level)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#kms_key_arn ⇒ String

The updated ARN of the KMS key used to encrypt the gateway.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 16191

class UpdateGatewayRequest < Struct.new(
  :gateway_identifier,
  :name,
  :description,
  :role_arn,
  :protocol_type,
  :protocol_configuration,
  :authorizer_type,
  :authorizer_configuration,
  :kms_key_arn,
  :interceptor_configurations,
  :policy_engine_configuration,
  :exception_level)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#name ⇒ String

The name of the gateway. This name must be the same as the one when the gateway was created.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 16191

class UpdateGatewayRequest < Struct.new(
  :gateway_identifier,
  :name,
  :description,
  :role_arn,
  :protocol_type,
  :protocol_configuration,
  :authorizer_type,
  :authorizer_configuration,
  :kms_key_arn,
  :interceptor_configurations,
  :policy_engine_configuration,
  :exception_level)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#policy_engine_configuration ⇒ Types::GatewayPolicyEngineConfiguration

The updated policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.

Returns:

• (Types::GatewayPolicyEngineConfiguration)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 16191

class UpdateGatewayRequest < Struct.new(
  :gateway_identifier,
  :name,
  :description,
  :role_arn,
  :protocol_type,
  :protocol_configuration,
  :authorizer_type,
  :authorizer_configuration,
  :kms_key_arn,
  :interceptor_configurations,
  :policy_engine_configuration,
  :exception_level)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#protocol_configuration ⇒ Types::GatewayProtocolConfiguration

The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.

Returns:

• (Types::GatewayProtocolConfiguration)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 16191

class UpdateGatewayRequest < Struct.new(
  :gateway_identifier,
  :name,
  :description,
  :role_arn,
  :protocol_type,
  :protocol_configuration,
  :authorizer_type,
  :authorizer_configuration,
  :kms_key_arn,
  :interceptor_configurations,
  :policy_engine_configuration,
  :exception_level)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#protocol_type ⇒ String

The updated protocol type for the gateway.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 16191

class UpdateGatewayRequest < Struct.new(
  :gateway_identifier,
  :name,
  :description,
  :role_arn,
  :protocol_type,
  :protocol_configuration,
  :authorizer_type,
  :authorizer_configuration,
  :kms_key_arn,
  :interceptor_configurations,
  :policy_engine_configuration,
  :exception_level)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#role_arn ⇒ String

The updated IAM role ARN that provides permissions for the gateway.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 16191

class UpdateGatewayRequest < Struct.new(
  :gateway_identifier,
  :name,
  :description,
  :role_arn,
  :protocol_type,
  :protocol_configuration,
  :authorizer_type,
  :authorizer_configuration,
  :kms_key_arn,
  :interceptor_configurations,
  :policy_engine_configuration,
  :exception_level)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end