Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1494674591.3 KB

Creates an Amazon Q in Connect AI Guardrail.

post/assistants/{assistantId}/aiguardrails

Path parameters

assistantIdstring required

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Request body

clientTokenstring

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..

namestring required

The name of the AI Guardrail.

blockedInputMessagingstring password required

Messaging for when violations are detected in text

blockedOutputsMessagingstring password required

Messaging for when violations are detected in text

visibilityStatus'SAVED' | 'PUBLISHED' required

The visibility status of the AI Guardrail.

descriptionstring password

Description of the guardrail or its version

tagsobject

The tags used to organize, track, or control access for this resource.

Response

Success