AgentsforBedrock / Client / list_retrieval_instruction_versions

list_retrieval_instruction_versions

AgentsforBedrock.Client.list_retrieval_instruction_versions(**kwargs)

Lists the numbered versions of a retrieval instruction, newest first. DRAFT is not listed; read it with GetRetrievalInstruction without retrievalInstructionVersion. Results are paginated. Use the nextToken parameter to retrieve additional results.

See also: AWS API Documentation

Request Syntax

response = client.list_retrieval_instruction_versions(
    retrievalInstructionId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • retrievalInstructionId (string) –

    [REQUIRED]

    The identifier of the retrieval instruction whose versions to list.

  • maxResults (integer) – Specifies the maximum number of versions to return in a single page. The service enforces the effective upper bound.

  • nextToken (string) – The pagination token from a previous ListRetrievalInstructionVersions response.

Return type:

dict

Returns:

Response Syntax

{
    'retrievalInstructionVersionSummaries': [
        {
            'version': 'string',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • retrievalInstructionVersionSummaries (list) –

      The version summaries in this page, newest first.

      • (dict) –

        A summary of one numbered version of a retrieval instruction, without the content.

        • version (string) –

          The version number.

        • createdAt (datetime) –

          When this version was created.

    • nextToken (string) –

      The pagination token to pass to the next ListRetrievalInstructionVersions call, absent on the last page.

Exceptions