Bedrock / Client / list_advanced_prompt_optimization_jobs

list_advanced_prompt_optimization_jobs¶

Bedrock.Client.list_advanced_prompt_optimization_jobs(**kwargs)¶

Lists the advanced prompt optimization jobs in your account.

Request Syntax

response = client.list_advanced_prompt_optimization_jobs(
    maxResults=123,
    nextToken='string',
    sortBy='CreationTime',
    sortOrder='Ascending'|'Descending'
)

Parameters:

maxResults (integer) – The maximum number of results to return in the response.
nextToken (string) – If the total number of results is greater than the maxResults value provided in the request, use this token in a subsequent request to get the next set of results.
sortBy (string) – The field to sort the results by.
sortOrder (string) – The sort order for the results.

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) –
  
  If the total number of results is greater than the maxResults value provided in the request, use this token in a subsequent request to get the next set of results.

Exceptions

Bedrock.Client.exceptions.AccessDeniedException
Bedrock.Client.exceptions.ValidationException
Bedrock.Client.exceptions.InternalServerException
Bedrock.Client.exceptions.ThrottlingException