1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. bedrock
  6. getRetrievalInstruction

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    Resource Type definition for AWS::Bedrock::RetrievalInstruction

    Using getRetrievalInstruction

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRetrievalInstruction(args: GetRetrievalInstructionArgs, opts?: InvokeOptions): Promise<GetRetrievalInstructionResult>
    function getRetrievalInstructionOutput(args: GetRetrievalInstructionOutputArgs, opts?: InvokeOutputOptions): Output<GetRetrievalInstructionResult>
    def get_retrieval_instruction(arn: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetRetrievalInstructionResult
    def get_retrieval_instruction_output(arn: pulumi.Input[Optional[str]] = None,
                                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetRetrievalInstructionResult]
    func LookupRetrievalInstruction(ctx *Context, args *LookupRetrievalInstructionArgs, opts ...InvokeOption) (*LookupRetrievalInstructionResult, error)
    func LookupRetrievalInstructionOutput(ctx *Context, args *LookupRetrievalInstructionOutputArgs, opts ...InvokeOption) LookupRetrievalInstructionResultOutput

    > Note: This function is named LookupRetrievalInstruction in the Go SDK.

    public static class GetRetrievalInstruction 
    {
        public static Task<GetRetrievalInstructionResult> InvokeAsync(GetRetrievalInstructionArgs args, InvokeOptions? opts = null)
        public static Output<GetRetrievalInstructionResult> Invoke(GetRetrievalInstructionInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetRetrievalInstructionResult> Invoke(GetRetrievalInstructionInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetRetrievalInstructionResult> getRetrievalInstruction(GetRetrievalInstructionArgs args, InvokeOptions options)
    public static Output<GetRetrievalInstructionResult> getRetrievalInstruction(GetRetrievalInstructionArgs args, InvokeOptions options)
    public static Output<GetRetrievalInstructionResult> getRetrievalInstruction(GetRetrievalInstructionArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: aws-native:bedrock:getRetrievalInstruction
      arguments:
        # arguments dictionary
    data "aws-native_bedrock_get_retrieval_instruction" "name" {
        # arguments
    }

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the resource.
    Arn string
    The Amazon Resource Name (ARN) of the resource.
    arn string
    The Amazon Resource Name (ARN) of the resource.
    arn String
    The Amazon Resource Name (ARN) of the resource.
    arn string
    The Amazon Resource Name (ARN) of the resource.
    arn str
    The Amazon Resource Name (ARN) of the resource.
    arn String
    The Amazon Resource Name (ARN) of the resource.

    getRetrievalInstruction Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the resource.
    CreatedAt string
    When the retrieval instruction was created. On a numbered version, when that version was created.
    Description string
    A description of the retrieval instruction. On a numbered version, the description of that version.
    Instruction Pulumi.AwsNative.Bedrock.Outputs.RetrievalInstructionInstruction
    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.
    LastTransitionStatus Pulumi.AwsNative.Bedrock.RetrievalInstructionLastTransitionStatus
    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.
    RetrievalInstructionId string
    The identifier of the retrieval instruction.
    Status Pulumi.AwsNative.Bedrock.RetrievalInstructionStatus
    Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    UpdatedAt string
    When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.
    Arn string
    The Amazon Resource Name (ARN) of the resource.
    CreatedAt string
    When the retrieval instruction was created. On a numbered version, when that version was created.
    Description string
    A description of the retrieval instruction. On a numbered version, the description of that version.
    Instruction RetrievalInstructionInstruction
    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.
    LastTransitionStatus RetrievalInstructionLastTransitionStatus
    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.
    RetrievalInstructionId string
    The identifier of the retrieval instruction.
    Status RetrievalInstructionStatus
    Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    UpdatedAt string
    When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.
    arn string
    The Amazon Resource Name (ARN) of the resource.
    created_at string
    When the retrieval instruction was created. On a numbered version, when that version was created.
    description string
    A description of the retrieval instruction. On a numbered version, the description of that version.
    instruction object
    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 "CREATING" | "UPDATING" | "CREATE_SUCCESSFUL" | "CREATE_FAILED" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED"
    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.
    retrieval_instruction_id string
    The identifier of the retrieval instruction.
    status "ACTIVE" | "INACTIVE"
    Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
    tags list(object)
    An array of key-value pairs to apply to this resource.
    updated_at string
    When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.
    arn String
    The Amazon Resource Name (ARN) of the resource.
    createdAt String
    When the retrieval instruction was created. On a numbered version, when that version was created.
    description String
    A description of the retrieval instruction. On a numbered version, the description of that version.
    instruction RetrievalInstructionInstruction
    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.
    lastTransitionStatus RetrievalInstructionLastTransitionStatus
    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.
    retrievalInstructionId String
    The identifier of the retrieval instruction.
    status RetrievalInstructionStatus
    Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    updatedAt String
    When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.
    arn string
    The Amazon Resource Name (ARN) of the resource.
    createdAt string
    When the retrieval instruction was created. On a numbered version, when that version was created.
    description string
    A description of the retrieval instruction. On a numbered version, the description of that version.
    instruction RetrievalInstructionInstruction
    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.
    lastTransitionStatus RetrievalInstructionLastTransitionStatus
    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.
    retrievalInstructionId string
    The identifier of the retrieval instruction.
    status RetrievalInstructionStatus
    Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    updatedAt string
    When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.
    arn str
    The Amazon Resource Name (ARN) of the resource.
    created_at str
    When the retrieval instruction was created. On a numbered version, when that version was created.
    description str
    A description of the retrieval instruction. On a numbered version, the description of that version.
    instruction RetrievalInstructionInstruction
    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 RetrievalInstructionLastTransitionStatus
    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.
    retrieval_instruction_id str
    The identifier of the retrieval instruction.
    status RetrievalInstructionStatus
    Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    updated_at str
    When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.
    arn String
    The Amazon Resource Name (ARN) of the resource.
    createdAt String
    When the retrieval instruction was created. On a numbered version, when that version was created.
    description String
    A description of the retrieval instruction. On a numbered version, the description of that version.
    instruction Property Map
    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.
    lastTransitionStatus "CREATING" | "UPDATING" | "CREATE_SUCCESSFUL" | "CREATE_FAILED" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED"
    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.
    retrievalInstructionId String
    The identifier of the retrieval instruction.
    status "ACTIVE" | "INACTIVE"
    Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    updatedAt String
    When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.

    Supporting Types

    RetrievalInstructionInstruction

    AnswerFormat string
    How the answer is structured, including how sources are cited.
    AnswerPolicy string
    Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.
    Persona string
    Who the assistant is: identity, tone and language.
    RetrievalGuidance string
    How to interpret and decompose the question, and what to prioritise when searching.
    AnswerFormat string
    How the answer is structured, including how sources are cited.
    AnswerPolicy string
    Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.
    Persona string
    Who the assistant is: identity, tone and language.
    RetrievalGuidance string
    How to interpret and decompose the question, and what to prioritise when searching.
    answer_format string
    How the answer is structured, including how sources are cited.
    answer_policy string
    Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.
    persona string
    Who the assistant is: identity, tone and language.
    retrieval_guidance string
    How to interpret and decompose the question, and what to prioritise when searching.
    answerFormat String
    How the answer is structured, including how sources are cited.
    answerPolicy String
    Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.
    persona String
    Who the assistant is: identity, tone and language.
    retrievalGuidance String
    How to interpret and decompose the question, and what to prioritise when searching.
    answerFormat string
    How the answer is structured, including how sources are cited.
    answerPolicy string
    Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.
    persona string
    Who the assistant is: identity, tone and language.
    retrievalGuidance string
    How to interpret and decompose the question, and what to prioritise when searching.
    answer_format str
    How the answer is structured, including how sources are cited.
    answer_policy str
    Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.
    persona str
    Who the assistant is: identity, tone and language.
    retrieval_guidance str
    How to interpret and decompose the question, and what to prioritise when searching.
    answerFormat String
    How the answer is structured, including how sources are cited.
    answerPolicy String
    Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.
    persona String
    Who the assistant is: identity, tone and language.
    retrievalGuidance String
    How to interpret and decompose the question, and what to prioritise when searching.

    RetrievalInstructionLastTransitionStatus

    NameValue
    CreatingCREATING
    UpdatingUPDATING
    CreateSuccessfulCREATE_SUCCESSFUL
    CreateFailedCREATE_FAILED
    UpdateSuccessfulUPDATE_SUCCESSFUL
    UpdateFailedUPDATE_FAILED
    NameValue
    RetrievalInstructionLastTransitionStatusCreatingCREATING
    RetrievalInstructionLastTransitionStatusUpdatingUPDATING
    RetrievalInstructionLastTransitionStatusCreateSuccessfulCREATE_SUCCESSFUL
    RetrievalInstructionLastTransitionStatusCreateFailedCREATE_FAILED
    RetrievalInstructionLastTransitionStatusUpdateSuccessfulUPDATE_SUCCESSFUL
    RetrievalInstructionLastTransitionStatusUpdateFailedUPDATE_FAILED
    Value
    CREATING
    UPDATING
    CREATE_SUCCESSFUL
    CREATE_FAILED
    UPDATE_SUCCESSFUL
    UPDATE_FAILED
    NameValue
    CreatingCREATING
    UpdatingUPDATING
    CreateSuccessfulCREATE_SUCCESSFUL
    CreateFailedCREATE_FAILED
    UpdateSuccessfulUPDATE_SUCCESSFUL
    UpdateFailedUPDATE_FAILED
    NameValue
    CreatingCREATING
    UpdatingUPDATING
    CreateSuccessfulCREATE_SUCCESSFUL
    CreateFailedCREATE_FAILED
    UpdateSuccessfulUPDATE_SUCCESSFUL
    UpdateFailedUPDATE_FAILED
    NameValue
    CREATINGCREATING
    UPDATINGUPDATING
    CREATE_SUCCESSFULCREATE_SUCCESSFUL
    CREATE_FAILEDCREATE_FAILED
    UPDATE_SUCCESSFULUPDATE_SUCCESSFUL
    UPDATE_FAILEDUPDATE_FAILED
    Value
    CREATING
    UPDATING
    CREATE_SUCCESSFUL
    CREATE_FAILED
    UPDATE_SUCCESSFUL
    UPDATE_FAILED

    RetrievalInstructionStatus

    NameValue
    ActiveACTIVE
    InactiveINACTIVE
    NameValue
    RetrievalInstructionStatusActiveACTIVE
    RetrievalInstructionStatusInactiveINACTIVE
    Value
    ACTIVE
    INACTIVE
    NameValue
    ActiveACTIVE
    InactiveINACTIVE
    NameValue
    ActiveACTIVE
    InactiveINACTIVE
    NameValue
    ACTIVEACTIVE
    INACTIVEINACTIVE
    Value
    ACTIVE
    INACTIVE

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial