oracle.oci.oci_data_science_model_version_set_facts – Fetches details about one or multiple ModelVersionSet resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_model_version_set_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple ModelVersionSet resources in Oracle Cloud Infrastructure
Lists model version sets in the specified compartment.
If model_version_set_id is specified, the details of a single ModelVersionSet 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 model_version_sets.
|
|
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.
|
|
lifecycle_state
string
|
|
<b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.
|
model_version_set_id
string
|
The OCID of the model version set.
Required to get a specific model_version_set.
aliases: id |
|
name
string
|
A filter to return only resources that match the entire name given.
|
|
project_id
string
|
<b>Filter</b> results by the OCID of the project.
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
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 `timeCreated`, the results are shown in descending order.
|
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 model_version_set
oci_data_science_model_version_set_facts:
# required
model_version_set_id: "ocid1.modelversionset.oc1..xxxxxxEXAMPLExxxxxx"
- name: List model_version_sets
oci_data_science_model_version_set_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
name: name_example
lifecycle_state: ACTIVE
created_by: created_by_example
sort_order: ASC
sort_by: timeCreated
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
model_version_sets
complex
|
on success |
List of ModelVersionSet resources
Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'created_by': 'created_by_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACTIVE', 'name': 'name_example', 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '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 model version set compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|
created_by
string
|
on success |
The OCID of the user who created the model version set.
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'}}
|
|
description
string
|
on success |
A short description of the model version set.
Returned for get operation
Sample:
description_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 model version set.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
lifecycle_state
string
|
on success |
The state of the model version set.
Sample:
ACTIVE
|
|
name
string
|
on success |
A user-friendly name for the resource.
Sample:
name_example
|
|
project_id
string
|
on success |
The OCID of the project associated with the model version set.
Sample:
ocid1.project.oc1..xxxxxxEXAMPLExxxxxx
|
|
time_created
string
|
on success |
The date and time that the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z
Sample:
2013-10-20T19:20:30+01:00
|
|
time_updated
string
|
on success |
The date and time that the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)