Skip to content

EC2  >  Operations  >  modify_ipam_scope

modify_ipam_scope

Operation

modify_ipam_scope async

modify_ipam_scope(input: ModifyIpamScopeInput, plugins: list[Plugin] | None = None) -> ModifyIpamScopeOutput

Modify an IPAM scope.

Parameters:

Name Type Description Default
input ModifyIpamScopeInput

An instance of ModifyIpamScopeInput.

required
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

Returns:

Type Description
ModifyIpamScopeOutput

An instance of ModifyIpamScopeOutput.

Input

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.

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

The ID of the scope you want to modify.

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

Remove the external authority configuration. true to remove.

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
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.