Skip to content

CreateAIAgentRequest

Source code in docs_src/capo_qconnect/types/create_ai_agent_request.py
class CreateAIAgentRequest(TypedDict, closed=True):
    client_token: NotRequired["capo_qconnect.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>"""
    assistant_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>"""
    name: "capo_qconnect.types.name.Name"
    """<p>The name of the AI Agent.</p>"""
    type: "capo_qconnect.types.ai_agent_type.AIAgentType"
    """<p>The type of the AI Agent.</p>"""
    configuration: "capo_qconnect.types.ai_agent_configuration.AIAgentConfiguration"
    """<p>The configuration of the AI Agent.</p>"""
    visibility_status: "capo_qconnect.types.visibility_status.VisibilityStatus"
    """<p>The visibility status of the AI Agent.</p>"""
    tags: NotRequired["capo_qconnect.types.tags.Tags"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""
    description: NotRequired["capo_qconnect.types.description.Description"]
    """<p>The description of the AI Agent.</p>"""

assistant_id instance-attribute

assistant_id: UuidOrArn

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

configuration instance-attribute

configuration: AIAgentConfiguration

The configuration of the AI Agent.

description instance-attribute

description: NotRequired[Description]

The description of the AI Agent.

name instance-attribute

name: Name

The name of the AI Agent.

tags instance-attribute

tags: NotRequired[Tags]

The tags used to organize, track, or control access for this resource.

type instance-attribute

The type of the AI Agent.

visibility_status instance-attribute

visibility_status: VisibilityStatus

The visibility status of the AI Agent.