Skip to content

delete_model

Operation

delete_model

delete_model(request: DeleteModelInput | DeleteModelInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteModelInputDict]) -> DeleteModelOutput

Deletes a model.

Parameters:

Name Type Description Default
request DeleteModelInput | DeleteModelInputDict | 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[DeleteModelInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteModelOutput

An instance of DeleteModelOutput.

delete_model async

delete_model(request: DeleteModelInput | DeleteModelInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteModelInputDict]) -> DeleteModelOutput

Deletes a model.

Parameters:

Name Type Description Default
request DeleteModelInput | DeleteModelInputDict | 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[DeleteModelInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteModelOutput

An instance of DeleteModelOutput.

Input

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

DeleteModelInputDict

Bases: TypedDict

Dictionary form of DeleteModelInput.

Attributes

model_name instance-attribute
model_name: Required[str]

The name of the model to delete.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

DeleteModelInput dataclass

Bases: _SerdeShape

Request to delete an existing model in an existing RestApi resource.

Attributes

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

The name of the model to delete.

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

The string identifier of the associated RestApi.

Output

DeleteModelOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteModelOutput 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.