provision_byoip_cidr `async` ¶

provision_byoip_cidr(
    cidr: GenericString,
    cidr_authorization_context: CidrAuthorizationContext,
    *,
    config_overrides: Optional[AsyncGlobalAcceleratorClientConfig] = None,
) -> ProvisionByoipCidrResponse

Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.

For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

Parameters:

cidr (GenericString) –

The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this Amazon Web Services Region or another Region.

For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
cidr_authorization_context (CidrAuthorizationContext) –

A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

Raises:

AccessDeniedException –

You don't have access permission.
IncorrectCidrStateException –

The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.
InternalServiceErrorException –

There was an internal error for Global Accelerator.
InvalidArgumentException –

An argument that you specified is invalid.
LimitExceededException –

Processing your request would cause you to exceed an Global Accelerator limit.
UnknownServiceError –

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

Source code in docs_src/capo_global_accelerator/_services/async_global_accelerator.py

async def provision_byoip_cidr(
    self,
    cidr: "capo_global_accelerator.types.generic_string.GenericString",
    cidr_authorization_context: "capo_global_accelerator.types.cidr_authorization_context.CidrAuthorizationContext",
    *,
    config_overrides: Optional[AsyncGlobalAcceleratorClientConfig] = None,
) -> "capo_global_accelerator.types.provision_byoip_cidr_response.ProvisionByoipCidrResponse":
    """<p>Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/AdvertiseByoipCidr.html"> AdvertiseByoipCidr</a>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>

    Args:
        cidr: <p>The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this Amazon Web Services Region or another Region.</p> <p> For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own IP addresses (BYOIP)</a> in the Global Accelerator Developer Guide.</p>
        cidr_authorization_context: <p>A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP. </p>

    Raises:
        capo_global_accelerator.errors.access_denied_exception.AccessDeniedException: <p>You don't have access permission.</p>
        capo_global_accelerator.errors.incorrect_cidr_state_exception.IncorrectCidrStateException: <p>The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.</p>
        capo_global_accelerator.errors.internal_service_error_exception.InternalServiceErrorException: <p>There was an internal error for Global Accelerator.</p>
        capo_global_accelerator.errors.invalid_argument_exception.InvalidArgumentException: <p>An argument that you specified is invalid.</p>
        capo_global_accelerator.errors.limit_exceeded_exception.LimitExceededException: <p>Processing your request would cause you to exceed an Global Accelerator limit.</p>
        capo_global_accelerator.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_global_accelerator.types.provision_byoip_cidr_request.ProvisionByoipCidrRequest]",
    ) -> AsyncOperationResponse[
        "capo_global_accelerator.types.provision_byoip_cidr_response.ProvisionByoipCidrResponse"
    ]:
        import capo_global_accelerator._operations.global_accelerator_v20180706.provision_byoip_cidr

        (
            output,
            http_response,
        ) = await capo_global_accelerator._operations.global_accelerator_v20180706.provision_byoip_cidr.async_provision_byoip_cidr(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ProvisionByoipCidr")
    )
    input_: capo_global_accelerator.types.provision_byoip_cidr_request.ProvisionByoipCidrRequest = {
        "cidr": cidr,
        "cidr_authorization_context": cidr_authorization_context,
    }

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

provision_byoip_cidr async ¶

provision_byoip_cidr `async` ¶