modify_ipam_scope¶
Operation¶
modify_ipam_scope
¶
modify_ipam_scope(request: ModifyIpamScopeInput | ModifyIpamScopeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyIpamScopeInputDict]) -> ModifyIpamScopeOutput
Modify an IPAM scope.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ModifyIpamScopeInput | ModifyIpamScopeInputDict | 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[ModifyIpamScopeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ModifyIpamScopeOutput
|
An instance of |
modify_ipam_scope
async
¶
modify_ipam_scope(request: ModifyIpamScopeInput | ModifyIpamScopeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyIpamScopeInputDict]) -> ModifyIpamScopeOutput
Modify an IPAM scope.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ModifyIpamScopeInput | ModifyIpamScopeInputDict | 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[ModifyIpamScopeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ModifyIpamScopeOutput
|
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.
ModifyIpamScopeInputDict
¶
Bases: TypedDict
Dictionary form of ModifyIpamScopeInput.
Attributes¶
description
instance-attribute
¶
description: str | None
The description of the scope you want to modify.
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.
external_authority_configuration
instance-attribute
¶
external_authority_configuration: ExternalAuthorityConfiguration | ExternalAuthorityConfigurationDict | None
The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.
In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.
ipam_scope_id
instance-attribute
¶
The ID of the scope you want to modify.
ModifyIpamScopeInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyIpamScopeInput structure.
Attributes¶
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the scope you want to modify.
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.
external_authority_configuration
class-attribute
instance-attribute
¶
external_authority_configuration: ExternalAuthorityConfiguration | None = ...
The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.
In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.
Output¶
ModifyIpamScopeOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyIpamScopeOutput structure.
Attributes¶
ipam_scope
class-attribute
instance-attribute
¶
ipam_scope: IpamScope | None = ...
The results of the 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.