Skip to content

enable_directory_data_access

enable_directory_data_access(
    directory_id: DirectoryId,
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
) -> EnableDirectoryDataAccessResult

Enables access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.

Parameters:

  • directory_id (DirectoryId) –

    The directory identifier.

Raises:

Source code in docs_src/capo_directory_service/_services/directory_service.py
def enable_directory_data_access(
    self,
    directory_id: "capo_directory_service.types.directory_id.DirectoryId",
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
) -> "capo_directory_service.types.enable_directory_data_access_result.EnableDirectoryDataAccessResult":
    """<p>Enables access to directory data via the Directory Service Data API for the specified directory. For more information, see <a href="https://docs.aws.amazon.com/directoryservicedata/latest/DirectoryServiceDataAPIReference/Welcome.html">Directory Service Data API Reference</a>.</p>

    Args:
        directory_id: <p>The directory identifier.</p>

    Raises:
        capo_directory_service.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_directory_service.errors.client_exception.ClientException: <p>A client exception has occurred.</p>
        capo_directory_service.errors.directory_does_not_exist_exception.DirectoryDoesNotExistException: <p>The specified directory does not exist in the system.</p>
        capo_directory_service.errors.directory_in_desired_state_exception.DirectoryInDesiredStateException: <p> The directory is already updated to desired update type settings. </p>
        capo_directory_service.errors.directory_unavailable_exception.DirectoryUnavailableException: <p>The specified directory is unavailable.</p>
        capo_directory_service.errors.service_exception.ServiceException: <p>An exception has occurred in Directory Service.</p>
        capo_directory_service.errors.unsupported_operation_exception.UnsupportedOperationException: <p>The operation is not supported.</p>
        capo_directory_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_directory_service.types.enable_directory_data_access_request.EnableDirectoryDataAccessRequest]",
    ) -> OperationResponse[
        "capo_directory_service.types.enable_directory_data_access_result.EnableDirectoryDataAccessResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.enable_directory_data_access

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("EnableDirectoryDataAccess")
    )
    input_: capo_directory_service.types.enable_directory_data_access_request.EnableDirectoryDataAccessRequest = {
        "directory_id": directory_id
    }

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