GuardRailDetail

pydantic model openapi_client.models.guard_rail_detail.GuardRailDetail

Detailed information about a guard rail from GET /ai/guard-rails/{id}. Configuration fields are flattened onto the top level.

Fields:

• access_type (str | None)

• automated_reasoning_policies (List[str] | None)

• blocked_message (str | None)

• created_by (str | None)

• creation_time (str | None)

• custom_word_filters (openapi_client.models.custom_word_filters.CustomWordFilters | None)

• denied_topics (List[openapi_client.models.denied_topic.DeniedTopic] | None)

• description (str | None)

• enable_contextual_grounding_check (bool | None)

• filters_config (List[openapi_client.models.guard_rail_filter_config.GuardRailFilterConfig] | None)

• grounding_threshold (float | int | None)

• guard_rail_arn (str | None)

• guard_rail_id (str | None)

• guard_rail_name (str | None)

• guard_rail_version (str | None)

• is_cross_region_enabled (bool | None)

• is_default (bool | None)

• last_modified_by (str | None)

• last_modified_time (str | None)

• linked_entities (Dict[str, Any] | None)

• owner (str | None)

• policies_confidence_threshold (float | int | None)

• relevance_threshold (float | int | None)

• scope (str | None)

• sensitive_information_filters (openapi_client.models.sensitive_information_filters.SensitiveInformationFilters | None)

• tier (str | None)

field guard_rail_id: Optional[StrictStr] = None (alias 'GuardRailId')

The unique identifier of the guard rail.

field guard_rail_version: Optional[StrictStr] = None (alias 'GuardRailVersion')

The version of the guard rail (e.g., DRAFT, PUBLISHED).

field guard_rail_name: Optional[StrictStr] = None (alias 'GuardRailName')

The name of the guard rail.

field guard_rail_arn: Optional[StrictStr] = None (alias 'GuardRailArn')

The guard rail ARN.

field description: Optional[StrictStr] = None (alias 'Description')

The description of the guard rail.

field creation_time: Optional[StrictStr] = None (alias 'CreationTime')

The timestamp when the guard rail was created.

field created_by: Optional[StrictStr] = None (alias 'CreatedBy')

The user who created the guard rail.

field last_modified_time: Optional[StrictStr] = None (alias 'LastModifiedTime')

The timestamp when the guard rail was last modified.

field last_modified_by: Optional[StrictStr] = None (alias 'LastModifiedBy')

The user who last modified the guard rail.

field tier: Optional[StrictStr] = None (alias 'Tier')

The tier of the guard rail (CLASSIC or STANDARD).

field is_cross_region_enabled: Optional[StrictBool] = None (alias 'IsCrossRegionEnabled')

Whether cross-region configuration is enabled for the guard rail.

field scope: Optional[StrictStr] = None (alias 'Scope')

The scope of the guard rail (global or private).

field owner: Optional[StrictStr] = None (alias 'Owner')

The owner of the guard rail (user ID for private, system user for global scope).

field blocked_message: Optional[StrictStr] = None (alias 'BlockedMessage')

The message to display when content is blocked.

field filters_config: Optional[List[GuardRailFilterConfig]] = None (alias 'FiltersConfig')

Configuration for content filters.

field denied_topics: Optional[List[DeniedTopic]] = None (alias 'DeniedTopics')

List of topics that are denied.

field sensitive_information_filters: Optional[SensitiveInformationFilters] = None (alias 'SensitiveInformationFilters')

field custom_word_filters: Optional[CustomWordFilters] = None (alias 'CustomWordFilters')

field enable_contextual_grounding_check: Optional[StrictBool] = None (alias 'EnableContextualGroundingCheck')

Whether to enable contextual grounding check.

field grounding_threshold: Optional[Union[StrictFloat, StrictInt]] = None (alias 'GroundingThreshold')

The threshold for grounding check.

field relevance_threshold: Optional[Union[StrictFloat, StrictInt]] = None (alias 'RelevanceThreshold')

The threshold for relevance check.

field automated_reasoning_policies: Optional[Annotated[List[StrictStr], Field(max_length=2)]] = None (alias 'AutomatedReasoningPolicies')

Automated Reasoning policy ARNs attached to this guard rail (flattened from Configuration).

field policies_confidence_threshold: Optional[Union[Annotated[float, Field(le=1, strict=True, ge=0)], Annotated[int, Field(le=1, strict=True, ge=0)]]] = None (alias 'PoliciesConfidenceThreshold')

Confidence threshold for Automated Reasoning policies (flattened from Configuration).

field linked_entities: Optional[Dict[str, Any]] = None (alias 'LinkedEntities')

Resources linked to this guard rail (e.g. knowledge bases, agents, components).

field access_type: Optional[StrictStr] = None (alias 'AccessType')

The access type of the guard rail.

field is_default: Optional[StrictBool] = None (alias 'IsDefault')

Whether the guard rail is the default guard rail.

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of GuardRailDetail from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of GuardRailDetail from a dict

Return type:

Optional[Self]