Skip to content

RetrievalInstructionSummary

Source code in docs_src/capo_bedrock_agent/types/retrieval_instruction_summary.py
class RetrievalInstructionSummary(TypedDict, closed=True):
    retrieval_instruction_id: (
        "capo_bedrock_agent.types.retrieval_instruction_id.RetrievalInstructionId"
    )
    """<p>The identifier of the retrieval instruction.</p>"""
    retrieval_instruction_arn: (
        "capo_bedrock_agent.types.retrieval_instruction_arn.RetrievalInstructionArn"
    )
    """<p>The ARN of the retrieval instruction.</p>"""
    name: "capo_bedrock_agent.types.retrieval_instruction_name.RetrievalInstructionName"
    """<p>The name of the retrieval instruction.</p>"""
    status: "capo_bedrock_agent.types.retrieval_instruction_status.RetrievalInstructionStatus"
    """<p>Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time.</p>"""
    last_transition_status: "capo_bedrock_agent.types.retrieval_instruction_last_transition_status.RetrievalInstructionLastTransitionStatus"
    """<p>The outcome or in-progress state of the most recent create or update of the retrieval instruction.</p>"""
    created_at: "capo_bedrock_agent.types.date_timestamp.DateTimestamp"
    """<p>When you created the retrieval instruction.</p>"""
    updated_at: "capo_bedrock_agent.types.date_timestamp.DateTimestamp"
    """<p>When the retrieval instruction was last updated.</p>"""
    description: NotRequired[
        "capo_bedrock_agent.types.retrieval_instruction_description.RetrievalInstructionDescription"
    ]
    """<p>A description of the retrieval instruction.</p>"""

created_at instance-attribute

created_at: DateTimestamp

When you created the retrieval instruction.

description instance-attribute

description: NotRequired[RetrievalInstructionDescription]

A description of the retrieval instruction.

last_transition_status instance-attribute

The outcome or in-progress state of the most recent create or update of the retrieval instruction.

name instance-attribute

The name of the retrieval instruction.

retrieval_instruction_arn instance-attribute

retrieval_instruction_arn: RetrievalInstructionArn

The ARN of the retrieval instruction.

retrieval_instruction_id instance-attribute

retrieval_instruction_id: RetrievalInstructionId

The identifier of the retrieval instruction.

status instance-attribute

Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time.

updated_at instance-attribute

updated_at: DateTimestamp

When the retrieval instruction was last updated.