Class: Aws::Bedrock::Types::GetGuardrailResponse

Inherits:

Struct

• Object
• Struct
• Aws::Bedrock::Types::GetGuardrailResponse

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]

Instance Attribute Summary

• #automated_reasoning_policy ⇒ Types::GuardrailAutomatedReasoningPolicy

  The current Automated Reasoning policy configuration for the guardrail, if any is configured.

• #blocked_input_messaging ⇒ String

  The message that the guardrail returns when it blocks a prompt.

• #blocked_outputs_messaging ⇒ String

  The message that the guardrail returns when it blocks a model response.

• #content_policy ⇒ Types::GuardrailContentPolicy

  The content policy that was configured for the guardrail.

• #contextual_grounding_policy ⇒ Types::GuardrailContextualGroundingPolicy

  The contextual grounding policy used in the guardrail.

• #created_at ⇒ Time

  The date and time at which the guardrail was created.

• #cross_region_details ⇒ Types::GuardrailCrossRegionDetails

  Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

• #description ⇒ String

  The description of the guardrail.

• #failure_recommendations ⇒ Array<String>

  Appears if the status of the guardrail is FAILED.

• #guardrail_arn ⇒ String

  The ARN of the guardrail.

• #guardrail_id ⇒ String

  The unique identifier of the guardrail.

• #kms_key_arn ⇒ String

  The ARN of the KMS key that encrypts the guardrail.

• #name ⇒ String

  The name of the guardrail.

• #sensitive_information_policy ⇒ Types::GuardrailSensitiveInformationPolicy

  The sensitive information policy that was configured for the guardrail.

• #status ⇒ String

  The status of the guardrail.

• #status_reasons ⇒ Array<String>

  Appears if the status is FAILED.

• #topic_policy ⇒ Types::GuardrailTopicPolicy

  The topic policy that was configured for the guardrail.

• #updated_at ⇒ Time

  The date and time at which the guardrail was updated.

• #version ⇒ String

  The version of the guardrail.

• #word_policy ⇒ Types::GuardrailWordPolicy

  The word policy that was configured for the guardrail.

Instance Attribute Details

#automated_reasoning_policy ⇒ Types::GuardrailAutomatedReasoningPolicy

The current Automated Reasoning policy configuration for the guardrail, if any is configured.

Returns:

• (Types::GuardrailAutomatedReasoningPolicy)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#blocked_input_messaging ⇒ String

The message that the guardrail returns when it blocks a prompt.

Returns:

• (String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#blocked_outputs_messaging ⇒ String

The message that the guardrail returns when it blocks a model response.

Returns:

• (String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#content_policy ⇒ Types::GuardrailContentPolicy

The content policy that was configured for the guardrail.

Returns:

• (Types::GuardrailContentPolicy)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#contextual_grounding_policy ⇒ Types::GuardrailContextualGroundingPolicy

The contextual grounding policy used in the guardrail.

Returns:

• (Types::GuardrailContextualGroundingPolicy)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#created_at ⇒ Time

The date and time at which the guardrail was created.

Returns:

• (Time)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#cross_region_details ⇒ Types::GuardrailCrossRegionDetails

Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

Returns:

• (Types::GuardrailCrossRegionDetails)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#description ⇒ String

The description of the guardrail.

Returns:

• (String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#failure_recommendations ⇒ Array<String>

Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#guardrail_arn ⇒ String

The ARN of the guardrail.

Returns:

• (String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#guardrail_id ⇒ String

The unique identifier of the guardrail.

Returns:

• (String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#kms_key_arn ⇒ String

The ARN of the KMS key that encrypts the guardrail.

Returns:

• (String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#name ⇒ String

The name of the guardrail.

Returns:

• (String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#sensitive_information_policy ⇒ Types::GuardrailSensitiveInformationPolicy

The sensitive information policy that was configured for the guardrail.

Returns:

• (Types::GuardrailSensitiveInformationPolicy)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#status ⇒ String

The status of the guardrail.

Returns:

• (String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#status_reasons ⇒ Array<String>

Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#topic_policy ⇒ Types::GuardrailTopicPolicy

The topic policy that was configured for the guardrail.

Returns:

• (Types::GuardrailTopicPolicy)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#updated_at ⇒ Time

The date and time at which the guardrail was updated.

Returns:

• (Time)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#version ⇒ String

The version of the guardrail.

Returns:

• (String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#word_policy ⇒ Types::GuardrailWordPolicy

The word policy that was configured for the guardrail.

Returns:

• (Types::GuardrailWordPolicy)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6077

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :contextual_grounding_policy,
  :automated_reasoning_policy,
  :cross_region_details,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end