Skip to content

update_radius

update_radius(
    directory_id: DirectoryId,
    radius_settings: RadiusSettings,
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
) -> UpdateRadiusResult

Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.

Parameters:

  • directory_id (DirectoryId) –

    The identifier of the directory for which to update the RADIUS server information.

  • radius_settings (RadiusSettings) –

    A RadiusSettings object that contains information about the RADIUS server.

Raises:

Examples:

To update Radius The following example updates the Remote Authentication Dial In User Service (RADIUS) server settings for an AD Connector directory.

>>> client.update_radius(directory_id='d-92654abfed', radius_settings={'DisplayLabel': 'MyRadius', 'UseSameUsername': True, 'RadiusTimeout': 1, 'AuthenticationProtocol': 'PAP', 'RadiusPort': 1027, 'RadiusRetries': 1, 'SharedSecret': '12345678', 'RadiusServers': ['172.168.101.113']})
Source code in docs_src/capo_directory_service/_services/directory_service.py
def update_radius(
    self,
    directory_id: "capo_directory_service.types.directory_id.DirectoryId",
    radius_settings: "capo_directory_service.types.radius_settings.RadiusSettings",
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
) -> "capo_directory_service.types.update_radius_result.UpdateRadiusResult":
    """<p>Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.</p>

    Args:
        directory_id: <p>The identifier of the directory for which to update the RADIUS server information.</p>
        radius_settings: <p>A <a>RadiusSettings</a> object that contains information about the RADIUS server.</p>

    Raises:
        capo_directory_service.errors.client_exception.ClientException: <p>A client exception has occurred.</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 update Radius
        The following example updates the Remote Authentication Dial In User Service (RADIUS) server settings for an AD Connector directory.

        >>> client.update_radius(directory_id='d-92654abfed', radius_settings={'DisplayLabel': 'MyRadius', 'UseSameUsername': True, 'RadiusTimeout': 1, 'AuthenticationProtocol': 'PAP', 'RadiusPort': 1027, 'RadiusRetries': 1, 'SharedSecret': '12345678', 'RadiusServers': ['172.168.101.113']})
    """

    def _handler(
        req: "OperationRequest[capo_directory_service.types.update_radius_request.UpdateRadiusRequest]",
    ) -> OperationResponse[
        "capo_directory_service.types.update_radius_result.UpdateRadiusResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.update_radius

        output, http_response = (
            capo_directory_service._operations.directory_service_20150416.update_radius.update_radius(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_directory_service.types.update_radius_request.UpdateRadiusRequest",
    ) -> dict[str, Any]:
        import capo_directory_service.types.update_radius_request

        return capo_directory_service.types.update_radius_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateRadius", redact_input=_redact_input),
    )
    input_: capo_directory_service.types.update_radius_request.UpdateRadiusRequest = {
        "directory_id": directory_id,
        "radius_settings": radius_settings,
    }

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