Para obtener información sobre una versión de barandilla, envíe una GetGuardrailsolicitud e incluya el identificador y la versión de la barandilla. Si no especificas una versión, la respuesta devuelve los detalles de la versión. DRAFT
El formato de solicitud es el siguiente:
GET /guardrails/guardrailIdentifier
?guardrailVersion=guardrailVersion
HTTP/1.1
El siguiente es el formato de respuesta:
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 obtener información sobre todas sus barandillas, envíe una ListGuardrailssolicitud.
El formato de solicitud es el siguiente:
GET /guardrails?guardrailIdentifier=guardrailIdentifier
&maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
-
Para mostrar la DRAFT
versión de todas tus barandillas, no especifiques el guardrailIdentifier
campo.
-
Para ver todas las versiones de una barandilla, especifique el ARN de la barandilla en el campo. guardrailIdentifier
Puede establecer el número máximo de resultados que se devolverán en una respuesta en el campo. maxResults
Si hay más resultados que la cantidad que ha establecido, la respuesta devuelve un nextToken
que puede enviar en otra solicitud ListGuardrails
para ver el siguiente lote de resultados.
El formato de respuesta es el siguiente:
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"
}