Skip to content

stop_advanced_prompt_optimization_job

Operation

stop_advanced_prompt_optimization_job

Stops an advanced prompt optimization job that is in progress.

Parameters:

Name Type Description Default
request StopAdvancedPromptOptimizationJobInput | StopAdvancedPromptOptimizationJobInputDict | 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[StopAdvancedPromptOptimizationJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StopAdvancedPromptOptimizationJobOutput

An instance of StopAdvancedPromptOptimizationJobOutput.

stop_advanced_prompt_optimization_job async

Stops an advanced prompt optimization job that is in progress.

Parameters:

Name Type Description Default
request StopAdvancedPromptOptimizationJobInput | StopAdvancedPromptOptimizationJobInputDict | 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[StopAdvancedPromptOptimizationJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StopAdvancedPromptOptimizationJobOutput

An instance of StopAdvancedPromptOptimizationJobOutput.

Input

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

StopAdvancedPromptOptimizationJobInputDict

Bases: TypedDict

Dictionary form of StopAdvancedPromptOptimizationJobInput.

Attributes

job_identifier instance-attribute
job_identifier: Required[str]

The ARN or ID of the advanced prompt optimization job to stop.

StopAdvancedPromptOptimizationJobInput dataclass

Bases: _SerdeShape

Stop 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 to stop.

Output

StopAdvancedPromptOptimizationJobOutput dataclass

Bases: _SerdeShape

Stop Advanced Prompt Optimization Job Response

Attributes

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.