oracle.oci.oci_data_science_job_run – Manage a JobRun resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_data_science_job_run.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a JobRun resource in Oracle Cloud Infrastructure

  • For state=present, creates a job run.

  • This resource has the following action operations in the oracle.oci.oci_data_science_job_run_actions module: cancel, change_compartment.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
The OCID of the compartment where you want to create the job.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
display_name
string
A user-friendly display name for the resource.
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: `{"Department": "Finance"}`
This parameter is updatable.
job_configuration_override_details
dictionary
command_line_arguments
string
The arguments to pass to the job.
environment_variables
dictionary
Environment variables to set for the job.
job_type
string / required
    Choices:
  • DEFAULT
The type of job.
maximum_runtime_in_minutes
integer
A time bound for the execution of the job. Timer starts when the job becomes active.
job_id
string
The OCID of the job to create a run for.
Required for create using state=present.
job_log_configuration_override_details
dictionary
enable_auto_log_creation
boolean
    Choices:
  • no
  • yes
If automatic on-behalf-of log object creation is enabled for job runs.
enable_logging
boolean
    Choices:
  • no
  • yes
If customer logging is enabled for job runs.
log_group_id
string
The log group id for where log objects are for job runs.
log_id
string
The log id the job run will push logs too.
job_run_id
string
The OCID of the job run.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
project_id
string
The OCID of the project to associate the job with.
Required for create using state=present.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
state
string
    Choices:
  • present ←
  • absent
The state of the JobRun.
Use state=present to create or update a JobRun.
Use state=absent to delete a JobRun.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create job_run
  oci_data_science_job_run:
    # required
    project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    job_id: "ocid1.job.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    job_configuration_override_details:
      # required
      job_type: DEFAULT

      # optional
      environment_variables: null
      command_line_arguments: command_line_arguments_example
      maximum_runtime_in_minutes: 56
    job_log_configuration_override_details:
      # optional
      enable_logging: true
      enable_auto_log_creation: true
      log_group_id: "ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx"
      log_id: "ocid1.log.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update job_run
  oci_data_science_job_run:
    # required
    job_run_id: "ocid1.jobrun.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update job_run using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_data_science_job_run:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete job_run
  oci_data_science_job_run:
    # required
    job_run_id: "ocid1.jobrun.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete job_run using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_data_science_job_run:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
job_run
complex
on success
Details of the JobRun resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'created_by': 'created_by_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'job_configuration_override_details': {'command_line_arguments': 'command_line_arguments_example', 'environment_variables': {}, 'job_type': 'DEFAULT', 'maximum_runtime_in_minutes': 56}, 'job_id': 'ocid1.job.oc1..xxxxxxEXAMPLExxxxxx', 'job_infrastructure_configuration_details': {'block_storage_size_in_gbs': 56, 'job_infrastructure_type': 'STANDALONE', 'job_shape_config_details': {'memory_in_gbs': 3.4, 'ocpus': 3.4}, 'shape_name': 'shape_name_example', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx'}, 'job_log_configuration_override_details': {'enable_auto_log_creation': True, 'enable_logging': True, 'log_group_id': 'ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx', 'log_id': 'ocid1.log.oc1..xxxxxxEXAMPLExxxxxx'}, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACCEPTED', 'log_details': {'log_group_id': 'ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx', 'log_id': 'ocid1.log.oc1..xxxxxxEXAMPLExxxxxx'}, 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'time_accepted': '2013-10-20T19:20:30+01:00', 'time_finished': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}
 
compartment_id
string
on success
The OCID of the compartment where you want to create the job.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
created_by
string
on success
The OCID of the user who created the job run.

Sample:
created_by_example
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
A user-friendly display name for the resource.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the job run.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
job_configuration_override_details
complex
on success

   
command_line_arguments
string
on success
The arguments to pass to the job.

Sample:
command_line_arguments_example
   
environment_variables
dictionary
on success
Environment variables to set for the job.

   
job_type
string
on success
The type of job.

Sample:
DEFAULT
   
maximum_runtime_in_minutes
integer
on success
A time bound for the execution of the job. Timer starts when the job becomes active.

Sample:
56
 
job_id
string
on success
The OCID of the job run.

Sample:
ocid1.job.oc1..xxxxxxEXAMPLExxxxxx
 
job_infrastructure_configuration_details
complex
on success

   
block_storage_size_in_gbs
integer
on success
The size of the block storage volume to attach to the instance running the job

Sample:
56
   
job_infrastructure_type
string
on success
The infrastructure type used for job run.

Sample:
STANDALONE
   
job_shape_config_details
complex
on success

     
memory_in_gbs
float
on success
The total amount of memory available to the job run instance, in gigabytes.

Sample:
3.4
     
ocpus
float
on success
The total number of OCPUs available to the job run instance.

Sample:
3.4
   
shape_name
string
on success
The shape used to launch the job run instances.

Sample:
shape_name_example
   
subnet_id
string
on success
The subnet to create a secondary vnic in to attach to the instance running the job

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
job_log_configuration_override_details
complex
on success

   
enable_auto_log_creation
boolean
on success
If automatic on-behalf-of log object creation is enabled for job runs.

Sample:
True
   
enable_logging
boolean
on success
If customer logging is enabled for job runs.

Sample:
True
   
log_group_id
string
on success
The log group id for where log objects are for job runs.

Sample:
ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx
   
log_id
string
on success
The log id the job run will push logs too.

Sample:
ocid1.log.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
Details of the state of the job run.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The state of the job run.

Sample:
ACCEPTED
 
log_details
complex
on success

   
log_group_id
string
on success
The log group id for where log objects will be for job runs.

Sample:
ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx
   
log_id
string
on success
The log id of the log object the job run logs will be shipped to.

Sample:
ocid1.log.oc1..xxxxxxEXAMPLExxxxxx
 
project_id
string
on success
The OCID of the project to associate the job with.

Sample:
ocid1.project.oc1..xxxxxxEXAMPLExxxxxx
 
time_accepted
string
on success
The date and time the job run was accepted in the timestamp format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_finished
string
on success
The date and time the job run request was finished in the timestamp format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_started
string
on success
The date and time the job run request was started in the timestamp format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)