Skip to content

get_advanced_prompt_optimization_job

Operation

get_advanced_prompt_optimization_job

get_advanced_prompt_optimization_job(request: GetAdvancedPromptOptimizationJobInput | GetAdvancedPromptOptimizationJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAdvancedPromptOptimizationJobInputDict]) -> GetAdvancedPromptOptimizationJobOutput

Gets information about an advanced prompt optimization job.

Parameters:

Name Type Description Default
request GetAdvancedPromptOptimizationJobInput | GetAdvancedPromptOptimizationJobInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetAdvancedPromptOptimizationJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAdvancedPromptOptimizationJobOutput

An instance of GetAdvancedPromptOptimizationJobOutput.

get_advanced_prompt_optimization_job async

get_advanced_prompt_optimization_job(request: GetAdvancedPromptOptimizationJobInput | GetAdvancedPromptOptimizationJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAdvancedPromptOptimizationJobInputDict]) -> GetAdvancedPromptOptimizationJobOutput

Gets information about an advanced prompt optimization job.

Parameters:

Name Type Description Default
request GetAdvancedPromptOptimizationJobInput | GetAdvancedPromptOptimizationJobInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetAdvancedPromptOptimizationJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAdvancedPromptOptimizationJobOutput

An instance of GetAdvancedPromptOptimizationJobOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetAdvancedPromptOptimizationJobInputDict

Bases: TypedDict

Dictionary form of GetAdvancedPromptOptimizationJobInput.

Attributes

job_identifier instance-attribute
job_identifier: Required[str]

The ARN or ID of the advanced prompt optimization job.

GetAdvancedPromptOptimizationJobInput dataclass

Bases: _SerdeShape

Get Advanced Prompt Optimization Job Request

Attributes

job_identifier class-attribute instance-attribute
job_identifier: str | None = ...

The ARN or ID of the advanced prompt optimization job.

Output

GetAdvancedPromptOptimizationJobOutput dataclass

Bases: _SerdeShape

Get Advanced Prompt Optimization Job Response

Attributes

creation_time instance-attribute
creation_time: datetime

The time at which the advanced prompt optimization job was created.

encryption_key_arn class-attribute instance-attribute
encryption_key_arn: str | None = ...

The Amazon Resource Name (ARN) of the KMS key used to encrypt the output data.

failure_message class-attribute instance-attribute
failure_message: str | None = ...

If the job failed, a message describing the reason for the failure.

input_config instance-attribute

The input data configuration for the optimization job.

job_arn instance-attribute
job_arn: str

The Amazon Resource Name (ARN) of the advanced prompt optimization job.

job_description class-attribute instance-attribute
job_description: str | None = ...

The description of the advanced prompt optimization job.

job_name instance-attribute
job_name: str

The name of the advanced prompt optimization job.

job_status instance-attribute
job_status: str

The status of the advanced prompt optimization job.

last_modified_time class-attribute instance-attribute
last_modified_time: datetime | None = ...

The time at which the advanced prompt optimization job was last modified.

model_configurations instance-attribute
model_configurations: list[ModelConfiguration]

The model configurations used in the optimization job.

output_config instance-attribute

The output data configuration for the optimization job.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.