Skip to content

delete_resource

Operation

delete_resource

delete_resource(request: DeleteResourceInput | DeleteResourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteResourceInputDict]) -> DeleteResourceOutput

Deletes a Resource resource.

Parameters:

Name Type Description Default
request DeleteResourceInput | DeleteResourceInputDict | 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[DeleteResourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteResourceOutput

An instance of DeleteResourceOutput.

delete_resource async

delete_resource(request: DeleteResourceInput | DeleteResourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteResourceInputDict]) -> DeleteResourceOutput

Deletes a Resource resource.

Parameters:

Name Type Description Default
request DeleteResourceInput | DeleteResourceInputDict | 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[DeleteResourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteResourceOutput

An instance of DeleteResourceOutput.

Input

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

DeleteResourceInputDict

Bases: TypedDict

Dictionary form of DeleteResourceInput.

Attributes

resource_id instance-attribute
resource_id: Required[str]

The identifier of the Resource resource.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

DeleteResourceInput dataclass

Bases: _SerdeShape

Request to delete a Resource.

Attributes

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

The identifier of the Resource resource.

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

The string identifier of the associated RestApi.

Output

DeleteResourceOutput dataclass

Bases: _SerdeShape

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