AgentsforBedrock / Paginator / ListRetrievalInstructionVersions

ListRetrievalInstructionVersions

class AgentsforBedrock.Paginator.ListRetrievalInstructionVersions

paginator = client.get_paginator('list_retrieval_instruction_versions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AgentsforBedrock.Client.list_retrieval_instruction_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    retrievalInstructionId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• retrievalInstructionId (string) –

  [REQUIRED]

  The identifier of the retrieval instruction whose versions to list.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous 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) –

    A token to resume pagination.