stop_batch_evaluation¶
Operation¶
stop_batch_evaluation
¶
stop_batch_evaluation(request: StopBatchEvaluationInput | StopBatchEvaluationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopBatchEvaluationInputDict]) -> StopBatchEvaluationOutput
Stops a running batch evaluation. Sessions that have already been evaluated retain their results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
StopBatchEvaluationInput | StopBatchEvaluationInputDict | 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[StopBatchEvaluationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StopBatchEvaluationOutput
|
An instance of |
stop_batch_evaluation
async
¶
stop_batch_evaluation(request: StopBatchEvaluationInput | StopBatchEvaluationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopBatchEvaluationInputDict]) -> StopBatchEvaluationOutput
Stops a running batch evaluation. Sessions that have already been evaluated retain their results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
StopBatchEvaluationInput | StopBatchEvaluationInputDict | 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[StopBatchEvaluationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StopBatchEvaluationOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
StopBatchEvaluationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for StopBatchEvaluationOutput structure.
Attributes¶
batch_evaluation_arn
instance-attribute
¶
batch_evaluation_arn: str
The Amazon Resource Name (ARN) of the stopped batch evaluation.
batch_evaluation_id
instance-attribute
¶
batch_evaluation_id: str
The unique identifier of the stopped batch evaluation.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the batch evaluation.
response_metadata
class-attribute
instance-attribute
¶
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.