advanced_prompt_optimization_jobs

Creates, updates, deletes, gets or lists an advanced_prompt_optimization_jobs resource.

Overview

Name	advanced_prompt_optimization_jobs
Type	Resource
Id	aws.bedrock.advanced_prompt_optimization_jobs

Fields

The following fields are returned by SELECT queries:

get_advanced_prompt_optimization_job

Name	Datatype	Description
creation_time	string (date-time)	The time at which the advanced prompt optimization job was created.
encryption_key_arn	string	The Amazon Resource Name (ARN) of the KMS key used to encrypt the output data. (pattern: <code>arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}</code>)
failure_message	string	If the job failed, a message describing the reason for the failure.
input_config	object	Contains the input data configuration for an advanced prompt optimization job.
job_arn	string	The Amazon Resource Name (ARN) of the advanced prompt optimization job. (pattern: <code>arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:advanced-prompt-optimization-job/[a-z0-9]{12}</code>)
job_description	string	The description of an advanced prompt optimization job.
job_name	string	The name of an advanced prompt optimization job. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9.+-]*</code>)
job_status	string	The status of the advanced prompt optimization job. (InProgress, Completed, Failed, PartiallyCompleted, Stopping, Stopped, Deleting)
last_modified_time	string (date-time)	The time at which the advanced prompt optimization job was last modified.
model_configurations	array	A list of model configurations for advanced prompt optimization.
output_config	object	Contains the output data configuration for an advanced prompt optimization job.

list_advanced_prompt_optimization_jobs

Name	Datatype	Description
creation_time	string (date-time)	The time at which the job was created.
job_arn	string	The Amazon Resource Name (ARN) of the job. (pattern: <code>arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:advanced-prompt-optimization-job/[a-z0-9]{12}</code>)
job_name	string	The name of an advanced prompt optimization job. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9.+-]*</code>)
job_status	string	The status of the job. (InProgress, Completed, Failed, PartiallyCompleted, Stopping, Stopped, Deleting)
last_modified_time	string (date-time)	The time at which the job was last modified.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_advanced_prompt_optimization_job	select	job_identifier, region		Gets information about an advanced prompt optimization job.
list_advanced_prompt_optimization_jobs	select	region	maxResults, nextToken, sortBy, sortOrder	Lists the advanced prompt optimization jobs in your account.
create_advanced_prompt_optimization_job	insert	region, jobName, inputConfig, outputConfig, modelConfigurations		Creates an advanced prompt optimization job. The job optimizes your prompt templates for specific models using your evaluation dataset and criteria.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
job_identifier	string	The ARN or ID of the advanced prompt optimization job.
region	string	AWS region (default: us-east-1)
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.

SELECT examples

get_advanced_prompt_optimization_job

Gets information about an advanced prompt optimization job.

SELECT
creation_time,
encryption_key_arn,
failure_message,
input_config,
job_arn,
job_description,
job_name,
job_status,
last_modified_time,
model_configurations,
output_config
FROM aws.bedrock.advanced_prompt_optimization_jobs
WHERE job_identifier = '{{ job_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_advanced_prompt_optimization_jobs

Lists the advanced prompt optimization jobs in your account.

SELECT
creation_time,
job_arn,
job_name,
job_status,
last_modified_time
FROM aws.bedrock.advanced_prompt_optimization_jobs
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
;

INSERT examples

create_advanced_prompt_optimization_job

Creates an advanced prompt optimization job. The job optimizes your prompt templates for specific models using your evaluation dataset and criteria.

INSERT INTO aws.bedrock.advanced_prompt_optimization_jobs (
jobName,
jobDescription,
clientToken,
inputConfig,
outputConfig,
encryptionKeyArn,
tags,
modelConfigurations,
region
)
SELECT 
'{{ jobName }}' /* required */,
'{{ jobDescription }}',
'{{ clientToken }}',
'{{ inputConfig }}' /* required */,
'{{ outputConfig }}' /* required */,
'{{ encryptionKeyArn }}',
'{{ tags }}',
'{{ modelConfigurations }}' /* required */,
'{{ region }}'
RETURNING
job_arn
;

Manifest

# Description fields are for documentation purposes
- name: advanced_prompt_optimization_jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the advanced_prompt_optimization_jobs resource.
  - name: jobName
    value: "{{ jobName }}"
    description: |
      The name of an advanced prompt optimization job.
  - name: jobDescription
    value: "{{ jobDescription }}"
    description: |
      The description of an advanced prompt optimization job.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: inputConfig
    description: |
      Contains the input data configuration for an advanced prompt optimization job.
    value:
      s3Uri: "{{ s3Uri }}"
  - name: outputConfig
    description: |
      Contains the output data configuration for an advanced prompt optimization job.
    value:
      s3Uri: "{{ s3Uri }}"
  - name: encryptionKeyArn
    value: "{{ encryptionKeyArn }}"
  - name: tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: modelConfigurations
    description: |
      A list of model configurations for advanced prompt optimization.
    value:
      - modelId: "{{ modelId }}"
        inferenceConfig:
          maxTokens: {{ maxTokens }}
          temperature: {{ temperature }}
          topP: {{ topP }}
          stopSequences:
            - "{{ stopSequences }}"
        additionalModelRequestFields: "{{ additionalModelRequestFields }}"