Skip to content

create_coip_pool

Operation

create_coip_pool

create_coip_pool(request: CreateCoipPoolInput | CreateCoipPoolInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateCoipPoolInputDict]) -> CreateCoipPoolOutput

Creates a pool of customer-owned IP (CoIP) addresses.

Parameters:

Name Type Description Default
request CreateCoipPoolInput | CreateCoipPoolInputDict | 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[CreateCoipPoolInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateCoipPoolOutput

An instance of CreateCoipPoolOutput.

create_coip_pool async

create_coip_pool(request: CreateCoipPoolInput | CreateCoipPoolInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateCoipPoolInputDict]) -> CreateCoipPoolOutput

Creates a pool of customer-owned IP (CoIP) addresses.

Parameters:

Name Type Description Default
request CreateCoipPoolInput | CreateCoipPoolInputDict | 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[CreateCoipPoolInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateCoipPoolOutput

An instance of CreateCoipPoolOutput.

Input

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

CreateCoipPoolInputDict

Bases: TypedDict

Dictionary form of CreateCoipPoolInput.

Attributes

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.

local_gateway_route_table_id instance-attribute
local_gateway_route_table_id: Required[str]

The ID of the local gateway route table.

tag_specifications instance-attribute
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None

The tags to assign to the CoIP address pool.

CreateCoipPoolInput dataclass

Bases: _SerdeShape

Dataclass for CreateCoipPoolInput structure.

Attributes

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.

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

The ID of the local gateway route table.

tag_specifications class-attribute instance-attribute
tag_specifications: list[TagSpecification] | None = ...

The tags to assign to the CoIP address pool.

Output

CreateCoipPoolOutput dataclass

Bases: _SerdeShape

Dataclass for CreateCoipPoolOutput structure.

Attributes

coip_pool class-attribute instance-attribute
coip_pool: CoipPool | None = ...

Information about the CoIP address pool.

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.