Skip to content

delete_gateway

Operation

delete_gateway

delete_gateway(request: DeleteGatewayInput | DeleteGatewayInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteGatewayInputDict]) -> DeleteGatewayOutput

Deletes a gateway.

Parameters:

Name Type Description Default
request DeleteGatewayInput | DeleteGatewayInputDict | 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[DeleteGatewayInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteGatewayOutput

An instance of DeleteGatewayOutput.

delete_gateway async

delete_gateway(request: DeleteGatewayInput | DeleteGatewayInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteGatewayInputDict]) -> DeleteGatewayOutput

Deletes a gateway.

Parameters:

Name Type Description Default
request DeleteGatewayInput | DeleteGatewayInputDict | 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[DeleteGatewayInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteGatewayOutput

An instance of DeleteGatewayOutput.

Input

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

DeleteGatewayInputDict

Bases: TypedDict

Dictionary form of DeleteGatewayInput.

Attributes

gateway_identifier instance-attribute
gateway_identifier: Required[str]

The identifier of the gateway to delete.

DeleteGatewayInput dataclass

Bases: _SerdeShape

Dataclass for DeleteGatewayInput structure.

Attributes

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

The identifier of the gateway to delete.

Output

DeleteGatewayOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteGatewayOutput structure.

Attributes

gateway_id instance-attribute
gateway_id: str

The unique identifier of the deleted gateway.

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 current status of the gateway deletion.

status_reasons class-attribute instance-attribute
status_reasons: list[str] | None = ...

The reasons for the current status of the gateway deletion.