GetAgentDetailsResponse¶
- pydantic model openapi_client.models.get_agent_details_response.GetAgentDetailsResponse¶
Default GET /ai/agents/{id} payload (no action). ARN attributes are omitted. SYSTEM agents use a reduced field set; UsableInChat is still added. Not the GET /ai/agents list row.
- field agent_id: StrictStr [Required] (alias 'AgentId')¶
- Constraints:
strict = True
- field agent_name: StrictStr [Required] (alias 'AgentName')¶
- Constraints:
strict = True
- field display_name: Optional[StrictStr] = None (alias 'DisplayName')¶
Human-readable label. Defaults to AgentName when not stored. Maximum 255 characters.
- field description: Optional[StrictStr] = None (alias 'Description')¶
- field agent_type: StrictStr [Required] (alias 'AgentType')¶
CUSTOM user-created AgentCore agent, SYSTEM platform agent, or MANAGED platform-managed agent.
- Constraints:
strict = True
- field agent_status: Optional[StrictStr] = None (alias 'AgentStatus')¶
- field agent_version: Optional[StrictStr] = None (alias 'AgentVersion')¶
AgentCore runtime version when present.
- field model_id: Optional[StrictStr] = None (alias 'ModelId')¶
- field reference_id: Optional[StrictStr] = None (alias 'ReferenceId')¶
AgentCore runtime ID for CUSTOM agents when the runtime exists.
- field message: Optional[StrictStr] = None (alias 'Message')¶
Status or runtime message stored on the agent (included for SYSTEM details).
- field access_type: Optional[StrictStr] = None (alias 'AccessType')¶
- field created_by: Optional[StrictStr] = None (alias 'CreatedBy')¶
- field creation_time: Optional[StrictStr] = None (alias 'CreationTime')¶
Timestamp in %Y-%m-%d %H:%M:%S.
- field last_modified_by: Optional[StrictStr] = None (alias 'LastModifiedBy')¶
- field last_modified_time: Optional[StrictStr] = None (alias 'LastModifiedTime')¶
Timestamp in %Y-%m-%d %H:%M:%S.
- field is_enabled: Optional[StrictBool] = None (alias 'IsEnabled')¶
- field usable_in_chat: Optional[StrictBool] = None (alias 'UsableInChat')¶
Whether the agent can be used in chat. Defaults to true when omitted from stored metadata.
- field agent_response_type: Optional[StrictStr] = None (alias 'AgentResponseType')¶
- field python_version: Optional[StrictStr] = None (alias 'PythonVersion')¶
- field entry_point: Optional[StrictStr] = None (alias 'EntryPoint')¶
- field session_settings: Optional[AgentSessionSettings] = None (alias 'SessionSettings')¶
- field resource_access_metadata: Optional[AgentResourceAccessMetadata] = None (alias 'ResourceAccessMetadata')¶
- field cost_tags: Optional[Annotated[List[ListAgentItemCostTagsInner], Field(max_length=100)]] = None (alias 'CostTags')¶
- field cost_inference_profile_details: Optional[GetAgentDetailsResponseCostInferenceProfileDetails] = None (alias 'CostInferenceProfileDetails')¶
- field agent_sessions: Optional[Dict[str, Any]] = None (alias 'AgentSessions')¶
Per-user chat session map stored on the agent. Present when sessions exist; not a listing field.
- field model_source: Optional[StrictStr] = None (alias 'ModelSource')¶
Model source stored on some SYSTEM/CUSTOM updates.
- 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 GetAgentDetailsResponse 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 GetAgentDetailsResponse from a dict
- Return type:
Optional[Self]