delete_carrier_gateway¶
Operation¶
delete_carrier_gateway
async
¶
delete_carrier_gateway(request: DeleteCarrierGatewayInput | DeleteCarrierGatewayInputDict, /, *, plugins: list[Plugin] | None = None) -> DeleteCarrierGatewayOutput
delete_carrier_gateway(*, 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 |
|---|---|---|---|
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
|
Returns:
| Type | Description |
|---|---|
DeleteCarrierGatewayOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
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.
Dictionaries¶
DeleteCarrierGatewayInputDict
¶
Bases: TypedDict
Dictionary form of DeleteCarrierGatewayInput.
Attributes¶
carrier_gateway_id
instance-attribute
¶
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.
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
¶
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.