Per ottenere informazioni su una versione del guardrail, invia una GetGuardrailrichiesta e includi l'ID e la versione del guardrail. Se non specifichi una versione, la risposta restituisce i dettagli relativi alla DRAFT
versione.
Di seguito è riportato il formato della richiesta:
GET /guardrails/guardrailIdentifier
?guardrailVersion=guardrailVersion
HTTP/1.1
Di seguito è riportato il formato della risposta:
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"
}
Per elencare le informazioni su tutti i tuoi guardrail, invia una ListGuardrailsrichiesta.
Di seguito è riportato il formato della richiesta:
GET /guardrails?guardrailIdentifier=guardrailIdentifier
&maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
-
Per elencare la DRAFT
versione di tutti i tuoi guardrail, non specificare il guardrailIdentifier
campo.
-
Per elencare tutte le versioni di un guardrail, specificare l'ARN del guardrail nel campo. guardrailIdentifier
È possibile impostare il numero massimo di risultati da restituire in una risposta nel campo. maxResults
Se i risultati sono superiori al numero impostato, la risposta restituisce un nextToken
che puoi inviare in un'altra richiesta ListGuardrails
per visualizzare il successivo batch di risultati.
Di seguito è riportato il formato della risposta:
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"
}