Gets details about a guardrail¶

Description¶

Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.

Usage¶

bedrock_get_guardrail(guardrailIdentifier, guardrailVersion)

Arguments¶

guardrailIdentifier

[required] The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.
guardrailVersion

The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the DRAFT version.

Value¶

A list with the following syntax:

list(
  name = "string",
  description = "string",
  guardrailId = "string",
  guardrailArn = "string",
  version = "string",
  status = "CREATING"|"UPDATING"|"VERSIONING"|"READY"|"FAILED"|"DELETING",
  topicPolicy = list(
    topics = list(
      list(
        name = "string",
        definition = "string",
        examples = list(
          "string"
        ),
        type = "DENY",
        inputAction = "BLOCK"|"NONE",
        outputAction = "BLOCK"|"NONE",
        inputEnabled = TRUE|FALSE,
        outputEnabled = TRUE|FALSE
      )
    ),
    tier = list(
      tierName = "CLASSIC"|"STANDARD"
    )
  ),
  contentPolicy = list(
    filters = list(
      list(
        type = "SEXUAL"|"VIOLENCE"|"HATE"|"INSULTS"|"MISCONDUCT"|"PROMPT_ATTACK",
        inputStrength = "NONE"|"LOW"|"MEDIUM"|"HIGH",
        outputStrength = "NONE"|"LOW"|"MEDIUM"|"HIGH",
        inputModalities = list(
          "TEXT"|"IMAGE"
        ),
        outputModalities = list(
          "TEXT"|"IMAGE"
        ),
        inputAction = "BLOCK"|"NONE",
        outputAction = "BLOCK"|"NONE",
        inputEnabled = TRUE|FALSE,
        outputEnabled = TRUE|FALSE
      )
    ),
    tier = list(
      tierName = "CLASSIC"|"STANDARD"
    )
  ),
  wordPolicy = list(
    words = list(
      list(
        text = "string",
        inputAction = "BLOCK"|"NONE",
        outputAction = "BLOCK"|"NONE",
        inputEnabled = TRUE|FALSE,
        outputEnabled = TRUE|FALSE
      )
    ),
    managedWordLists = list(
      list(
        type = "PROFANITY",
        inputAction = "BLOCK"|"NONE",
        outputAction = "BLOCK"|"NONE",
        inputEnabled = TRUE|FALSE,
        outputEnabled = TRUE|FALSE
      )
    )
  ),
  sensitiveInformationPolicy = list(
    piiEntities = list(
      list(
        type = "ADDRESS"|"AGE"|"AWS_ACCESS_KEY"|"AWS_SECRET_KEY"|"CA_HEALTH_NUMBER"|"CA_SOCIAL_INSURANCE_NUMBER"|"CREDIT_DEBIT_CARD_CVV"|"CREDIT_DEBIT_CARD_EXPIRY"|"CREDIT_DEBIT_CARD_NUMBER"|"DRIVER_ID"|"EMAIL"|"INTERNATIONAL_BANK_ACCOUNT_NUMBER"|"IP_ADDRESS"|"LICENSE_PLATE"|"MAC_ADDRESS"|"NAME"|"PASSWORD"|"PHONE"|"PIN"|"SWIFT_CODE"|"UK_NATIONAL_HEALTH_SERVICE_NUMBER"|"UK_NATIONAL_INSURANCE_NUMBER"|"UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"|"URL"|"USERNAME"|"US_BANK_ACCOUNT_NUMBER"|"US_BANK_ROUTING_NUMBER"|"US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER"|"US_PASSPORT_NUMBER"|"US_SOCIAL_SECURITY_NUMBER"|"VEHICLE_IDENTIFICATION_NUMBER",
        action = "BLOCK"|"ANONYMIZE"|"NONE",
        inputAction = "BLOCK"|"ANONYMIZE"|"NONE",
        outputAction = "BLOCK"|"ANONYMIZE"|"NONE",
        inputEnabled = TRUE|FALSE,
        outputEnabled = TRUE|FALSE
      )
    ),
    regexes = list(
      list(
        name = "string",
        description = "string",
        pattern = "string",
        action = "BLOCK"|"ANONYMIZE"|"NONE",
        inputAction = "BLOCK"|"ANONYMIZE"|"NONE",
        outputAction = "BLOCK"|"ANONYMIZE"|"NONE",
        inputEnabled = TRUE|FALSE,
        outputEnabled = TRUE|FALSE
      )
    )
  ),
  contextualGroundingPolicy = list(
    filters = list(
      list(
        type = "GROUNDING"|"RELEVANCE",
        threshold = 123.0,
        action = "BLOCK"|"NONE",
        enabled = TRUE|FALSE
      )
    )
  ),
  automatedReasoningPolicy = list(
    policies = list(
      "string"
    ),
    confidenceThreshold = 123.0
  ),
  crossRegionDetails = list(
    guardrailProfileId = "string",
    guardrailProfileArn = "string"
  ),
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  updatedAt = as.POSIXct(
    "2015-01-01"
  ),
  statusReasons = list(
    "string"
  ),
  failureRecommendations = list(
    "string"
  ),
  blockedInputMessaging = "string",
  blockedOutputsMessaging = "string",
  kmsKeyArn = "string"
)

Request syntax¶

svc$get_guardrail(
  guardrailIdentifier = "string",
  guardrailVersion = "string"
)