oracle.oci.oci_media_services_media_asset – Manage a MediaAsset 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_media_services_media_asset.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates a new MediaAsset.

  • This resource has the following action operations in the oracle.oci.oci_media_services_media_asset_actions module: 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.
bucket_name
string
The name of the object storage bucket where this asset is located.
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
Compartment Identifier.
Required for create using state=present.
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. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
delete_mode
string
    Choices:
  • DELETE_CHILDREN
  • DELETE_DERIVATIONS
DeleteMode decides whether to delete all the immediate children or all assets with the asset's ID as their masterMediaAssetId.
display_name
string
Display name for the Media Asset. Does not have to be unique. Avoid entering confidential information.
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
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
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.
master_media_asset_id
string
The ID of the senior most asset from which this asset is derived.
This parameter is updatable.
media_asset_id
string
Unique MediaAsset identifier
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
media_asset_tags
list / elements=dictionary
list of tags for the MediaAsset.
This parameter is updatable.
type
string
    Choices:
  • USER
  • SYSTEM
Type of the tag.
value
string / required
Tag of the MediaAsset.
media_workflow_job_id
string
The ID of the MediaWorkflowJob used to produce this asset.
metadata
list / elements=dictionary
List of Metadata.
This parameter is updatable.
metadata
string / required
JSON string containing the technial metadata for the media asset.
namespace_name
string
The object storage namespace where this asset is located.
object_etag
string
eTag of the underlying object storage object.
object_name
string
The object storage object name that identifies this asset.
parent_media_asset_id
string
The ID of the parent asset from which this asset is derived.
This parameter is updatable.
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.
segment_range_end_index
integer
The end index for video segment files.
segment_range_start_index
integer
The start index for video segment files.
source_media_workflow_id
string
The ID of the MediaWorkflow used to produce this asset.
source_media_workflow_version
integer
The version of the MediaWorkflow used to produce this asset.
state
string
    Choices:
  • present ←
  • absent
The state of the MediaAsset.
Use state=present to create or update a MediaAsset.
Use state=absent to delete a MediaAsset.
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
type
string
    Choices:
  • AUDIO
  • VIDEO
  • PLAYLIST
  • IMAGE
  • CAPTION_FILE
  • UNKNOWN
The type of the media asset.
Required for create using state=present.
This parameter is updatable.
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 media_asset
  oci_media_services_media_asset:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    type: AUDIO

    # optional
    source_media_workflow_id: "ocid1.sourcemediaworkflow.oc1..xxxxxxEXAMPLExxxxxx"
    media_workflow_job_id: "ocid1.mediaworkflowjob.oc1..xxxxxxEXAMPLExxxxxx"
    source_media_workflow_version: 56
    bucket_name: bucket_name_example
    namespace_name: namespace_name_example
    object_name: object_name_example
    object_etag: object_etag_example
    segment_range_start_index: 56
    segment_range_end_index: 56
    display_name: display_name_example
    parent_media_asset_id: "ocid1.parentmediaasset.oc1..xxxxxxEXAMPLExxxxxx"
    master_media_asset_id: "ocid1.mastermediaasset.oc1..xxxxxxEXAMPLExxxxxx"
    metadata:
    - # required
      metadata: metadata_example
    media_asset_tags:
    - # required
      value: value_example

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

- name: Update media_asset
  oci_media_services_media_asset:
    # required
    media_asset_id: "ocid1.mediaasset.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    type: AUDIO
    parent_media_asset_id: "ocid1.parentmediaasset.oc1..xxxxxxEXAMPLExxxxxx"
    master_media_asset_id: "ocid1.mastermediaasset.oc1..xxxxxxEXAMPLExxxxxx"
    metadata:
    - # required
      metadata: metadata_example
    media_asset_tags:
    - # required
      value: value_example

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

