Skip to content

delete_ipam_routing_policy_registration

Operation

delete_ipam_routing_policy_registration

Deletes a routing policy registration for a specified CIDR prefix.

Parameters:

Name Type Description Default
request DeleteIpamRoutingPolicyRegistrationInput | DeleteIpamRoutingPolicyRegistrationInputDict | 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[DeleteIpamRoutingPolicyRegistrationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteIpamRoutingPolicyRegistrationOutput

An instance of DeleteIpamRoutingPolicyRegistrationOutput.

delete_ipam_routing_policy_registration async

Deletes a routing policy registration for a specified CIDR prefix.

Parameters:

Name Type Description Default
request DeleteIpamRoutingPolicyRegistrationInput | DeleteIpamRoutingPolicyRegistrationInputDict | 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[DeleteIpamRoutingPolicyRegistrationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteIpamRoutingPolicyRegistrationOutput

An instance of DeleteIpamRoutingPolicyRegistrationOutput.

Input

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

DeleteIpamRoutingPolicyRegistrationInputDict

Bases: TypedDict

Dictionary form of DeleteIpamRoutingPolicyRegistrationInput.

Attributes

cidr instance-attribute
cidr: Required[str]

The IP address prefix in CIDR notation identifying the routing policy registration to delete.

client_token instance-attribute
client_token: str | None

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.

This field is autopopulated if not provided.

dry_run instance-attribute
dry_run: bool | None

Checks whether you have the required permissions for the operation, 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.

force instance-attribute
force: bool | None

Forces the deletion even if it conflicts with an announced route. Default: false.

ipam_internet_registry_association_id instance-attribute
ipam_internet_registry_association_id: Required[str]

The ID of the IPAM internet registry association.

DeleteIpamRoutingPolicyRegistrationInput dataclass

Bases: _SerdeShape

Dataclass for DeleteIpamRoutingPolicyRegistrationInput structure.

Attributes

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

The IP address prefix in CIDR notation identifying the routing policy registration to delete.

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

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.

This field is autopopulated if not provided.

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

Checks whether you have the required permissions for the operation, 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.

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

Forces the deletion even if it conflicts with an announced route. Default: false.

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

The ID of the IPAM internet registry association.

Output

DeleteIpamRoutingPolicyRegistrationOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteIpamRoutingPolicyRegistrationOutput structure.

Attributes

ipam_routing_policy_registration_delta class-attribute instance-attribute
ipam_routing_policy_registration_delta: IpamRoutingPolicyRegistrationDelta | None = ...

Information about the routing policy registration delta created by this deletion.

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.