Skip to content

delete_carrier_gateway

Operation

delete_carrier_gateway

delete_carrier_gateway(request: DeleteCarrierGatewayInput | DeleteCarrierGatewayInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteCarrierGatewayInputDict]) -> DeleteCarrierGatewayOutput

Deletes a carrier gateway.

Warning

If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute.

Parameters:

Name Type Description Default
request DeleteCarrierGatewayInput | DeleteCarrierGatewayInputDict | 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[DeleteCarrierGatewayInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteCarrierGatewayOutput

An instance of DeleteCarrierGatewayOutput.

delete_carrier_gateway async

delete_carrier_gateway(request: DeleteCarrierGatewayInput | DeleteCarrierGatewayInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteCarrierGatewayInputDict]) -> DeleteCarrierGatewayOutput

Deletes a carrier gateway.

Warning

If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute.

Parameters:

Name Type Description Default
request DeleteCarrierGatewayInput | DeleteCarrierGatewayInputDict | 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[DeleteCarrierGatewayInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteCarrierGatewayOutput

An instance of DeleteCarrierGatewayOutput.

Input

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

DeleteCarrierGatewayInputDict

Bases: TypedDict

Dictionary form of DeleteCarrierGatewayInput.

Attributes

carrier_gateway_id instance-attribute
carrier_gateway_id: Required[str]

The ID of the carrier gateway.

dry_run instance-attribute
dry_run: bool | None

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

DeleteCarrierGatewayInput dataclass

Bases: _SerdeShape

Dataclass for DeleteCarrierGatewayInput structure.

Attributes

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

The ID of the carrier gateway.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Output

DeleteCarrierGatewayOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteCarrierGatewayOutput structure.

Attributes

carrier_gateway class-attribute instance-attribute
carrier_gateway: CarrierGateway | None = ...

Information about the carrier 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.