oracle.oci.oci_media_services_media_workflow_job_actions – Perform actions on a MediaWorkflowJob resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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_media_services_media_workflow_job_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a MediaWorkflowJob resource in Oracle Cloud Infrastructure

  • For action=change_compartment, moves a MediaWorkflowJob resource from one compartment identifier to another.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • change_compartment
The action to perform on the MediaWorkflowJob.
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 / required
The OCID of the compartment into which the resource should be moved.
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.
media_workflow_job_id
string / required
Unique MediaWorkflowJob identifier.

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.
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

Examples

- name: Perform action change_compartment on media_workflow_job
  oci_media_services_media_workflow_job_actions:
    # required
    media_workflow_job_id: "ocid1.mediaworkflowjob.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

Return Values

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

Key Returned Description
media_workflow_job
complex
on success
Details of the MediaWorkflowJob resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', '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', 'media_workflow_configuration_ids': [], 'media_workflow_id': 'ocid1.mediaworkflow.oc1..xxxxxxEXAMPLExxxxxx', 'outputs': [{'asset_type': 'AUDIO', 'bucket_name': 'bucket_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'namespace_name': 'namespace_name_example', 'object_name': 'object_name_example'}], 'parameters': {}, 'runnable': {}, 'system_tags': {}, 'task_lifecycle_state': [{'key': 'key_example', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'lifecycle_state_example'}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_ended': '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
Compartment Identifier.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
Name of the Media Workflow Job. Does not have to be unique. Avoid entering confidential information.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
Unique identifier for this run of the workflow.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
The lifecyle details.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the MediaWorkflowJob.

Sample:
ACCEPTED
 
media_workflow_configuration_ids
list / elements=string
on success
Configurations to be applied to this run of the workflow.

 
media_workflow_id
string
on success
The workflow to execute.

Sample:
ocid1.mediaworkflow.oc1..xxxxxxEXAMPLExxxxxx
 
outputs
complex
on success
A list of JobOutput for the workflowJob.

   
asset_type
string
on success
Type of job output.

Sample:
AUDIO
   
bucket_name
string
on success
The bucket name of the job output.

Sample:
bucket_name_example
   
id
string
on success
The ID associated with the job output.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
namespace_name
string
on success
The namespace name of the job output.

Sample:
namespace_name_example
   
object_name
string
on success
The object name of the job output.

Sample:
object_name_example
 
parameters
dictionary
on success
Parameters that override parameters specified in MediaWorkflowTaskDeclarations, the MediaWorkflow, the MediaWorkflow's MediaWorkflowConfigurations and the MediaWorkflowConfigurations of this MediaWorkflowJob. The parameters are given as JSON. The top level and 2nd level elements must be JSON objects (vs arrays, scalars, etc). The top level keys refer to a task's key and the 2nd level keys refer to a parameter's name.

 
runnable
dictionary
on success
A JSON representation of the job as it will be run by the system. All the task declarations, configurations and parameters are merged. Parameter values are all fully resolved.

 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

 
task_lifecycle_state
complex
on success
Status of each task.

   
key
string
on success
Unique key within a MediaWorkflowJob for the task.

Sample:
key_example
   
lifecycle_details
string
on success
The lifecycle details of MediaWorkflowJob task.

Sample:
lifecycle_details_example
   
lifecycle_state
string
on success
The current state of the MediaWorkflowJob task.

Sample:
lifecycle_state_example
 
time_created
string
on success
Creation time of the job. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_ended
string
on success
Time when the job finished. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_started
string
on success
Time when the job started to execute. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
Updated time of the job. An RFC3339 formatted datetime string.

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


Authors

  • Oracle (@oracle)