oracle.oci.oci_media_services_media_asset_facts – Fetches details about one or multiple MediaAsset resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple MediaAsset resources in Oracle Cloud Infrastructure

  • Returns a list of MediaAssetSummary.

  • If media_asset_id is specified, the details of a single MediaAsset will be returned.

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
Filter MediaAsset by the bucket where the object is stored.
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 ID of the compartment in which to list resources.
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.
display_name
string
A filter to return only the resources that match the entire display name given.

aliases: name
distribution_channel_id
string
Unique DistributionChannel identifier.
lifecycle_state
string
    Choices:
  • CREATING
  • UPDATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
A filter to return only the resources with lifecycleState matching the given lifecycleState.
master_media_asset_id
string
Unique MediaAsset identifier of the first asset upload.
media_asset_id
string
Unique MediaAsset identifier
Required to get a specific media_asset.

aliases: id
media_workflow_job_id
string
The ID of the MediaWorkflowJob used to produce this asset, if this parameter is supplied then the workflow ID must also be supplied.
object_name
string
Filter MediaAsset by the name of the object in object storage.
parent_media_asset_id
string
Unique MediaAsset identifier of the asset from which this asset is derived.
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
    Choices:
  • compartmentId
  • type
  • lifecycleState
  • parentMediaAssetId
  • masterMediaAssetId
  • displayName
  • timeCreated
  • timeUpdated
The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'ASC' or 'DESC'.
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.
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
Filter MediaAsset by the asset type.

Examples

- name: Get a specific media_asset
  oci_media_services_media_asset_facts:
    # required
    media_asset_id: "ocid1.mediaasset.oc1..xxxxxxEXAMPLExxxxxx"

- name: List media_assets
  oci_media_services_media_asset_facts:

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    lifecycle_state: CREATING
    sort_order: ASC
    sort_by: compartmentId
    distribution_channel_id: "ocid1.distributionchannel.oc1..xxxxxxEXAMPLExxxxxx"
    parent_media_asset_id: "ocid1.parentmediaasset.oc1..xxxxxxEXAMPLExxxxxx"
    master_media_asset_id: "ocid1.mastermediaasset.oc1..xxxxxxEXAMPLExxxxxx"
    type: AUDIO
    bucket_name: bucket_name_example
    object_name: object_name_example
    media_workflow_job_id: "ocid1.mediaworkflowjob.oc1..xxxxxxEXAMPLExxxxxx"
    source_media_workflow_id: "ocid1.sourcemediaworkflow.oc1..xxxxxxEXAMPLExxxxxx"
    source_media_workflow_version: 56

Return Values

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

Key Returned Description
media_assets
complex
on success
List of MediaAsset resources

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.
Returned for get operation

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.
Returned for get operation
   
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.
Returned for get operation

Sample:
ocid1.mediaworkflowjob.oc1..xxxxxxEXAMPLExxxxxx
 
metadata
complex
on success
List of Metadata.
Returned for get operation
   
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.
Returned for get operation

Sample:
namespace_name_example
 
object_etag
string
on success
eTag of the underlying object storage object.
Returned for get operation

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

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.
Returned for get operation

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

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

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

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)