oracle.oci.oci_data_labeling_service_dataset_actions – Perform actions on a Dataset resource 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_labeling_service_dataset_actions
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on a Dataset resource in Oracle Cloud Infrastructure
For action=add_dataset_labels, add Labels to the Dataset LabelSet until the maximum number of Labels has been reached.
For action=change_compartment, moves a Dataset resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
For action=generate_dataset_records, generates Record resources from the Dataset’s data source
For action=import_pre_annotated_data, imports records and annotations from dataset files into existing Dataset.
For action=remove_dataset_labels, removes the labels from the Dataset Labelset. Labels can only be removed if there are no Annotations associated with the Dataset that reference the Label names.
For action=rename_dataset_labels, renames the labels from the Dataset Labelset. Labels that are renamed will be reflected in Annotations associated with the Dataset that reference the Label names.
For action=snapshot, writes the dataset records and annotations in a consolidated format out to an object storage reference for consumption. While the snapshot takes place, there may be a time while records and annotations cannot be created to ensure the snapshot is a point in time.
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 | ||
---|---|---|---|---|
action
string
/ required
|
|
The action to perform on the Dataset.
|
||
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 ). |
|||
are_annotations_included
boolean
|
|
Whether annotations are to be included in the export dataset digest.
Required for action=snapshot.
|
||
are_unannotated_records_included
boolean
|
|
Whether to include records that have yet to be annotated in the export dataset digest.
Required for action=snapshot.
|
||
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
|
The OCID of the compartment where the resource should be moved.
Required for action=change_compartment.
|
|||
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 . |
|||
dataset_id
string
/ required
|
Unique Dataset OCID
aliases: id |
|||
export_details
dictionary
|
Required for action=snapshot.
|
|||
bucket
string
/ required
|
Bucket name
|
|||
export_type
string
/ required
|
|
The target destination for the snapshot. Using OBJECT_STORAGE means the snapshot will be written to Object Storage.
|
||
namespace
string
/ required
|
Bucket namespace name
|
|||
prefix
string
|
Object path prefix to put snapshot file(s)
|
|||
export_format
dictionary
|
Applicable only for action=snapshot.
|
|||
name
string
|
|
Name of export format.
|
||
version
string
|
|
Version of export format.
|
||
import_format
dictionary
|
Applicable only for action=import_pre_annotated_data.
|
|||
name
string
/ required
|
|
Name of import format
|
||
version
string
|
|
Version of import format
|
||
import_metadata_path
dictionary
|
Applicable only for action=import_pre_annotated_data.
|
|||
bucket
string
/ required
|
Bucket name
|
|||
namespace
string
/ required
|
Bucket namespace name
|
|||
path
string
/ required
|
Path for the metadata file.
|
|||
source_type
string
/ required
|
|
The type of data source. OBJECT_STORAGE - The source details for an object storage bucket.
|
||
label_set
dictionary
|
Applicable only for action=add_dataset_labelsaction=remove_dataset_labels.
|
|||
items
list
/ elements=dictionary
|
An ordered collection of labels that are unique by name.
|
|||
name
string
|
An unique name for a label within its dataset.
|
|||
limit
float
|
the maximum number of records to generate.
Applicable only for action=generate_dataset_records.
|
|||
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. |
|||
source_label_set
dictionary
|
Applicable only for action=rename_dataset_labels.
|
|||
items
list
/ elements=dictionary
|
An ordered collection of labels that are unique by name.
|
|||
name
string
|
An unique name for a label within its dataset.
|
|||
target_label_set
dictionary
|
Applicable only for action=rename_dataset_labels.
|
|||
items
list
/ elements=dictionary
|
An ordered collection of labels that are unique by name.
|
|||
name
string
|
An unique name for a label within its dataset.
|
|||
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
|
|
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.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Perform action add_dataset_labels on dataset
oci_data_labeling_service_dataset_actions:
# required
dataset_id: "ocid1.dataset.oc1..xxxxxxEXAMPLExxxxxx"
action: add_dataset_labels
# optional
label_set:
# optional
items:
- # optional
name: name_example
- name: Perform action change_compartment on dataset
oci_data_labeling_service_dataset_actions:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
dataset_id: "ocid1.dataset.oc1..xxxxxxEXAMPLExxxxxx"
action: change_compartment
- name: Perform action generate_dataset_records on dataset
oci_data_labeling_service_dataset_actions:
# required
dataset_id: "ocid1.dataset.oc1..xxxxxxEXAMPLExxxxxx"
action: generate_dataset_records
# optional
limit: 3.4
- name: Perform action import_pre_annotated_data on dataset
oci_data_labeling_service_dataset_actions:
# required
dataset_id: "ocid1.dataset.oc1..xxxxxxEXAMPLExxxxxx"
action: import_pre_annotated_data
# optional
import_format:
# required
name: JSONL_CONSOLIDATED
# optional
version: V2003
import_metadata_path:
# required
source_type: OBJECT_STORAGE
namespace: namespace_example
bucket: bucket_example
path: path_example
- name: Perform action remove_dataset_labels on dataset
oci_data_labeling_service_dataset_actions:
# required
dataset_id: "ocid1.dataset.oc1..xxxxxxEXAMPLExxxxxx"
action: remove_dataset_labels
# optional
label_set:
# optional
items:
- # optional
name: name_example
- name: Perform action rename_dataset_labels on dataset
oci_data_labeling_service_dataset_actions:
# required
dataset_id: "ocid1.dataset.oc1..xxxxxxEXAMPLExxxxxx"
action: rename_dataset_labels
# optional
source_label_set:
# optional
items:
- # optional
name: name_example
target_label_set:
# optional
items:
- # optional
name: name_example
- name: Perform action snapshot on dataset
oci_data_labeling_service_dataset_actions:
# required
dataset_id: "ocid1.dataset.oc1..xxxxxxEXAMPLExxxxxx"
are_annotations_included: true
are_unannotated_records_included: true
export_details:
# required
export_type: OBJECT_STORAGE
namespace: namespace_example
bucket: bucket_example
# optional
prefix: prefix_example
action: snapshot
# optional
export_format:
# optional
name: JSONL
version: V2003
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)