Skip to content

stop_evaluation_job

Operation

stop_evaluation_job

stop_evaluation_job(request: StopEvaluationJobInput | StopEvaluationJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopEvaluationJobInputDict]) -> StopEvaluationJobOutput

Stops an evaluation job that is current being created or running.

Parameters:

Name Type Description Default
request StopEvaluationJobInput | StopEvaluationJobInputDict | 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[StopEvaluationJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StopEvaluationJobOutput

An instance of StopEvaluationJobOutput.

stop_evaluation_job async

stop_evaluation_job(request: StopEvaluationJobInput | StopEvaluationJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopEvaluationJobInputDict]) -> StopEvaluationJobOutput

Stops an evaluation job that is current being created or running.

Parameters:

Name Type Description Default
request StopEvaluationJobInput | StopEvaluationJobInputDict | 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[StopEvaluationJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StopEvaluationJobOutput

An instance of StopEvaluationJobOutput.

Input

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

StopEvaluationJobInputDict

Bases: TypedDict

Dictionary form of StopEvaluationJobInput.

Attributes

job_identifier instance-attribute
job_identifier: Required[str]

The Amazon Resource Name (ARN) of the evaluation job you want to stop.

StopEvaluationJobInput dataclass

Bases: _SerdeShape

Dataclass for StopEvaluationJobInput structure.

Attributes

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

The Amazon Resource Name (ARN) of the evaluation job you want to stop.

Output

StopEvaluationJobOutput dataclass

Bases: _SerdeShape

Dataclass for StopEvaluationJobOutput structure.

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.