Skip to content

list_byoip_cidrs

list_byoip_cidrs(
    *,
    config_overrides: Optional[GlobalAcceleratorClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[GenericString] = None,
) -> ListByoipCidrsResponse

Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.

Parameters:

  • max_results (Optional[MaxResults], 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[GenericString], default: None ) –

    The token for the next page of results.

Raises:

Source code in docs_src/capo_global_accelerator/_services/global_accelerator.py
def list_byoip_cidrs(
    self,
    *,
    config_overrides: Optional[GlobalAcceleratorClientConfig] = None,
    max_results: Optional[
        "capo_global_accelerator.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_global_accelerator.types.generic_string.GenericString"
    ] = None,
) -> (
    "capo_global_accelerator.types.list_byoip_cidrs_response.ListByoipCidrsResponse"
):
    """<p>Lists the IP address ranges that were specified in calls to <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/ProvisionByoipCidr.html">ProvisionByoipCidr</a>, including the current state and a history of state changes.</p>

    Args:
        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_global_accelerator.errors.access_denied_exception.AccessDeniedException: <p>You don't have access permission.</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.invalid_next_token_exception.InvalidNextTokenException: <p>There isn't another item to return.</p>
        capo_global_accelerator.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_global_accelerator.types.list_byoip_cidrs_request.ListByoipCidrsRequest]",
    ) -> OperationResponse[
        "capo_global_accelerator.types.list_byoip_cidrs_response.ListByoipCidrsResponse"
    ]:
        import capo_global_accelerator._operations.global_accelerator_v20180706.list_byoip_cidrs

        output, http_response = (
            capo_global_accelerator._operations.global_accelerator_v20180706.list_byoip_cidrs.list_byoip_cidrs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListByoipCidrs")
    )
    input_: capo_global_accelerator.types.list_byoip_cidrs_request.ListByoipCidrsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output