AgentsforBedrock / Paginator / ListRetrievalInstructions

ListRetrievalInstructions¶

class AgentsforBedrock.Paginator.ListRetrievalInstructions¶

paginator = client.get_paginator('list_retrieval_instructions')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    status='ACTIVE'|'INACTIVE',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

status (string) – Return only instructions with this availability status.
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

{
    'retrievalInstructionSummaries': [
        {
            'retrievalInstructionId': 'string',
            'retrievalInstructionArn': 'string',
            'name': 'string',
            'status': 'ACTIVE'|'INACTIVE',
            'lastTransitionStatus': 'CREATING'|'UPDATING'|'CREATE_SUCCESSFUL'|'CREATE_FAILED'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- retrievalInstructionSummaries (list) –
  
  The retrieval instruction summaries in this page.
  - (dict) –
    
    A summary of a retrieval instruction, without the content.
    - retrievalInstructionId (string) –
      
      The identifier of the retrieval instruction.
    - retrievalInstructionArn (string) –
      
      The ARN of the retrieval instruction.
    - name (string) –
      
      The name of the retrieval instruction.
    - status (string) –
      
      Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time.
    - lastTransitionStatus (string) –
      
      The outcome or in-progress state of the most recent create or update of the retrieval instruction.
    - createdAt (datetime) –
      
      When you created the retrieval instruction.
    - updatedAt (datetime) –
      
      When the retrieval instruction was last updated.
    - description (string) –
      
      A description of the retrieval instruction.
- NextToken (string) –
  
  A token to resume pagination.