DefaultGuardRailDetail

pydantic model openapi_client.models.default_guard_rail_detail.DefaultGuardRailDetail

Default guard rail as returned by GET /ai/guard-rails/default. Unlike GuardRailDetail (GET by id), Configuration stays nested and GuardRailArn/AccessType are not included.

Fields:

• configuration (openapi_client.models.guard_rail_configuration.GuardRailConfiguration | None)

• created_by (str | None)

• creation_time (str | None)

• description (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)

• scope (str | None)

• tier (str | None)

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

The unique identifier of the guard rail.

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

The name of the guard rail.

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

The version of the guard rail.

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

The description of 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.

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.

field configuration: Optional[GuardRailConfiguration] = None (alias 'Configuration')

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

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

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

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

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

Resources linked to this guard rail.

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

Always true for this endpoint.

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 DefaultGuardRailDetail 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 DefaultGuardRailDetail from a dict

Return type:

Optional[Self]