Skip to content

delete_gateway_rule

Operation

delete_gateway_rule

delete_gateway_rule(request: DeleteGatewayRuleInput | DeleteGatewayRuleInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteGatewayRuleInputDict]) -> DeleteGatewayRuleOutput

Deletes a gateway rule.

Parameters:

Name Type Description Default
request DeleteGatewayRuleInput | DeleteGatewayRuleInputDict | 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[DeleteGatewayRuleInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteGatewayRuleOutput

An instance of DeleteGatewayRuleOutput.

delete_gateway_rule async

delete_gateway_rule(request: DeleteGatewayRuleInput | DeleteGatewayRuleInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteGatewayRuleInputDict]) -> DeleteGatewayRuleOutput

Deletes a gateway rule.

Parameters:

Name Type Description Default
request DeleteGatewayRuleInput | DeleteGatewayRuleInputDict | 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[DeleteGatewayRuleInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteGatewayRuleOutput

An instance of DeleteGatewayRuleOutput.

Input

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

DeleteGatewayRuleInputDict

Bases: TypedDict

Dictionary form of DeleteGatewayRuleInput.

Attributes

gateway_identifier instance-attribute
gateway_identifier: Required[str]

The identifier of the gateway containing the rule.

rule_id instance-attribute
rule_id: Required[str]

The unique identifier of the rule to delete.

DeleteGatewayRuleInput dataclass

Bases: _SerdeShape

Dataclass for DeleteGatewayRuleInput structure.

Attributes

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

The identifier of the gateway containing the rule.

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

The unique identifier of the rule to delete.

Output

DeleteGatewayRuleOutput dataclass

Bases: _SerdeShape

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

rule_id instance-attribute
rule_id: str

The unique identifier of the deleted rule.

status instance-attribute
status: str

The status of the rule deletion operation.