- name: Update media_asset using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_media_services_media_asset:
    # required
    display_name: display_name_example

    # optional
    type: AUDIO
    parent_media_asset_id: "ocid1.parentmediaasset.oc1..xxxxxxEXAMPLExxxxxx"
    master_media_asset_id: "ocid1.mastermediaasset.oc1..xxxxxxEXAMPLExxxxxx"
    metadata:
    - # required
      metadata: metadata_example
    media_asset_tags:
    - # required
      value: value_example

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

- name: Delete media_asset
  oci_media_services_media_asset:
    # required
    media_asset_id: "ocid1.mediaasset.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

    # optional
    delete_mode: DELETE_CHILDREN

- name: Delete media_asset using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_media_services_media_asset:
    # required
    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
media_asset
complex
on success
Details of the MediaAsset resource acted upon by the current operation

Sample:
{'bucket_name': 'bucket_name_example', '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_state': 'CREATING', 'master_media_asset_id': 'ocid1.mastermediaasset.oc1..xxxxxxEXAMPLExxxxxx', 'media_asset_tags': [{'type': 'USER', 'value': 'value_example'}], 'media_workflow_job_id': 'ocid1.mediaworkflowjob.oc1..xxxxxxEXAMPLExxxxxx', 'metadata': [{'metadata': 'metadata_example'}], 'namespace_name': 'namespace_name_example', 'object_etag': 'object_etag_example', 'object_name': 'object_name_example', 'parent_media_asset_id': 'ocid1.parentmediaasset.oc1..xxxxxxEXAMPLExxxxxx', 'segment_range_end_index': 56, 'segment_range_start_index': 56, 'source_media_workflow_id': 'ocid1.sourcemediaworkflow.oc1..xxxxxxEXAMPLExxxxxx', 'source_media_workflow_version': 56, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'AUDIO'}
 
bucket_name
string
on success
The name of the object storage bucket where this represented asset is located.

Sample:
bucket_name_example
 
compartment_id
string
on success
The ID of the compartment containing the MediaAsset.

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
A user-friendly name. Does not have to be unique, and it's changeable. 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 that is immutable on creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of the MediaAsset.

Sample:
CREATING
 
master_media_asset_id
string
on success
The ID of the senior most asset from which this asset is derived.

Sample:
ocid1.mastermediaasset.oc1..xxxxxxEXAMPLExxxxxx
 
media_asset_tags
complex
on success
List of tags for the MediaAsset.

   
type
string
on success
Type of the tag.

Sample:
USER
   
value
string
on success
Tag of the MediaAsset.

Sample:
value_example
 
media_workflow_job_id
string
on success
The ID of the MediaWorkflowJob used to produce this asset.

Sample:
ocid1.mediaworkflowjob.oc1..xxxxxxEXAMPLExxxxxx
 
metadata
complex
on success
List of Metadata.

   
metadata
string
on success
JSON string containing the technial metadata for the media asset.

Sample:
metadata_example
 
namespace_name
string
on success
The object storage namespace where this asset is located.

Sample:
namespace_name_example
 
object_etag
string
on success
eTag of the underlying object storage object.

Sample:
object_etag_example
 
object_name
string
on success
The object storage object name that identifies this asset.

Sample:
object_name_example
 
parent_media_asset_id
string
on success
The ID of the parent asset from which this asset is derived.

Sample:
ocid1.parentmediaasset.oc1..xxxxxxEXAMPLExxxxxx
 
segment_range_end_index
integer
on success
The end index of video segment files.

Sample:
56
 
segment_range_start_index
integer
on success
The start index for video segment files.

Sample:
56
 
source_media_workflow_id
string
on success
The ID of the MediaWorkflow used to produce this asset.

Sample:
ocid1.sourcemediaworkflow.oc1..xxxxxxEXAMPLExxxxxx
 
source_media_workflow_version
integer
on success
The version of the MediaWorkflow used to produce this asset.

Sample:
56
 
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_created
string
on success
The time when the MediaAsset was created. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time when the MediaAsset was updated. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
type
string
on success
The type of the media asset.

Sample:
AUDIO


Authors

  • Oracle (@oracle)