Skip to content

describe_ipam_byoasn

Operation

describe_ipam_byoasn

describe_ipam_byoasn(request: DescribeIpamByoasnInput | DescribeIpamByoasnInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIpamByoasnInputDict]) -> DescribeIpamByoasnOutput

Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

Parameters:

Name Type Description Default
request DescribeIpamByoasnInput | DescribeIpamByoasnInputDict | 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[DescribeIpamByoasnInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeIpamByoasnOutput

An instance of DescribeIpamByoasnOutput.

describe_ipam_byoasn async

describe_ipam_byoasn(request: DescribeIpamByoasnInput | DescribeIpamByoasnInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIpamByoasnInputDict]) -> DescribeIpamByoasnOutput

Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

Parameters:

Name Type Description Default
request DescribeIpamByoasnInput | DescribeIpamByoasnInputDict | 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[DescribeIpamByoasnInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeIpamByoasnOutput

An instance of DescribeIpamByoasnOutput.

Input

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

DescribeIpamByoasnInputDict

Bases: TypedDict

Dictionary form of DescribeIpamByoasnInput.

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.

max_results instance-attribute
max_results: int | None

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

DescribeIpamByoasnInput dataclass

Bases: _SerdeShape

Dataclass for DescribeIpamByoasnInput structure.

Attributes

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.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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

The token for the next page of results.

Output

DescribeIpamByoasnOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeIpamByoasnOutput structure.

Attributes

byoasns class-attribute instance-attribute
byoasns: list[Byoasn] | None = ...

ASN and BYOIP CIDR associations.

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

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

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.