Skip to content

delete_evaluator

Operation

delete_evaluator

delete_evaluator(request: DeleteEvaluatorInput | DeleteEvaluatorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteEvaluatorInputDict]) -> DeleteEvaluatorOutput

Deletes a custom evaluator. Builtin evaluators cannot be deleted. The evaluator must not be referenced by any active online evaluation configurations.

Parameters:

Name Type Description Default
request DeleteEvaluatorInput | DeleteEvaluatorInputDict | 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[DeleteEvaluatorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteEvaluatorOutput

An instance of DeleteEvaluatorOutput.

delete_evaluator async

delete_evaluator(request: DeleteEvaluatorInput | DeleteEvaluatorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteEvaluatorInputDict]) -> DeleteEvaluatorOutput

Deletes a custom evaluator. Builtin evaluators cannot be deleted. The evaluator must not be referenced by any active online evaluation configurations.

Parameters:

Name Type Description Default
request DeleteEvaluatorInput | DeleteEvaluatorInputDict | 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[DeleteEvaluatorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteEvaluatorOutput

An instance of DeleteEvaluatorOutput.

Input

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

DeleteEvaluatorInputDict

Bases: TypedDict

Dictionary form of DeleteEvaluatorInput.

Attributes

evaluator_id instance-attribute
evaluator_id: Required[str]

The unique identifier of the evaluator to delete.

DeleteEvaluatorInput dataclass

Bases: _SerdeShape

Dataclass for DeleteEvaluatorInput structure.

Attributes

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

The unique identifier of the evaluator to delete.

Output

DeleteEvaluatorOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteEvaluatorOutput structure.

Attributes

evaluator_arn instance-attribute
evaluator_arn: str

The Amazon Resource Name (ARN) of the deleted evaluator.

evaluator_id instance-attribute
evaluator_id: str

The unique identifier of the deleted evaluator.

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.

status instance-attribute
status: str

The status of the evaluator deletion operation.