modify_ipam_prefix_list_resolver_target¶
Operation¶
modify_ipam_prefix_list_resolver_target
¶
modify_ipam_prefix_list_resolver_target(request: ModifyIpamPrefixListResolverTargetInput | ModifyIpamPrefixListResolverTargetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyIpamPrefixListResolverTargetInputDict]) -> ModifyIpamPrefixListResolverTargetOutput
Modifies an IPAM prefix list resolver target. You can update version tracking settings and the desired version of the target prefix list.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ModifyIpamPrefixListResolverTargetInput | ModifyIpamPrefixListResolverTargetInputDict | 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[ModifyIpamPrefixListResolverTargetInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ModifyIpamPrefixListResolverTargetOutput
|
An instance of |
modify_ipam_prefix_list_resolver_target
async
¶
modify_ipam_prefix_list_resolver_target(request: ModifyIpamPrefixListResolverTargetInput | ModifyIpamPrefixListResolverTargetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyIpamPrefixListResolverTargetInputDict]) -> ModifyIpamPrefixListResolverTargetOutput
Modifies an IPAM prefix list resolver target. You can update version tracking settings and the desired version of the target prefix list.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ModifyIpamPrefixListResolverTargetInput | ModifyIpamPrefixListResolverTargetInputDict | 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[ModifyIpamPrefixListResolverTargetInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ModifyIpamPrefixListResolverTargetOutput
|
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.
ModifyIpamPrefixListResolverTargetInputDict
¶
Bases: TypedDict
Dictionary form of ModifyIpamPrefixListResolverTargetInput.
Attributes¶
client_token
instance-attribute
¶
client_token: str | None
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
desired_version
instance-attribute
¶
desired_version: int | None
The desired version of the prefix list to target. This allows you to pin the target to a specific version.
dry_run
instance-attribute
¶
dry_run: bool | None
A check for 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.
ipam_prefix_list_resolver_target_id
instance-attribute
¶
The ID of the IPAM prefix list resolver target to modify.
track_latest_version
instance-attribute
¶
track_latest_version: bool | None
Indicates whether the resolver target should automatically track the latest version of the prefix list. When enabled, the target will always synchronize with the most current version.
Choose this for automatic updates when you want your prefix lists to stay current with infrastructure changes without manual intervention.
ModifyIpamPrefixListResolverTargetInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyIpamPrefixListResolverTargetInput structure.
Attributes¶
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
desired_version
class-attribute
instance-attribute
¶
desired_version: int | None = ...
The desired version of the prefix list to target. This allows you to pin the target to a specific version.
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
A check for 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.
ipam_prefix_list_resolver_target_id
class-attribute
instance-attribute
¶
ipam_prefix_list_resolver_target_id: str | None = ...
The ID of the IPAM prefix list resolver target to modify.
track_latest_version
class-attribute
instance-attribute
¶
track_latest_version: bool | None = ...
Indicates whether the resolver target should automatically track the latest version of the prefix list. When enabled, the target will always synchronize with the most current version.
Choose this for automatic updates when you want your prefix lists to stay current with infrastructure changes without manual intervention.
Output¶
ModifyIpamPrefixListResolverTargetOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyIpamPrefixListResolverTargetOutput structure.
Attributes¶
ipam_prefix_list_resolver_target
class-attribute
instance-attribute
¶
ipam_prefix_list_resolver_target: IpamPrefixListResolverTarget | None = ...
Information about the modified IPAM prefix list resolver target.
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.