DataScienceClientCompositeOperations¶

class oci.data_science.DataScienceClientCompositeOperations(client, **kwargs)¶

This class provides a wrapper around DataScienceClient and offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionality

Methods

`__init__`(client, **kwargs)	Creates a new DataScienceClientCompositeOperations object
`activate_model_and_wait_for_state`(model_id)	Calls `activate_model()` and waits for the `Model` acted upon to enter the given state(s).
`activate_model_deployment_and_wait_for_state`(…)	Calls `activate_model_deployment()` and waits for the `WorkRequest` to enter the given state(s).
`activate_notebook_session_and_wait_for_state`(…)	Calls `activate_notebook_session()` and waits for the `WorkRequest` to enter the given state(s).
`change_data_science_private_endpoint_compartment_and_wait_for_state`(…)	Calls `change_data_science_private_endpoint_compartment()` and waits for the `WorkRequest` to enter the given state(s).
`change_model_version_set_compartment_and_wait_for_state`(…)	Calls `change_model_version_set_compartment()` and waits for the `WorkRequest` to enter the given state(s).
`create_data_science_private_endpoint_and_wait_for_state`(…)	Calls `create_data_science_private_endpoint()` and waits for the `WorkRequest` to enter the given state(s).
`create_job_and_wait_for_state`(create_job_details)	Calls `create_job()` and waits for the `Job` acted upon to enter the given state(s).
`create_job_run_and_wait_for_state`(…[, …])	Calls `create_job_run()` and waits for the `JobRun` acted upon to enter the given state(s).
`create_model_and_wait_for_state`(…[, …])	Calls `create_model()` and waits for the `Model` acted upon to enter the given state(s).
`create_model_deployment_and_wait_for_state`(…)	Calls `create_model_deployment()` and waits for the `WorkRequest` to enter the given state(s).
`create_model_version_set_and_wait_for_state`(…)	Calls `create_model_version_set()` and waits for the `ModelVersionSet` acted upon to enter the given state(s).
`create_notebook_session_and_wait_for_state`(…)	Calls `create_notebook_session()` and waits for the `WorkRequest` to enter the given state(s).
`create_pipeline_and_wait_for_state`(…[, …])	Calls `create_pipeline()` and waits for the `Pipeline` acted upon to enter the given state(s).
`create_pipeline_run_and_wait_for_state`(…)	Calls `create_pipeline_run()` and waits for the `PipelineRun` acted upon to enter the given state(s).
`create_project_and_wait_for_state`(…[, …])	Calls `create_project()` and waits for the `Project` acted upon to enter the given state(s).
`deactivate_model_and_wait_for_state`(model_id)	Calls `deactivate_model()` and waits for the `Model` acted upon to enter the given state(s).
`deactivate_model_deployment_and_wait_for_state`(…)	Calls `deactivate_model_deployment()` and waits for the `WorkRequest` to enter the given state(s).
`deactivate_notebook_session_and_wait_for_state`(…)	Calls `deactivate_notebook_session()` and waits for the `WorkRequest` to enter the given state(s).
`delete_data_science_private_endpoint_and_wait_for_state`(…)	Calls `delete_data_science_private_endpoint()` and waits for the `WorkRequest` to enter the given state(s).
`delete_job_and_wait_for_state`(job_id[, …])	Calls `delete_job()` and waits for the `WorkRequest` to enter the given state(s).
`delete_job_run_and_wait_for_state`(job_run_id)	Calls `delete_job_run()` and waits for the `JobRun` acted upon to enter the given state(s).
`delete_model_and_wait_for_state`(model_id[, …])	Calls `delete_model()` and waits for the `Model` acted upon to enter the given state(s).
`delete_model_deployment_and_wait_for_state`(…)	Calls `delete_model_deployment()` and waits for the `WorkRequest` to enter the given state(s).
`delete_model_version_set_and_wait_for_state`(…)	Calls `delete_model_version_set()` and waits for the `WorkRequest` to enter the given state(s).
`delete_notebook_session_and_wait_for_state`(…)	Calls `delete_notebook_session()` and waits for the `WorkRequest` to enter the given state(s).
`delete_pipeline_and_wait_for_state`(pipeline_id)	Calls `delete_pipeline()` and waits for the `WorkRequest` to enter the given state(s).
`delete_pipeline_run_and_wait_for_state`(…)	Calls `delete_pipeline_run()` and waits for the `PipelineRun` acted upon to enter the given state(s).
`delete_project_and_wait_for_state`(project_id)	Calls `delete_project()` and waits for the `WorkRequest` to enter the given state(s).
`export_model_artifact_and_wait_for_state`(…)	Calls `export_model_artifact()` and waits for the `WorkRequest` to enter the given state(s).
`import_model_artifact_and_wait_for_state`(…)	Calls `import_model_artifact()` and waits for the `WorkRequest` to enter the given state(s).
`restore_archived_model_artifact_and_wait_for_state`(…)	Calls `restore_archived_model_artifact()` and waits for the `WorkRequest` to enter the given state(s).
`update_data_science_private_endpoint_and_wait_for_state`(…)	Calls `update_data_science_private_endpoint()` and waits for the `WorkRequest` to enter the given state(s).
`update_job_and_wait_for_state`(job_id, …[, …])	Calls `update_job()` and waits for the `Job` acted upon to enter the given state(s).
`update_job_run_and_wait_for_state`(…[, …])	Calls `update_job_run()` and waits for the `JobRun` acted upon to enter the given state(s).
`update_model_and_wait_for_state`(model_id, …)	Calls `update_model()` and waits for the `Model` acted upon to enter the given state(s).
`update_model_deployment_and_wait_for_state`(…)	Calls `update_model_deployment()` and waits for the `WorkRequest` to enter the given state(s).
`update_model_version_set_and_wait_for_state`(…)	Calls `update_model_version_set()` and waits for the `ModelVersionSet` acted upon to enter the given state(s).
`update_notebook_session_and_wait_for_state`(…)	Calls `update_notebook_session()` and waits for the `NotebookSession` acted upon to enter the given state(s).
`update_pipeline_and_wait_for_state`(…[, …])	Calls `update_pipeline()` and waits for the `Pipeline` acted upon to enter the given state(s).
`update_pipeline_run_and_wait_for_state`(…)	Calls `update_pipeline_run()` and waits for the `PipelineRun` acted upon to enter the given state(s).
`update_project_and_wait_for_state`(…[, …])	Calls `update_project()` and waits for the `Project` acted upon to enter the given state(s).

