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

var description: String?

The description of the guardrail.

failureRecommendations

var failureRecommendations: List<String>?

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

guardrailArn

var guardrailArn: String?

The ARN of the guardrail.

guardrailId

var guardrailId: String?

The unique identifier of the guardrail.

kmsKeyArn

var kmsKeyArn: String?

The ARN of the KMS key that encrypts the guardrail.

name

var name: String?

The name of the guardrail.

sensitiveInformationPolicy

var sensitiveInformationPolicy: GuardrailSensitiveInformationPolicy?

The sensitive information policy that was configured for the guardrail.

status

var status: GuardrailStatus?

The status of the guardrail.

statusReasons

var statusReasons: List<String>?

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

topicPolicy

var topicPolicy: GuardrailTopicPolicy?

The topic policy that was configured for the guardrail.

updatedAt

var updatedAt: Instant?

The date and time at which the guardrail was updated.

version

var version: String?

The version of the guardrail.

wordPolicy

var wordPolicy: GuardrailWordPolicy?

The word policy that was configured for the guardrail.

Functions

contentPolicy

fun contentPolicy(block: GuardrailContentPolicy.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.bedrock.model.GuardrailContentPolicy inside the given block

contextualGroundingPolicy

fun contextualGroundingPolicy(block: GuardrailContextualGroundingPolicy.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.bedrock.model.GuardrailContextualGroundingPolicy inside the given block

crossRegionDetails

fun crossRegionDetails(block: GuardrailCrossRegionDetails.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.bedrock.model.GuardrailCrossRegionDetails inside the given block

sensitiveInformationPolicy

fun sensitiveInformationPolicy(block: GuardrailSensitiveInformationPolicy.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.bedrock.model.GuardrailSensitiveInformationPolicy inside the given block

topicPolicy

fun topicPolicy(block: GuardrailTopicPolicy.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.bedrock.model.GuardrailTopicPolicy inside the given block

wordPolicy

fun wordPolicy(block: GuardrailWordPolicy.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.bedrock.model.GuardrailWordPolicy inside the given block