Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14108906717.7 KB

Gets details about a guardrail. If you don't specify a version, the response returns details for the <code>DRAFT</code> version.

get/guardrails/{guardrailIdentifier}

Path parameters

guardrailIdentifierstring required

The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.

Query parameters

guardrailVersionstring

The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the <code>DRAFT</code> version.

Response

Success

namestring password required

The name of the guardrail.

descriptionstring password

The description of the guardrail.

guardrailIdstring required

The unique identifier of the guardrail.

guardrailArnstring required

The ARN of the guardrail.

versionstring required

The version of the guardrail.

status'CREATING' | 'UPDATING' | 'VERSIONING' | 'READY' | 'FAILED' | 'DELETING' required

The status of the guardrail.

createdAtstring date-time required

The date and time at which the guardrail was created.

updatedAtstring date-time required

The date and time at which the guardrail was updated.

statusReasonsGuardrailStatusReason[]

Appears if the <code>status</code> is <code>FAILED</code>. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

failureRecommendationsGuardrailFailureRecommendation[]

Appears if the <code>status</code> of the guardrail is <code>FAILED</code>. A list of recommendations to carry out before retrying the request.

blockedInputMessagingstring password required

The message that the guardrail returns when it blocks a prompt.

blockedOutputsMessagingstring password required

The message that the guardrail returns when it blocks a model response.

kmsKeyArnstring

The ARN of the KMS key that encrypts the guardrail.