remove_ip_routes `async` ¶

remove_ip_routes(
    directory_id: DirectoryId,
    *,
    config_overrides: Optional[AsyncDirectoryServiceClientConfig] = None,
    cidr_ips: Optional[CidrIps] = None,
    cidr_ipv6s: Optional[CidrIpv6s] = None,
) -> RemoveIpRoutesResult

Removes IP address blocks from a directory.

Parameters:

directory_id (DirectoryId) –

Identifier (ID) of the directory from which you want to remove the IP addresses.
cidr_ips (Optional[CidrIps], default: None ) –

IP address blocks that you want to remove.
cidr_ipv6s (Optional[CidrIpv6s], default: None ) –

IPv6 address blocks that you want to remove.

Raises:

ClientException –

A client exception has occurred.
DirectoryUnavailableException –

The specified directory is unavailable.
EntityDoesNotExistException –

The specified entity could not be found.
InvalidParameterException –

One or more parameters are not valid.
ServiceException –

An exception has occurred in Directory Service.
UnknownServiceError –

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

Examples:

To remove IP routes The following example removes IP address blocks from a specified directory.

>>> await client.remove_ip_routes(directory_id='d-92654abfed', cidr_ips=['12.12.12.12/32'])

Source code in docs_src/capo_directory_service/_services/async_directory_service.py

async def remove_ip_routes(
    self,
    directory_id: "capo_directory_service.types.directory_id.DirectoryId",
    *,
    config_overrides: Optional[AsyncDirectoryServiceClientConfig] = None,
    cidr_ips: Optional["capo_directory_service.types.cidr_ips.CidrIps"] = None,
    cidr_ipv6s: Optional[
        "capo_directory_service.types.cidr_ipv6s.CidrIpv6s"
    ] = None,
) -> "capo_directory_service.types.remove_ip_routes_result.RemoveIpRoutesResult":
    """<p>Removes IP address blocks from a directory.</p>

    Args:
        directory_id: <p>Identifier (ID) of the directory from which you want to remove the IP addresses.</p>
        cidr_ips: <p>IP address blocks that you want to remove.</p>
        cidr_ipv6s: <p>IPv6 address blocks that you want to remove.</p>

    Raises:
        capo_directory_service.errors.client_exception.ClientException: <p>A client exception has occurred.</p>
        capo_directory_service.errors.directory_unavailable_exception.DirectoryUnavailableException: <p>The specified directory is unavailable.</p>
        capo_directory_service.errors.entity_does_not_exist_exception.EntityDoesNotExistException: <p>The specified entity could not be found.</p>
        capo_directory_service.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid.</p>
        capo_directory_service.errors.service_exception.ServiceException: <p>An exception has occurred in Directory Service.</p>
        capo_directory_service.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To remove IP routes
        The following example removes IP address blocks from a specified directory.

        >>> await client.remove_ip_routes(directory_id='d-92654abfed', cidr_ips=['12.12.12.12/32'])
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_directory_service.types.remove_ip_routes_request.RemoveIpRoutesRequest]",
    ) -> AsyncOperationResponse[
        "capo_directory_service.types.remove_ip_routes_result.RemoveIpRoutesResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.remove_ip_routes

        (
            output,
            http_response,
        ) = await capo_directory_service._operations.directory_service_20150416.remove_ip_routes.async_remove_ip_routes(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RemoveIpRoutes")
    )
    input_: capo_directory_service.types.remove_ip_routes_request.RemoveIpRoutesRequest = {
        "directory_id": directory_id
    }
    if cidr_ips is not None:
        input_["cidr_ips"] = cidr_ips
    if cidr_ipv6s is not None:
        input_["cidr_ipv6s"] = cidr_ipv6s

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

remove_ip_routes async ¶

remove_ip_routes `async` ¶