ガードレールに関する情報を表示する

作業中のドラフトおよびガードレールバージョンの詳細については、「ガードレールをデプロイする」を参照してください。

ガードレールに関する情報を取得するには、GetGuardrail リクエストを送信し、ガードレールの ID とバージョンを指定します。バージョンを指定しない場合、DRAFT バージョンの詳細が返されます。

リクエストの形式は次のとおりです。

GET /guardrails/guardrailIdentifier?guardrailVersion=guardrailVersion HTTP/1.1

レスポンスの形式は次のとおりです。

HTTP/1.1 200
Content-type: application/json

{
  "topicPolicy": {
    "topics": [
      {
        "definition": "string",
        "examples": [
          "string"
        ],
        "name": "string",
        "type": "DENY"
      }
    ]
  },
  "contentPolicy": {
    "filters": [
      {
        "type": "string",
        "inputStrength": "string",
        "outputStrength": "string"
      }
    ]
  },
  "wordPolicy": {
    "words": [
      {
        "text": "string"
      }
    ],
    "managedWordLists": [
      {
        "type": "string"
      }
    ]
  },
  "sensitiveInformationPolicy": {
    "piiEntities": [
      {
        "type": "string",
        "action": "string"
      }
    ],
    "regexes": [
      {
        "name": "string",
        "description": "string",
        "regex": "string",
        "action": "string"
      }
    ]
  },
  "contextualGroundingPolicy": {
    "groundingFilter": {
      "threshold": float
    },
    "relevanceFilter": {
      "threshold": float
    }
  },
  "createdAt": "string",
  "blockedInputMessaging": "string",
  "blockedOutputsMessaging": "string",
  "description": "string",
  "failureRecommendations": [
    "string"
  ],
  "guardrailArn": "string",
  "guardrailId": "string",
  "kmsKeyArn": "string",
  "name": "string",
  "status": "string",
  "statusReasons": [
    "string"
  ],
  "updatedAt": "string",
  "version": "string"
}

すべてのガードレールに関する情報を一覧表示するには、ListGuardrails リクエストを送信します。

リクエストの形式は次のとおりです。

GET /guardrails?guardrailIdentifier=guardrailIdentifier&maxResults=maxResults&nextToken=nextToken HTTP/1.1

レスポンスで返す結果の最大数は、maxResults フィールドで設定できます。設定した数よりも多くの結果がある場合、レスポンスは nextToken を返します。これを別の ListGuardrails リクエストで送信すると、結果の次のバッチを確認できます。

レスポンスの形式は次のとおりです。

HTTP/1.1 200
Content-type: application/json

{
   "guardrails": [ 
      { 
         "arn": "string",
         "createdAt": "string",
         "description": "string",
         "id": "string",
         "name": "string",
         "status": "string",
         "updatedAt": "string",
         "version": "string"
      }
   ],
   "nextToken": "string"
}