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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:name, :description, :blocked_input_messaging, :blocked_outputs_messaging]

Instance Attribute Summary collapse

Instance Attribute Details

#blocked_input_messaging ⇒ String

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

Returns:

  • (String) 


1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :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) 


1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

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

#content_policy ⇒ Types::GuardrailContentPolicy

The content policy that was configured for the guardrail.

Returns:



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :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) 


1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

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

#description ⇒ String

The description of the guardrail.

Returns:

  • (String) 


1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :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>) 


1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

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

#guardrail_arn ⇒ String

The ARN of the guardrail that was created.

Returns:

  • (String) 


1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

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

#guardrail_id ⇒ String

The unique identifier of the guardrail.

Returns:

  • (String) 


1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :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) 


1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

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

#name ⇒ String

The name of the guardrail.

Returns:

  • (String) 


1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :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:



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

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

#status ⇒ String

The status of the guardrail.

Returns:

  • (String) 


1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :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>) 


1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

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

#topic_policy ⇒ Types::GuardrailTopicPolicy

The topic policy that was configured for the guardrail.

Returns:



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

class GetGuardrailResponse < Struct.new(
  :name,
  :description,
  :guardrail_id,
  :guardrail_arn,
  :version,
  :status,
  :topic_policy,
  :content_policy,
  :word_policy,
  :sensitive_information_policy,
  :created_at,
  :updated_at,
  :status_reasons,
  :failure_recommendations,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_arn)
  SENSITIVE = [:name, :description, :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) 


1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

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

#version ⇒ String

The version of the guardrail.

Returns:

  • (String) 


1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

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

#word_policy ⇒ Types::GuardrailWordPolicy

The word policy that was configured for the guardrail.

Returns:



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1325

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