__init__(client, **kwargs)¶

Creates a new DataScienceClientCompositeOperations object

Parameters:	client (DataScienceClient) – The service client which will be wrapped by this object

activate_model_and_wait_for_state(model_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls activate_model() and waits for the Model acted upon to enter the given state(s).

Parameters:

model_id (str) –
(required) The OCID of the model.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to activate_model()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

activate_model_deployment_and_wait_for_state(model_deployment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls activate_model_deployment() and waits for the WorkRequest to enter the given state(s).

Parameters:

model_deployment_id (str) –
(required) The OCID of the model deployment.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to activate_model_deployment()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

activate_notebook_session_and_wait_for_state(notebook_session_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls activate_notebook_session() and waits for the WorkRequest to enter the given state(s).

Parameters:

notebook_session_id (str) –
(required) The OCID of the notebook session.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to activate_notebook_session()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

change_data_science_private_endpoint_compartment_and_wait_for_state(data_science_private_endpoint_id, change_data_science_private_endpoint_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls change_data_science_private_endpoint_compartment() and waits for the WorkRequest to enter the given state(s).

Parameters:

data_science_private_endpoint_id (str) – (required) The unique ID for a Data Science private endpoint.
change_data_science_private_endpoint_compartment_details (oci.data_science.models.ChangeDataSciencePrivateEndpointCompartmentDetails) – (required) Details for changing a private endpoint’s compartment.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to change_data_science_private_endpoint_compartment()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

change_model_version_set_compartment_and_wait_for_state(model_version_set_id, change_model_version_set_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls change_model_version_set_compartment() and waits for the WorkRequest to enter the given state(s).

Parameters:

model_version_set_id (str) –
(required) The OCID of the model version set.
change_model_version_set_compartment_details (oci.data_science.models.ChangeModelVersionSetCompartmentDetails) – (required) Details for changing the compartment of a model version set.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to change_model_version_set_compartment()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_data_science_private_endpoint_and_wait_for_state(create_data_science_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_data_science_private_endpoint() and waits for the WorkRequest to enter the given state(s).

Parameters:

create_data_science_private_endpoint_details (oci.data_science.models.CreateDataSciencePrivateEndpointDetails) – (required) The parameters required to create a private endpoint.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_data_science_private_endpoint()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_job_and_wait_for_state(create_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_job() and waits for the Job acted upon to enter the given state(s).

Parameters:

create_job_details (oci.data_science.models.CreateJobDetails) – (required) Details for creating a new job.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_job()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_job_run_and_wait_for_state(create_job_run_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_job_run() and waits for the JobRun acted upon to enter the given state(s).

Parameters:

create_job_run_details (oci.data_science.models.CreateJobRunDetails) – (required) Details for creating a new job run.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_job_run()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_model_and_wait_for_state(create_model_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_model() and waits for the Model acted upon to enter the given state(s).

Parameters:

create_model_details (oci.data_science.models.CreateModelDetails) – (required) Details for creating a new model.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_model()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_model_deployment_and_wait_for_state(create_model_deployment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_model_deployment() and waits for the WorkRequest to enter the given state(s).

Parameters:

create_model_deployment_details (oci.data_science.models.CreateModelDeploymentDetails) – (required) Details for creating a new model deployment.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_model_deployment()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_model_version_set_and_wait_for_state(create_model_version_set_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_model_version_set() and waits for the ModelVersionSet acted upon to enter the given state(s).

Parameters:

create_model_version_set_details (oci.data_science.models.CreateModelVersionSetDetails) – (required) Details for creating a new modelVersionSet.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_model_version_set()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_notebook_session_and_wait_for_state(create_notebook_session_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_notebook_session() and waits for the WorkRequest to enter the given state(s).

Parameters:

create_notebook_session_details (oci.data_science.models.CreateNotebookSessionDetails) – (required) Details for creating a new notebook session.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_notebook_session()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_pipeline_and_wait_for_state(create_pipeline_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_pipeline() and waits for the Pipeline acted upon to enter the given state(s).

Parameters:

create_pipeline_details (oci.data_science.models.CreatePipelineDetails) – (required) Details for the new Pipeline.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_pipeline()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_pipeline_run_and_wait_for_state(create_pipeline_run_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_pipeline_run() and waits for the PipelineRun acted upon to enter the given state(s).

Parameters:

create_pipeline_run_details (oci.data_science.models.CreatePipelineRunDetails) – (required) Details for the new PipelineRun.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_pipeline_run()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_project_and_wait_for_state(create_project_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_project() and waits for the Project acted upon to enter the given state(s).

Parameters:

create_project_details (oci.data_science.models.CreateProjectDetails) – (required) Details for creating a new project.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_project()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

deactivate_model_and_wait_for_state(model_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls deactivate_model() and waits for the Model acted upon to enter the given state(s).

Parameters:

model_id (str) –
(required) The OCID of the model.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to deactivate_model()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

deactivate_model_deployment_and_wait_for_state(model_deployment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls deactivate_model_deployment() and waits for the WorkRequest to enter the given state(s).

Parameters:

model_deployment_id (str) –
(required) The OCID of the model deployment.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to deactivate_model_deployment()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

deactivate_notebook_session_and_wait_for_state(notebook_session_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls deactivate_notebook_session() and waits for the WorkRequest to enter the given state(s).

Parameters:

notebook_session_id (str) –
(required) The OCID of the notebook session.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to deactivate_notebook_session()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_data_science_private_endpoint_and_wait_for_state(data_science_private_endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_data_science_private_endpoint() and waits for the WorkRequest to enter the given state(s).

Parameters:

data_science_private_endpoint_id (str) – (required) The unique ID for a Data Science private endpoint.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_data_science_private_endpoint()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_job_and_wait_for_state(job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_job() and waits for the WorkRequest to enter the given state(s).

Parameters:

job_id (str) –
(required) The OCID of the job.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_job()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_job_run_and_wait_for_state(job_run_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_job_run() and waits for the JobRun acted upon to enter the given state(s).

Parameters:

job_run_id (str) –
(required) The OCID of the job run.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_job_run()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_model_and_wait_for_state(model_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_model() and waits for the Model acted upon to enter the given state(s).

Parameters:

model_id (str) –
(required) The OCID of the model.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_model()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_model_deployment_and_wait_for_state(model_deployment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_model_deployment() and waits for the WorkRequest to enter the given state(s).

Parameters:

model_deployment_id (str) –
(required) The OCID of the model deployment.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_model_deployment()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_model_version_set_and_wait_for_state(model_version_set_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_model_version_set() and waits for the WorkRequest to enter the given state(s).

Parameters:

model_version_set_id (str) –
(required) The OCID of the model version set.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_model_version_set()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_notebook_session_and_wait_for_state(notebook_session_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_notebook_session() and waits for the WorkRequest to enter the given state(s).

Parameters:

notebook_session_id (str) –
(required) The OCID of the notebook session.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_notebook_session()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_pipeline_and_wait_for_state(pipeline_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_pipeline() and waits for the WorkRequest to enter the given state(s).

Parameters:

pipeline_id (str) –
(required) The OCID of the pipeline.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_pipeline()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_pipeline_run_and_wait_for_state(pipeline_run_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_pipeline_run() and waits for the PipelineRun acted upon to enter the given state(s).

Parameters:

pipeline_run_id (str) –
(required) The OCID of the pipeline run.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_pipeline_run()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_project_and_wait_for_state(project_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_project() and waits for the WorkRequest to enter the given state(s).

Parameters:

project_id (str) –
(required) The OCID of the project.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_project()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

export_model_artifact_and_wait_for_state(model_id, export_model_artifact_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls export_model_artifact() and waits for the WorkRequest to enter the given state(s).

Parameters:

model_id (str) –
(required) The OCID of the model.
export_model_artifact_details (oci.data_science.models.ExportModelArtifactDetails) – (required) Model artifact source details for exporting.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to export_model_artifact()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

import_model_artifact_and_wait_for_state(model_id, import_model_artifact_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls import_model_artifact() and waits for the WorkRequest to enter the given state(s).

Parameters:

model_id (str) –
(required) The OCID of the model.
import_model_artifact_details (oci.data_science.models.ImportModelArtifactDetails) – (required) Model artifact source details for importing.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to import_model_artifact()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

restore_archived_model_artifact_and_wait_for_state(model_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls restore_archived_model_artifact() and waits for the WorkRequest to enter the given state(s).

Parameters:

model_id (str) –
(required) The OCID of the model.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to restore_archived_model_artifact()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_data_science_private_endpoint_and_wait_for_state(data_science_private_endpoint_id, update_data_science_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_data_science_private_endpoint() and waits for the WorkRequest to enter the given state(s).

Parameters:

data_science_private_endpoint_id (str) – (required) The unique ID for a Data Science private endpoint.
update_data_science_private_endpoint_details (oci.data_science.models.UpdateDataSciencePrivateEndpointDetails) – (required) Details for updating a private endpoint.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_data_science_private_endpoint()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_job_and_wait_for_state(job_id, update_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_job() and waits for the Job acted upon to enter the given state(s).

Parameters:

job_id (str) –
(required) The OCID of the job.
update_job_details (oci.data_science.models.UpdateJobDetails) – (required) Details for updating a job.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_job()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_job_run_and_wait_for_state(job_run_id, update_job_run_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_job_run() and waits for the JobRun acted upon to enter the given state(s).

Parameters:

job_run_id (str) –
(required) The OCID of the job run.
update_job_run_details (oci.data_science.models.UpdateJobRunDetails) – (required) Details for updating a job.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_job_run()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_model_and_wait_for_state(model_id, update_model_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_model() and waits for the Model acted upon to enter the given state(s).

Parameters:

model_id (str) –
(required) The OCID of the model.
update_model_details (oci.data_science.models.UpdateModelDetails) – (required) Details for updating a model. You can update the displayName, description, freeformTags, and definedTags properties.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_model()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_model_deployment_and_wait_for_state(model_deployment_id, update_model_deployment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_model_deployment() and waits for the WorkRequest to enter the given state(s).

Parameters:

model_deployment_id (str) –
(required) The OCID of the model deployment.
update_model_deployment_details (oci.data_science.models.UpdateModelDeploymentDetails) – (required) Details for updating a model deployment. Some of the properties of modelDeploymentConfigurationDetails or CategoryLogDetails can also be updated with zero down time when the model deployment’s lifecycle state is ACTIVE or NEEDS_ATTENTION i.e instanceShapeName, instanceCount and modelId, separately loadBalancerShape or CategoryLogDetails can also be updated independently. All of the fields can be updated when the deployment is in the INACTIVE lifecycle state. Changes will take effect the next time the model deployment is activated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_model_deployment()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_model_version_set_and_wait_for_state(model_version_set_id, update_model_version_set_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_model_version_set() and waits for the ModelVersionSet acted upon to enter the given state(s).

Parameters:

model_version_set_id (str) –
(required) The OCID of the model version set.
update_model_version_set_details (oci.data_science.models.UpdateModelVersionSetDetails) – (required) Details for updating a model version set. You can update description property only.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_model_version_set()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_notebook_session_and_wait_for_state(notebook_session_id, update_notebook_session_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_notebook_session() and waits for the NotebookSession acted upon to enter the given state(s).

Parameters:

notebook_session_id (str) –
(required) The OCID of the notebook session.
update_notebook_session_details (oci.data_science.models.UpdateNotebookSessionDetails) – (required) Details for updating a notebook session. notebookSessionConfigurationDetails can only be updated while the notebook session is in the INACTIVE state. Changes to the notebookSessionConfigurationDetails take effect the next time the ActivateNotebookSession action is invoked on the notebook session resource.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_notebook_session()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_pipeline_and_wait_for_state(pipeline_id, update_pipeline_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_pipeline() and waits for the Pipeline acted upon to enter the given state(s).

Parameters:

pipeline_id (str) –
(required) The OCID of the pipeline.
update_pipeline_details (oci.data_science.models.UpdatePipelineDetails) – (required) The information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_pipeline()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_pipeline_run_and_wait_for_state(pipeline_run_id, update_pipeline_run_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_pipeline_run() and waits for the PipelineRun acted upon to enter the given state(s).

Parameters:

pipeline_run_id (str) –
(required) The OCID of the pipeline run.
update_pipeline_run_details (oci.data_science.models.UpdatePipelineRunDetails) – (required) The information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_pipeline_run()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_project_and_wait_for_state(project_id, update_project_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_project() and waits for the Project acted upon to enter the given state(s).

Parameters:

project_id (str) –
(required) The OCID of the project.
update_project_details (oci.data_science.models.UpdateProjectDetails) – (required) Details for updating a project. You can update the displayName, description, freeformTags, and definedTags properties.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_project()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait