AgentsforBedrock / Paginator / ListPrompts

ListPrompts#

class AgentsforBedrock.Paginator.ListPrompts#

paginator = client.get_paginator('list_prompts')

paginate(**kwargs)#

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

Request Syntax

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

Parameters:

promptIdentifier (string) – The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.
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

{
    'promptSummaries': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'id': 'string',
            'name': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'version': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- promptSummaries (list) –
  
  A list, each member of which contains information about a prompt using Prompt management.
  - (dict) –
    
    Contains information about a prompt in your Prompt management tool.
    
    This data type is used in the following API operations:
    - ListPrompts response
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
    - createdAt (datetime) –
      
      The time at which the prompt was created.
    - description (string) –
      
      The description of the prompt.
    - id (string) –
      
      The unique identifier of the prompt.
    - name (string) –
      
      The name of the prompt.
    - updatedAt (datetime) –
      
      The time at which the prompt was last updated.
    - version (string) –
      
      The version of the prompt that this summary applies to.
- NextToken (string) –
  
  A token to resume pagination.