associate_ipam_byoasn¶
Operation¶
associate_ipam_byoasn
async
¶
associate_ipam_byoasn(request: AssociateIpamByoasnInput | AssociateIpamByoasnInputDict, /, *, plugins: list[Plugin] | None = None) -> AssociateIpamByoasnOutput
associate_ipam_byoasn(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[AssociateIpamByoasnInputDict]) -> AssociateIpamByoasnOutput
Associates your Autonomous System Number (ASN) with a BYOIP CIDR that you own in the same Amazon Web Services Region. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
After the association succeeds, the ASN is eligible for advertisement. You can view the association with DescribeByoipCidrs. You can advertise the CIDR with AdvertiseByoipCidr.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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 |
|---|---|
AssociateIpamByoasnOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
AssociateIpamByoasnInput
dataclass
¶
Bases: _SerdeShape
Dataclass for AssociateIpamByoasnInput structure.
Attributes¶
cidr
class-attribute
instance-attribute
¶
cidr: str | None = ...
The BYOIP CIDR you want to associate with an ASN.
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
Checks 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.
Dictionaries¶
AssociateIpamByoasnInputDict
¶
Bases: TypedDict
Dictionary form of AssociateIpamByoasnInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
Checks 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.
Output¶
AssociateIpamByoasnOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for AssociateIpamByoasnOutput structure.
Attributes¶
asn_association
class-attribute
instance-attribute
¶
asn_association: AsnAssociation | None = ...
The ASN and BYOIP CIDR association.
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.