Bedrock / Paginator / ListAdvancedPromptOptimizationJobs

ListAdvancedPromptOptimizationJobs

class Bedrock.Paginator.ListAdvancedPromptOptimizationJobs
paginator = client.get_paginator('list_advanced_prompt_optimization_jobs')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Bedrock.Client.list_advanced_prompt_optimization_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    sortBy='CreationTime',
    sortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • sortBy (string) – Field to sort by in the returned list of jobs.

  • sortOrder (string) – Sort order for the results.

  • 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

{
    'jobSummaries': [
        {
            'jobArn': 'string',
            'jobName': 'string',
            'jobStatus': 'InProgress'|'Completed'|'Failed'|'PartiallyCompleted'|'Stopping'|'Stopped'|'Deleting',
            'creationTime': datetime(2015, 1, 1),
            'lastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    List Advanced Prompt Optimization Jobs Response

    • jobSummaries (list) –

      List of advanced prompt optimization job summaries.

      • (dict) –

        Summary of an advanced prompt optimization job.

        • jobArn (string) –

          ARN of the advanced prompt optimization job.

        • jobName (string) –

          Name of the advanced prompt optimization job.

        • jobStatus (string) –

          Status of the advanced prompt optimization job.

        • creationTime (datetime) –

          Creation time of the advanced prompt optimization job.

        • lastModifiedTime (datetime) –

          Last modified time of the advanced prompt optimization job.

    • NextToken (string) –

      A token to resume pagination.