oracle.oci.oci_data_science_pipeline_run_facts – Fetches details about one or multiple PipelineRun resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 4.14.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_pipeline_run_facts.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple PipelineRun resources in Oracle Cloud Infrastructure
Returns a list of PipelineRuns.
If pipeline_run_id is specified, the details of a single PipelineRun will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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
|
<b>Filter</b> results by the OCID of the compartment.
Required to list multiple pipeline_runs.
|
|
|
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. |
|
|
created_by
string
|
<b>Filter</b> results by the OCID of the user who created the resource.
|
|
|
display_name
string
|
<b>Filter</b> results by its user-friendly name.
aliases: name |
|
|
lifecycle_state
string
|
|
The current state of the PipelineRun.
|
|
pipeline_id
string
|
The OCID of the pipeline.
|
|
|
pipeline_run_id
string
|
The OCID of the pipeline run.
Required to get a specific pipeline_run.
aliases: id |
|
|
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. |
|
|
sort_by
string
|
|
Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeAccepted`, the results are shown in descending order. When you sort by `displayName`, the results are shown in ascending order. Sort order for the `displayName` field is case sensitive.
|
|
sort_order
string
|
|
Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).
|
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific pipeline_run
oci_data_science_pipeline_run_facts:
# required
pipeline_run_id: "ocid1.pipelinerun.oc1..xxxxxxEXAMPLExxxxxx"
- name: List pipeline_runs
oci_data_science_pipeline_run_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
pipeline_id: "ocid1.pipeline.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
lifecycle_state: ACCEPTED
created_by: created_by_example
sort_order: ASC
sort_by: timeAccepted
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |||
|---|---|---|---|---|---|
|
pipeline_runs
complex
|
on success |
List of PipelineRun resources
Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'configuration_details': {'command_line_arguments': 'command_line_arguments_example', 'environment_variables': {}, 'maximum_runtime_in_minutes': 56, 'type': 'DEFAULT'}, 'configuration_override_details': {'command_line_arguments': 'command_line_arguments_example', 'environment_variables': {}, 'maximum_runtime_in_minutes': 56, 'type': 'DEFAULT'}, 'created_by': 'created_by_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACCEPTED', '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'}, 'log_details': {'log_group_id': 'ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx', 'log_id': 'ocid1.log.oc1..xxxxxxEXAMPLExxxxxx'}, 'pipeline_id': 'ocid1.pipeline.oc1..xxxxxxEXAMPLExxxxxx', 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'step_override_details': [{'step_configuration_details': {'command_line_arguments': 'command_line_arguments_example', 'environment_variables': {}, 'maximum_runtime_in_minutes': 56}, 'step_name': 'step_name_example'}], 'step_runs': [{'job_run_id': 'ocid1.jobrun.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'WAITING', 'step_name': 'step_name_example', 'step_type': 'ML_JOB', 'time_finished': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}], 'system_tags': {}, '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', 'time_updated': '2013-10-20T19:20:30+01:00'}]
|
|||
|
compartment_id
string
|
on success |
The OCID of the compartment where you want to create the pipeline run.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|||
|
configuration_details
complex
|
on success |
Returned for get operation
|
|||
|
command_line_arguments
string
|
on success |
The command line arguments to set for steps in the pipeline.
Sample:
command_line_arguments_example
|
|||
|
environment_variables
dictionary
|
on success |
Environment variables to set for steps in the pipeline.
|
|||
|
maximum_runtime_in_minutes
integer
|
on success |
A time bound for the execution of the entire Pipeline. Timer starts when the Pipeline Run is in progress.
Sample:
56
|
|||
|
type
string
|
on success |
The type of pipeline.
Sample:
DEFAULT
|
|||
|
configuration_override_details
complex
|
on success |
Returned for get operation
|
|||
|
command_line_arguments
string
|
on success |
The command line arguments to set for steps in the pipeline.
Sample:
command_line_arguments_example
|
|||
|
environment_variables
dictionary
|
on success |
Environment variables to set for steps in the pipeline.
|
|||
|
maximum_runtime_in_minutes
integer
|
on success |
A time bound for the execution of the entire Pipeline. Timer starts when the Pipeline Run is in progress.
Sample:
56
|
|||
|
type
string
|
on success |
The type of pipeline.
Sample:
DEFAULT
|
|||
|
created_by
string
|
on success |
The OCID of the user who created the pipeline 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 pipeline run.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||
|
lifecycle_details
string
|
on success |
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
Sample:
lifecycle_details_example
|
|||
|
lifecycle_state
string
|
on success |
The current state of the pipeline run.
Sample:
ACCEPTED
|
|||
|
log_configuration_override_details
complex
|
on success |
Returned for get operation
|
|||
|
enable_auto_log_creation
boolean
|
on success |
If automatic on-behalf-of log object creation is enabled for pipeline runs.
Sample:
True
|
|||
|
enable_logging
boolean
|
on success |
If customer logging is enabled for pipeline.
Sample:
True
|
|||
|
log_group_id
string
|
on success |
The OCID of the log group.
Sample:
ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx
|
|||
|
log_id
string
|
on success |
The OCID of the log.
Sample:
ocid1.log.oc1..xxxxxxEXAMPLExxxxxx
|
|||
|
log_details
complex
|
on success |
Returned for get operation
|
|||
|
log_group_id
string
|
on success |
The log group id for where log objects will be for pipeline runs.
Sample:
ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx
|
|||
|
log_id
string
|
on success |
The log id of the log object the pipeline run logs will be shipped to.
Sample:
ocid1.log.oc1..xxxxxxEXAMPLExxxxxx
|
|||
|
pipeline_id
string
|
on success |
The OCID of the pipeline.
Sample:
ocid1.pipeline.oc1..xxxxxxEXAMPLExxxxxx
|
|||
|
project_id
string
|
on success |
The OCID of the project to associate the pipeline run with.
Sample:
ocid1.project.oc1..xxxxxxEXAMPLExxxxxx
|
|||
|
step_override_details
complex
|
on success |
Array of step override details. Only Step Configuration is allowed to be overridden.
Returned for get operation
|
|||
|
step_configuration_details
complex
|
on success |
|
|||
|
command_line_arguments
string
|
on success |
The command line arguments to set for step.
Sample:
command_line_arguments_example
|
|||
|
environment_variables
dictionary
|
on success |
Environment variables to set for step.
|
|||
|
maximum_runtime_in_minutes
integer
|
on success |
A time bound for the execution of the step.
Sample:
56
|
|||
|
step_name
string
|
on success |
The name of the step.
Sample:
step_name_example
|
|||
|
step_runs
complex
|
on success |
Array of StepRun object for each step.
Returned for get operation
|
|||
|
job_run_id
string
|
on success |
The OCID of the job run triggered for this step run.
Sample:
ocid1.jobrun.oc1..xxxxxxEXAMPLExxxxxx
|
|||
|
lifecycle_details
string
|
on success |
Details of the state of the step run.
Sample:
lifecycle_details_example
|
|||
|
lifecycle_state
string
|
on success |
The state of the step run.
Sample:
WAITING
|
|||
|
step_name
string
|
on success |
The name of the step.
Sample:
step_name_example
|
|||
|
step_type
string
|
on success |
The type of step.
Sample:
ML_JOB
|
|||
|
time_finished
string
|
on success |
The date and time the pipeline step run finshed executing 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 pipeline step run was started in the timestamp format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|||
|
system_tags
dictionary
|
on success |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
|||
|
time_accepted
string
|
on success |
The date and time the pipeline 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 pipeline 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 pipeline run request was started in the timestamp format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|||
|
time_updated
string
|
on success |
The date and time the pipeline run was updated in the timestamp format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|||
Authors¶
Oracle (@oracle)