describe_byoip_cidrs `async` ¶

describe_byoip_cidrs(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    max_results: Optional[DescribeByoipCidrsMaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> DescribeByoipCidrsResult

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

Parameters:

dry_run (Optional[Boolean], default: 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 (Optional[DescribeByoipCidrsMaxResults], default: 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 (Optional[NextToken], default: None ) –

The token for the next page of results.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ec2/_services/async_ec2.py

async def describe_byoip_cidrs(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    max_results: Optional[
        "capo_ec2.types.describe_byoip_cidrs_max_results.DescribeByoipCidrsMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
) -> "capo_ec2.types.describe_byoip_cidrs_result.DescribeByoipCidrsResult":
    """<p>Describes the IP address ranges that were provisioned for use with Amazon Web Services resources through through bring your own IP addresses (BYOIP).</p>

    Args:
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
        next_token: <p>The token for the next page of results.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.describe_byoip_cidrs_request.DescribeByoipCidrsRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_byoip_cidrs_result.DescribeByoipCidrsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_byoip_cidrs

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.describe_byoip_cidrs.async_describe_byoip_cidrs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeByoipCidrs")
    )
    input_: capo_ec2.types.describe_byoip_cidrs_request.DescribeByoipCidrsRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_byoip_cidrs async ¶

describe_byoip_cidrs `async` ¶