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) – The field to sort the results by.
sortOrder (string) – The 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
NextTokenwill 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
NextTokenfrom 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) –
A list of advanced prompt optimization job summaries.
(dict) –
Contains a summary of an advanced prompt optimization job.
jobArn (string) –
The Amazon Resource Name (ARN) of the job.
jobName (string) –
The name of the job.
jobStatus (string) –
The status of the job.
creationTime (datetime) –
The time at which the job was created.
lastModifiedTime (datetime) –
The time at which the job was last modified.
NextToken (string) –
A token to resume pagination.