modify_ipam_routing_policy_registration¶
Operation¶
modify_ipam_routing_policy_registration
¶
modify_ipam_routing_policy_registration(request: ModifyIpamRoutingPolicyRegistrationInput | ModifyIpamRoutingPolicyRegistrationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyIpamRoutingPolicyRegistrationInputDict]) -> ModifyIpamRoutingPolicyRegistrationOutput
Modifies an existing routing policy registration. You can update the authorized ASNs, maximum prefix length, and other properties of a Route Origin Authorization (ROA).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ModifyIpamRoutingPolicyRegistrationInput | ModifyIpamRoutingPolicyRegistrationInputDict | 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[ModifyIpamRoutingPolicyRegistrationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ModifyIpamRoutingPolicyRegistrationOutput
|
An instance of |
modify_ipam_routing_policy_registration
async
¶
modify_ipam_routing_policy_registration(request: ModifyIpamRoutingPolicyRegistrationInput | ModifyIpamRoutingPolicyRegistrationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyIpamRoutingPolicyRegistrationInputDict]) -> ModifyIpamRoutingPolicyRegistrationOutput
Modifies an existing routing policy registration. You can update the authorized ASNs, maximum prefix length, and other properties of a Route Origin Authorization (ROA).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ModifyIpamRoutingPolicyRegistrationInput | ModifyIpamRoutingPolicyRegistrationInputDict | 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[ModifyIpamRoutingPolicyRegistrationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ModifyIpamRoutingPolicyRegistrationOutput
|
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.
ModifyIpamRoutingPolicyRegistrationInputDict
¶
Bases: TypedDict
Dictionary form of ModifyIpamRoutingPolicyRegistrationInput.
Attributes¶
asns
instance-attribute
¶
The updated list of Autonomous System Numbers (ASNs) authorized to originate the prefix.
cidr
instance-attribute
¶
The IP address prefix in CIDR notation identifying the routing policy registration to modify.
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.
description
instance-attribute
¶
description: str | None
A new description for the routing policy registration.
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 modification even if it conflicts with an announced route.
Default: false.
ipam_internet_registry_association_id
instance-attribute
¶
The ID of the IPAM internet registry association.
ModifyIpamRoutingPolicyRegistrationInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyIpamRoutingPolicyRegistrationInput structure.
Attributes¶
asns
class-attribute
instance-attribute
¶
The updated list of Autonomous System Numbers (ASNs) authorized to originate the prefix.
cidr
class-attribute
instance-attribute
¶
cidr: str | None = ...
The IP address prefix in CIDR notation identifying the routing policy registration to modify.
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.
description
class-attribute
instance-attribute
¶
description: str | None = ...
A new description for the routing policy registration.
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 modification 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¶
ModifyIpamRoutingPolicyRegistrationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyIpamRoutingPolicyRegistrationOutput 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 modification.
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.