Para obter informações sobre uma versão do guardrail, envie uma GetGuardrailsolicitação e inclua o ID e a versão do guardrail. Se você não especificar uma versão, a resposta retornará detalhes da DRAFT versão.
A seguir está o formato da solicitação:
GET /guardrails/guardrailIdentifier?guardrailVersion=guardrailVersion HTTP/1.1
A seguir está o formato da resposta:
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"
}
Para listar informações sobre todas as suas grades de proteção, envie uma ListGuardrailssolicitação.
A seguir está o formato da solicitação:
GET /guardrails?guardrailIdentifier=guardrailIdentifier&maxResults=maxResults&nextToken=nextToken HTTP/1.1
-
Para listar a DRAFT versão de todas as suas grades de proteção, não especifique o guardrailIdentifier campo.
-
Para listar todas as versões de uma grade de proteção, especifique o ARN da grade de proteção no campo. guardrailIdentifier
Você pode definir o número máximo de resultados a serem retornados em uma resposta no maxResults campo. Se houver mais resultados do que o número definido, a resposta retornará um nextToken que você poderá enviar em outra solicitação ListGuardrails para ver o próximo lote de resultados.
A seguir está o formato da resposta:
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"
}
