delete_coip_pool¶
Operation¶
delete_coip_pool
¶
delete_coip_pool(request: DeleteCoipPoolInput | DeleteCoipPoolInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteCoipPoolInputDict]) -> DeleteCoipPoolOutput
Deletes a pool of customer-owned IP (CoIP) addresses.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteCoipPoolInput | DeleteCoipPoolInputDict | 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[DeleteCoipPoolInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteCoipPoolOutput
|
An instance of |
delete_coip_pool
async
¶
delete_coip_pool(request: DeleteCoipPoolInput | DeleteCoipPoolInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteCoipPoolInputDict]) -> DeleteCoipPoolOutput
Deletes a pool of customer-owned IP (CoIP) addresses.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteCoipPoolInput | DeleteCoipPoolInputDict | 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[DeleteCoipPoolInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteCoipPoolOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DeleteCoipPoolInputDict
¶
Bases: TypedDict
Dictionary form of DeleteCoipPoolInput.
Attributes¶
coip_pool_id
instance-attribute
¶
The ID of the CoIP pool that you want to delete.
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.
DeleteCoipPoolInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteCoipPoolInput structure.
Attributes¶
coip_pool_id
class-attribute
instance-attribute
¶
coip_pool_id: str | None = ...
The ID of the CoIP pool that you want to delete.
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¶
DeleteCoipPoolOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteCoipPoolOutput structure.
Attributes¶
coip_pool
class-attribute
instance-attribute
¶
coip_pool: CoipPool | None = ...
Information about the CoIP address pool.
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.