ガードレールのバージョンの作成と管理

ガードレールのバージョンを作成するには、 CreateGuardrailVersionリクエストを送信します。ID とオプションの説明を含めます。

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

POST /guardrails/guardrailIdentifier HTTP/1.1
Content-type: application/json


{
  "clientRequestToken": "string",
  "description": "string"
}

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

HTTP/1.1 202
Content-type: application/json

{
   "guardrailId": "string",
   "version": "string"
}

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

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

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

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

HTTP/1.1 200
Content-type: application/json

{
   "blockedInputMessaging": "string",
   "blockedOutputsMessaging": "string",
   "contentPolicy": { 
      "filters": [ 
         { 
            "inputStrength": "NONE | LOW | MEDIUM | HIGH",
            "outputStrength": "NONE | LOW | MEDIUM | HIGH",
            "type": "SEXUAL | VIOLENCE | HATE | INSULTS | MISCONDUCT | PROMPT_ATTACK"
         }
      ]
   },
    "wordPolicy": {
    "words": [
      {
        "text": "string"
      }
    ],
    "managedWordLists": [
      {
        "type": "string"
      }
    ]
  },
  "sensitiveInformationPolicy": {
    "piiEntities": [
      {
        "type": "string",
        "action": "string"
      }
    ],
    "regexes": [
      {
        "name": "string",
        "description": "string",
        "pattern": "string",
        "action": "string"
      }
    ]
  },
   "createdAt": "string",
   "description": "string",
   "failureRecommendations": [ "string" ],
   "guardrailArn": "string",
   "guardrailId": "string",
   "kmsKeyArn": "string",
   "name": "string",
   "status": "string",
   "statusReasons": [ "string" ],
   "topicPolicy": { 
      "topics": [ 
         { 
            "definition": "string",
            "examples": [ "string" ],
            "name": "string",
            "type": "DENY"
         }
      ]
   },
   "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"
}

バージョンが不要になった場合は、次の手順で削除できます。

ガードレールのバージョンを削除するには、 DeleteGuardrailリクエストを送信します。ガードレールの ARN を guardrailIdentifierフィールドに、バージョンを guardrailVersionフィールドに指定します。

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

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

削除が成功すると、レスポンスは HTTP 200 ステータスコードを返します。