CreateAgentRequestBody

pydantic model openapi_client.models.create_agent_request_body.CreateAgentRequestBody

CreateAgentRequestBody

Fields:

• agent_id (str)

• agent_name (str)

• agent_type (str)

• cost_tags (List[openapi_client.models.agent_cost_tag.AgentCostTag] | None)

• description (str)

• display_name (str | None)

• entry_point (str)

• model_id (str)

• python_version (str)

• resource_access_metadata (openapi_client.models.agent_resource_access_metadata.AgentResourceAccessMetadata | None)

• session_settings (openapi_client.models.agent_session_settings.AgentSessionSettings | None)

field agent_id: StrictStr [Required] (alias 'AgentId')

Must be the AgentId returned by GET /ai/agents?action=upload-script. The package zip must already be uploaded to that presigned URL.

Constraints:

• strict = True

field agent_name: Annotated[str, Field(min_length=3, strict=True, max_length=48)] [Required] (alias 'AgentName')

3-48 alphanumeric and underscore characters, starting with a letter. Hyphens are not allowed (IPV-1004). Must be unique (IPV-1018).

Constraints:

• strict = True

• min_length = 3

• max_length = 48

field display_name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None (alias 'DisplayName')

Optional UI label. When omitted, AgentName is stored as DisplayName.

field description: Annotated[str, Field(strict=True, max_length=200)] [Required] (alias 'Description')

Description of the agent (maximum 200 characters).

Constraints:

• strict = True

• max_length = 200

field model_id: StrictStr [Required] (alias 'ModelId')

Model ID assigned to the agents component.

Constraints:

• strict = True

field python_version: StrictStr [Required] (alias 'PythonVersion')

Constraints:

• strict = True

field entry_point: StrictStr [Required] (alias 'EntryPoint')

Entry point file in the agent package; must end with .py.

Constraints:

• strict = True

field agent_type: StrictStr [Required] (alias 'AgentType')

Must be CUSTOM for AgentCore create.

Constraints:

• strict = True

field session_settings: Optional[AgentSessionSettings] = None (alias 'SessionSettings')

field cost_tags: Optional[List[AgentCostTag]] = None (alias 'CostTags')

Accepted when cost management is enabled; otherwise IPV-1040 unknown keys.

field resource_access_metadata: Optional[AgentResourceAccessMetadata] = None (alias 'ResourceAccessMetadata')

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

Return type:

Optional[Self]