Skip to content

provision_ipam_byoasn

Operation

provision_ipam_byoasn

provision_ipam_byoasn(request: ProvisionIpamByoasnInput | ProvisionIpamByoasnInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ProvisionIpamByoasnInputDict]) -> ProvisionIpamByoasnOutput

Provisions your Autonomous System Number (ASN) for use in your Amazon Web Services account. This action requires authorization context for Amazon to bring the ASN to an Amazon Web Services account. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

Parameters:

Name Type Description Default
request ProvisionIpamByoasnInput | ProvisionIpamByoasnInputDict | 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[ProvisionIpamByoasnInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ProvisionIpamByoasnOutput

An instance of ProvisionIpamByoasnOutput.

provision_ipam_byoasn async

provision_ipam_byoasn(request: ProvisionIpamByoasnInput | ProvisionIpamByoasnInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ProvisionIpamByoasnInputDict]) -> ProvisionIpamByoasnOutput

Provisions your Autonomous System Number (ASN) for use in your Amazon Web Services account. This action requires authorization context for Amazon to bring the ASN to an Amazon Web Services account. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

Parameters:

Name Type Description Default
request ProvisionIpamByoasnInput | ProvisionIpamByoasnInputDict | 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[ProvisionIpamByoasnInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ProvisionIpamByoasnOutput

An instance of ProvisionIpamByoasnOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ProvisionIpamByoasnInputDict

Bases: TypedDict

Dictionary form of ProvisionIpamByoasnInput.

Attributes

asn instance-attribute
asn: Required[str]

A public 2-byte or 4-byte ASN.

asn_authorization_context instance-attribute

An ASN authorization context.

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.

ipam_id instance-attribute
ipam_id: Required[str]

An IPAM ID.

ProvisionIpamByoasnInput dataclass

Bases: _SerdeShape

Dataclass for ProvisionIpamByoasnInput structure.

Attributes

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

A public 2-byte or 4-byte ASN.

asn_authorization_context class-attribute instance-attribute
asn_authorization_context: AsnAuthorizationContext | None = ...

An ASN authorization context.

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.

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

An IPAM ID.

Output

ProvisionIpamByoasnOutput dataclass

Bases: _SerdeShape

Dataclass for ProvisionIpamByoasnOutput structure.

Attributes

byoasn class-attribute instance-attribute
byoasn: Byoasn | None = ...

An ASN and BYOIP CIDR association.

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.