Skip to content

GetRetrievalInstructionResponse

Source code in docs_src/capo_bedrock_agent/types/get_retrieval_instruction_response.py
class GetRetrievalInstructionResponse(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>Specifies whether you can use the instruction. You can resolve only an ACTIVE instruction at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.</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. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.</p>"""
    instruction: NotRequired[
        "capo_bedrock_agent.types.retrieval_instruction_content.RetrievalInstructionContent"
    ]
    """<p>The reviewed content this instruction serves — what AgenticRetrieveStream resolves while status is ACTIVE. Absent until the first create review passes. Always present on a numbered version.</p>"""
    created_at: "capo_bedrock_agent.types.date_timestamp.DateTimestamp"
    """<p>When the retrieval instruction was created. On a numbered version, when that version was created.</p>"""
    updated_at: "capo_bedrock_agent.types.date_timestamp.DateTimestamp"
    """<p>When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.</p>"""
    description: NotRequired[
        "capo_bedrock_agent.types.retrieval_instruction_description.RetrievalInstructionDescription"
    ]
    """<p>A description of the retrieval instruction. On a numbered version, the description of that version.</p>"""
    customer_encryption_key_arn: NotRequired[
        "capo_bedrock_agent.types.kms_key_arn.KmsKeyArn"
    ]
    """<p>The ARN of the customer managed KMS key protecting this content, when one was supplied at create.</p>"""
    last_transition_status_reasons: NotRequired[
        "capo_bedrock_agent.types.retrieval_instruction_failure_reasons.RetrievalInstructionFailureReasons"
    ]
    """<p>Why the most recent create or update was rejected. One entry for each rejected field, or a single entry when the review itself failed. Each entry has a machine-readable code and a message, and names the field when it applies to one. The service includes this field only when lastTransitionStatus is CREATE_FAILED or UPDATE_FAILED. Never present on a numbered version.</p>"""
    version: NotRequired[
        "capo_bedrock_agent.types.retrieval_instruction_version_selector.RetrievalInstructionVersionSelector"
    ]
    """<p>The version this response describes: a version number, or DRAFT.</p>"""
    latest_version: NotRequired[
        "capo_bedrock_agent.types.retrieval_instruction_numerical_version.RetrievalInstructionNumericalVersion"
    ]
    """<p>The largest version number that currently exists for this retrieval instruction, that is, the newest version you can retrieve. Present only on a DRAFT read, and only when at least one version exists. Because version numbers are never reused, deleting versions can leave gaps: this is the newest existing version, not a count and not the highest number ever created.</p>"""

created_at instance-attribute

created_at: DateTimestamp

When the retrieval instruction was created. On a numbered version, when that version was created.

customer_encryption_key_arn instance-attribute

customer_encryption_key_arn: NotRequired[KmsKeyArn]

The ARN of the customer managed KMS key protecting this content, when one was supplied at create.

description instance-attribute

description: NotRequired[RetrievalInstructionDescription]

A description of the retrieval instruction. On a numbered version, the description of that version.

instruction instance-attribute

instruction: NotRequired[RetrievalInstructionContent]

The reviewed content this instruction serves — what AgenticRetrieveStream resolves while status is ACTIVE. Absent until the first create review passes. Always present on a numbered version.

last_transition_status instance-attribute

The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.

last_transition_status_reasons instance-attribute

last_transition_status_reasons: NotRequired[RetrievalInstructionFailureReasons]

Why the most recent create or update was rejected. One entry for each rejected field, or a single entry when the review itself failed. Each entry has a machine-readable code and a message, and names the field when it applies to one. The service includes this field only when lastTransitionStatus is CREATE_FAILED or UPDATE_FAILED. Never present on a numbered version.

latest_version instance-attribute

latest_version: NotRequired[RetrievalInstructionNumericalVersion]

The largest version number that currently exists for this retrieval instruction, that is, the newest version you can retrieve. Present only on a DRAFT read, and only when at least one version exists. Because version numbers are never reused, deleting versions can leave gaps: this is the newest existing version, not a count and not the highest number ever created.

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

Specifies whether you can use the instruction. You can resolve only an ACTIVE instruction at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.

updated_at instance-attribute

updated_at: DateTimestamp

When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.

version instance-attribute

The version this response describes: a version number, or DRAFT.