GuardrailSummary
Contains details about a guardrail.
This data type is used in the following API operations:
Contents
- arn
-
The ARN of the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+Required: Yes
- createdAt
-
The date and time at which the guardrail was created.
Type: Timestamp
Required: Yes
- id
-
The unique identifier of the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern:
[a-z0-9]+Required: Yes
- name
-
The name of the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
[0-9a-zA-Z-_]+Required: Yes
- status
-
The status of the guardrail.
Type: String
Valid Values:
CREATING | UPDATING | VERSIONING | READY | FAILED | DELETINGRequired: Yes
- updatedAt
-
The date and time at which the guardrail was last updated.
Type: Timestamp
Required: Yes
- version
-
The version of the guardrail.
Type: String
Pattern:
(([1-9][0-9]{0,7})|(DRAFT))Required: Yes
- crossRegionDetails
-
Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).
Type: GuardrailCrossRegionDetails object
Required: No
- description
-
A description of the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: