Skip to content

describe_byoip_cidrs

Operation

describe_byoip_cidrs

describe_byoip_cidrs(request: DescribeByoipCidrsInput | DescribeByoipCidrsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeByoipCidrsInputDict]) -> DescribeByoipCidrsOutput

Describes the IP address ranges that were provisioned for use with Amazon Web Services resources through through bring your own IP addresses (BYOIP).

Parameters:

Name Type Description Default
request DescribeByoipCidrsInput | DescribeByoipCidrsInputDict | 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[DescribeByoipCidrsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeByoipCidrsOutput

An instance of DescribeByoipCidrsOutput.

describe_byoip_cidrs async

describe_byoip_cidrs(request: DescribeByoipCidrsInput | DescribeByoipCidrsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeByoipCidrsInputDict]) -> DescribeByoipCidrsOutput

Describes the IP address ranges that were provisioned for use with Amazon Web Services resources through through bring your own IP addresses (BYOIP).

Parameters:

Name Type Description Default
request DescribeByoipCidrsInput | DescribeByoipCidrsInputDict | 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[DescribeByoipCidrsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeByoipCidrsOutput

An instance of DescribeByoipCidrsOutput.

Input

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

DescribeByoipCidrsInputDict

Bases: TypedDict

Dictionary form of DescribeByoipCidrsInput.

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: Required[int]

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.

DescribeByoipCidrsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeByoipCidrsInput 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

DescribeByoipCidrsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeByoipCidrsOutput structure.

Attributes

byoip_cidrs class-attribute instance-attribute
byoip_cidrs: list[ByoipCidr] | None = ...

Information about your address ranges.

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.