Media Services Functions
Package: DBMS_CLOUD_OCI_MDS_MEDIA_SERVICES
CHANGE_MEDIA_ASSET_COMPARTMENT Function
Moves a MediaAsset resource from one compartment identifier to another.
Syntax
FUNCTION change_media_asset_compartment (
media_asset_id varchar2,
change_media_asset_compartment_details dbms_cloud_oci_media_services_change_media_asset_compartment_details_t,
opc_retry_token varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_change_media_asset_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaAsset identifier |
|
(required) The information to be updated. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_MEDIA_WORKFLOW_COMPARTMENT Function
Moves a MediaWorkflow resource from one compartment identifier to another.
Syntax
FUNCTION change_media_workflow_compartment (
media_workflow_id varchar2,
change_media_workflow_compartment_details dbms_cloud_oci_media_services_change_media_workflow_compartment_details_t,
opc_retry_token varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_change_media_workflow_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaWorkflow identifier. |
|
(required) The change compartment payload. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_MEDIA_WORKFLOW_CONFIGURATION_COMPARTMENT Function
Moves a MediaWorkflowConfiguration resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_media_workflow_configuration_compartment (
media_workflow_configuration_id varchar2,
change_media_workflow_configuration_compartment_details dbms_cloud_oci_media_services_change_media_workflow_configuration_compartment_details_t,
opc_retry_token varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_change_media_workflow_configuration_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaWorkflowConfiguration identifier. |
|
(required) The information to be updated. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_MEDIA_WORKFLOW_JOB_COMPARTMENT Function
Moves a MediaWorkflowJob resource from one compartment identifier to another.
Syntax
FUNCTION change_media_workflow_job_compartment (
media_workflow_job_id varchar2,
change_media_workflow_job_compartment_details dbms_cloud_oci_media_services_change_media_workflow_job_compartment_details_t,
opc_retry_token varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_change_media_workflow_job_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaWorkflowJob identifier. |
|
(required) The change compartment payload. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_STREAM_DISTRIBUTION_CHANNEL_COMPARTMENT Function
Moves a Stream Distribution Channel resource from one compartment identifier to another.
Syntax
FUNCTION change_stream_distribution_channel_compartment (
stream_distribution_channel_id varchar2,
change_stream_distribution_channel_compartment_details dbms_cloud_oci_media_services_change_stream_distribution_channel_compartment_details_t,
opc_retry_token varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_change_stream_distribution_channel_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Stream Distribution Channel path identifier. |
|
(required) The change compartment payload. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_MEDIA_ASSET Function
Creates a new MediaAsset.
Syntax
FUNCTION create_media_asset (
create_media_asset_details dbms_cloud_oci_media_services_create_media_asset_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_create_media_asset_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new MediaAsset. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_MEDIA_WORKFLOW Function
Creates a new MediaWorkflow.
Syntax
FUNCTION create_media_workflow (
create_media_workflow_details dbms_cloud_oci_media_services_create_media_workflow_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_create_media_workflow_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new MediaWorkflow. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_MEDIA_WORKFLOW_CONFIGURATION Function
Creates a new MediaWorkflowConfiguration.
Syntax
FUNCTION create_media_workflow_configuration (
create_media_workflow_configuration_details dbms_cloud_oci_media_services_create_media_workflow_configuration_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_create_media_workflow_configuration_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new MediaWorkflowConfiguration. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_MEDIA_WORKFLOW_JOB Function
Run the MediaWorkflow according to the given mediaWorkflow definition and configuration.
Syntax
FUNCTION create_media_workflow_job (
create_media_workflow_job_details dbms_cloud_oci_media_services_create_media_workflow_job_details_t,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_create_media_workflow_job_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The information to run the mediaWorkflow. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_STREAM_CDN_CONFIG Function
Creates a new CDN Configuration.
Syntax
FUNCTION create_stream_cdn_config (
create_stream_cdn_config_details dbms_cloud_oci_media_services_create_stream_cdn_config_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_create_stream_cdn_config_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new StreamCdnConfig. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_STREAM_DISTRIBUTION_CHANNEL Function
Creates a new Stream Distribution Channel.
Syntax
FUNCTION create_stream_distribution_channel (
create_stream_distribution_channel_details dbms_cloud_oci_media_services_create_stream_distribution_channel_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_create_stream_distribution_channel_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new Stream Distribution Channel. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_STREAM_PACKAGING_CONFIG Function
Creates a new Packaging Configuration.
Syntax
FUNCTION create_stream_packaging_config (
create_stream_packaging_config_details dbms_cloud_oci_media_services_create_stream_packaging_config_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_create_stream_packaging_config_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new Stream Packaging Configuration. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_MEDIA_ASSET Function
Deletes a MediaAsset resource by identifier. If DeleteChildren is passed in as the mode, all the assets with the parentMediaAssetId matching the ID will be deleted. If DeleteDerivatives is set as the mode, all the assets with the masterMediaAssetId matching the ID will be deleted.
Syntax
FUNCTION delete_media_asset (
media_asset_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
delete_mode varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_delete_media_asset_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaAsset identifier |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) DeleteMode decides whether to delete all the immediate children or all assets with the asset's ID as their masterMediaAssetId. Allowed values are: 'DELETE_CHILDREN', 'DELETE_DERIVATIONS' |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_MEDIA_ASSET_DISTRIBUTION_CHANNEL_ATTACHMENT Function
Deletes a MediaAsset from the DistributionChannel by identifiers.
Syntax
FUNCTION delete_media_asset_distribution_channel_attachment (
media_asset_id varchar2,
distribution_channel_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
version number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_delete_media_asset_distribution_channel_attachment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaAsset identifier |
|
(required) Unique DistributionChannel identifier. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) Version of the attachment. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_MEDIA_WORKFLOW Function
The MediaWorkflow lifecycleState will change to DELETED.
Syntax
FUNCTION delete_media_workflow (
media_workflow_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_delete_media_workflow_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaWorkflow identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_MEDIA_WORKFLOW_CONFIGURATION Function
Deletes a MediaWorkflowConfiguration resource by identifier.
Syntax
FUNCTION delete_media_workflow_configuration (
media_workflow_configuration_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_delete_media_workflow_configuration_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaWorkflowConfiguration identifier. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_MEDIA_WORKFLOW_JOB Function
This is an asynchronous operation. The MediaWorkflowJob lifecycleState will change to CANCELING temporarily until the job is completely CANCELED.
Syntax
FUNCTION delete_media_workflow_job (
media_workflow_job_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_delete_media_workflow_job_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaWorkflowJob identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_STREAM_CDN_CONFIG Function
The StreamCdnConfig lifecycleState will change to DELETED.
Syntax
FUNCTION delete_stream_cdn_config (
stream_cdn_config_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_delete_stream_cdn_config_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique StreamCdnConfig identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_STREAM_DISTRIBUTION_CHANNEL Function
The Stream Distribution Channel lifecycleState will change to DELETED.
Syntax
FUNCTION delete_stream_distribution_channel (
stream_distribution_channel_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_delete_stream_distribution_channel_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Stream Distribution Channel path identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_STREAM_PACKAGING_CONFIG Function
The Stream Packaging Configuration lifecycleState will change to DELETED.
Syntax
FUNCTION delete_stream_packaging_config (
stream_packaging_config_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_delete_stream_packaging_config_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Stream Packaging Configuration path identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_MEDIA_ASSET Function
Gets a MediaAsset by identifier.
Syntax
FUNCTION get_media_asset (
media_asset_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_get_media_asset_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaAsset identifier |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_MEDIA_ASSET_DISTRIBUTION_CHANNEL_ATTACHMENT Function
Gets a MediaAssetDistributionChannelAttachment for a MediaAsset by identifiers.
Syntax
FUNCTION get_media_asset_distribution_channel_attachment (
media_asset_id varchar2,
distribution_channel_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
version number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_get_media_asset_distribution_channel_attachment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaAsset identifier |
|
(required) Unique DistributionChannel identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) Version of the attachment. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_MEDIA_WORKFLOW Function
Gets a MediaWorkflow by identifier.
Syntax
FUNCTION get_media_workflow (
media_workflow_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_get_media_workflow_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaWorkflow identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_MEDIA_WORKFLOW_CONFIGURATION Function
Gets a MediaWorkflowConfiguration by identifier
Syntax
FUNCTION get_media_workflow_configuration (
media_workflow_configuration_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_get_media_workflow_configuration_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaWorkflowConfiguration identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_MEDIA_WORKFLOW_JOB Function
Gets the MediaWorkflowJob.
Syntax
FUNCTION get_media_workflow_job (
media_workflow_job_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_get_media_workflow_job_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaWorkflowJob identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_MEDIA_WORKFLOW_JOB_FACT Function
Get the MediaWorkflowJobFact identified by the mediaWorkflowJobId and Fact ID.
Syntax
FUNCTION get_media_workflow_job_fact (
media_workflow_job_id varchar2,
key number,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_get_media_workflow_job_fact_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaWorkflowJob identifier. |
|
(required) Identifier of the MediaWorkflowJobFact within a MediaWorkflowJob. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_STREAM_CDN_CONFIG Function
Gets a StreamCdnConfig by identifier.
Syntax
FUNCTION get_stream_cdn_config (
stream_cdn_config_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_get_stream_cdn_config_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique StreamCdnConfig identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_STREAM_DISTRIBUTION_CHANNEL Function
Gets a Stream Distribution Channel by identifier.
Syntax
FUNCTION get_stream_distribution_channel (
stream_distribution_channel_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_get_stream_distribution_channel_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Stream Distribution Channel path identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_STREAM_PACKAGING_CONFIG Function
Gets a Stream Packaging Configuration by identifier.
Syntax
FUNCTION get_stream_packaging_config (
stream_packaging_config_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_get_stream_packaging_config_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Stream Packaging Configuration path identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
INGEST_STREAM_DISTRIBUTION_CHANNEL Function
Ingests an Asset into a Distribution Channel.
Syntax
FUNCTION ingest_stream_distribution_channel (
stream_distribution_channel_id varchar2,
ingest_stream_distribution_channel_details dbms_cloud_oci_media_services_ingest_stream_distribution_channel_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_ingest_stream_distribution_channel_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Stream Distribution Channel path identifier. |
|
(required) Playlist entry information. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_MEDIA_ASSET_DISTRIBUTION_CHANNEL_ATTACHMENTS Function
Lists the MediaAssetDistributionChannelAttachments for a MediaAsset by identifier.
Syntax
FUNCTION list_media_asset_distribution_channel_attachments (
media_asset_id varchar2,
display_name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
distribution_channel_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_list_media_asset_distribution_channel_attachments_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaAsset identifier |
|
(optional) A filter to return only the resources that match the entire display name given. |
|
(optional) The maximum number of items to return. |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The client request ID for tracing. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: 'mediaAssetId', 'distributionChannelId', 'displayName', 'version' |
|
(optional) Unique DistributionChannel identifier. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_MEDIA_ASSETS Function
Returns a list of MediaAssetSummary.
Syntax
FUNCTION list_media_assets (
compartment_id varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
distribution_channel_id varchar2 DEFAULT NULL,
parent_media_asset_id varchar2 DEFAULT NULL,
master_media_asset_id varchar2 DEFAULT NULL,
l_type varchar2 DEFAULT NULL,
bucket_name varchar2 DEFAULT NULL,
object_name varchar2 DEFAULT NULL,
media_workflow_job_id varchar2 DEFAULT NULL,
source_media_workflow_id varchar2 DEFAULT NULL,
source_media_workflow_version number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_list_media_assets_response_t;
Parameters
Parameter | Description |
---|---|
|
(optional) The ID of the compartment in which to list resources. |
|
(optional) A filter to return only the resources that match the entire display name given. |
|
(optional) The maximum number of items to return. |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) A filter to return only the resources with lifecycleState matching the given lifecycleState. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: 'compartmentId', 'type', 'lifecycleState', 'parentMediaAssetId', 'masterMediaAssetId', 'displayName', 'timeCreated', 'timeUpdated' |
|
(optional) The client request ID for tracing. |
|
(optional) Unique DistributionChannel identifier. |
|
(optional) Unique MediaAsset identifier of the asset from which this asset is derived. |
|
(optional) Unique MediaAsset identifier of the first asset upload. |
|
(optional) Filter MediaAsset by the asset type. Allowed values are: 'AUDIO', 'VIDEO', 'PLAYLIST', 'IMAGE', 'CAPTION_FILE', 'UNKNOWN' |
|
(optional) Filter MediaAsset by the bucket where the object is stored. |
|
(optional) Filter MediaAsset by the name of the object in object storage. |
|
(optional) The ID of the MediaWorkflowJob used to produce this asset, if this parameter is supplied then the workflow ID must also be supplied. |
|
(optional) The ID of the MediaWorkflow used to produce this asset. |
|
(optional) The version of the MediaWorkflow used to produce this asset. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_MEDIA_WORKFLOW_CONFIGURATIONS Function
Returns a list of MediaWorkflowConfigurations.
Syntax
FUNCTION list_media_workflow_configurations (
compartment_id varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
id varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_list_media_workflow_configurations_response_t;
Parameters
Parameter | Description |
---|---|
|
(optional) The ID of the compartment in which to list resources. |
|
(optional) A filter to return only the resources with lifecycleState matching the given lifecycleState. |
|
(optional) A filter to return only the resources that match the entire display name given. |
|
(optional) Unique MediaWorkflowConfiguration identifier. |
|
(optional) The maximum number of items to return. |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: 'timeCreated', 'displayName' |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_MEDIA_WORKFLOW_JOB_FACTS Function
Internal API to get a point-in-time snapshot of a MediaWorkflowJob.
Syntax
FUNCTION list_media_workflow_job_facts (
media_workflow_job_id varchar2,
key number DEFAULT NULL,
l_type varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_list_media_workflow_job_facts_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaWorkflowJob identifier. |
|
(optional) Filter by MediaWorkflowJob ID and MediaWorkflowJobFact key. |
|
(optional) Types of details to include. Allowed values are: 'runnableJob', 'taskDeclaration', 'workflow', 'configuration', 'parameterResolutionEvent' |
|
(optional) Types of details to include. Allowed values are: 'key' |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The maximum number of items to return. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_MEDIA_WORKFLOW_JOBS Function
Lists the MediaWorkflowJobs.
Syntax
FUNCTION list_media_workflow_jobs (
compartment_id varchar2 DEFAULT NULL,
id varchar2 DEFAULT NULL,
media_workflow_id varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_list_media_workflow_jobs_response_t;
Parameters
Parameter | Description |
---|---|
|
(optional) The ID of the compartment in which to list resources. |
|
(optional) unique MediaWorkflowJob identifier |
|
(optional) Unique MediaWorkflow identifier. |
|
(optional) A filter to return only the resources that match the entire display name given. |
|
(optional) A filter to return only the resources with lifecycleState matching the given lifecycleState. |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The maximum number of items to return. |
|
(optional) The parameter sort by. Allowed values are: 'timeCreated', 'workflowId', 'lifecycleState' |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_MEDIA_WORKFLOW_TASK_DECLARATIONS Function
Returns a list of MediaWorkflowTaskDeclarations.
Syntax
FUNCTION list_media_workflow_task_declarations (
compartment_id varchar2 DEFAULT NULL,
name varchar2 DEFAULT NULL,
version number DEFAULT NULL,
is_current number DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_list_media_workflow_task_declarations_response_t;
Parameters
Parameter | Description |
---|---|
|
(optional) The ID of the compartment in which to list resources. |
|
(optional) A filter to return only the resources with their system defined, unique name matching the given name. |
|
(optional) A filter to select MediaWorkflowTaskDeclaration by version. |
|
(optional) A filter to only select the newest version for each MediaWorkflowTaskDeclaration name. |
|
(optional) The field to sort by. Only one sort order may be provided. Allowed values are: 'name', 'version' |
|
(optional) The maximum number of items to return. |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_MEDIA_WORKFLOWS Function
Lists the MediaWorkflows.
Syntax
FUNCTION list_media_workflows (
compartment_id varchar2 DEFAULT NULL,
id varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_list_media_workflows_response_t;
Parameters
Parameter | Description |
---|---|
|
(optional) The ID of the compartment in which to list resources. |
|
(optional) Unique MediaWorkflow identifier. |
|
(optional) A filter to return only the resources with lifecycleState matching the given lifecycleState. |
|
(optional) A filter to return only the resources that match the entire display name given. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: 'timeCreated', 'displayName' |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The maximum number of items to return. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_STREAM_CDN_CONFIGS Function
Lists the StreamCdnConfig.
Syntax
FUNCTION list_stream_cdn_configs (
distribution_channel_id varchar2,
id varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_list_stream_cdn_configs_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The Stream Distribution Channel identifier this CdnConfig belongs to. |
|
(optional) Unique StreamCdnConfig identifier. |
|
(optional) A filter to return only the resources with lifecycleState matching the given lifecycleState. |
|
(optional) A filter to return only the resources that match the entire display name given. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: 'timeCreated', 'displayName' |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The maximum number of items to return. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_STREAM_DISTRIBUTION_CHANNELS Function
Lists the Stream Distribution Channels.
Syntax
FUNCTION list_stream_distribution_channels (
compartment_id varchar2 DEFAULT NULL,
id varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_list_stream_distribution_channels_response_t;
Parameters
Parameter | Description |
---|---|
|
(optional) The ID of the compartment in which to list resources. |
|
(optional) Unique Stream Distribution Channel identifier. |
|
(optional) A filter to return only the resources with lifecycleState matching the given lifecycleState. |
|
(optional) A filter to return only the resources that match the entire display name given. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: 'timeCreated', 'displayName' |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The maximum number of items to return. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_STREAM_PACKAGING_CONFIGS Function
Lists the Stream Packaging Configurations.
Syntax
FUNCTION list_stream_packaging_configs (
distribution_channel_id varchar2,
stream_packaging_config_id varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_list_stream_packaging_configs_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Stream Distribution Channel identifier. |
|
(optional) Unique Stream Packaging Configuration identifier. |
|
(optional) A filter to return only the resources with lifecycleState matching the given lifecycleState. |
|
(optional) A filter to return only the resources that match the entire display name given. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: 'timeCreated', 'displayName' |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The maximum number of items to return. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_SYSTEM_MEDIA_WORKFLOWS Function
Lists the SystemMediaWorkflows that can be used to run a job by name or as a template to create a MediaWorkflow.
Syntax
FUNCTION list_system_media_workflows (
compartment_id varchar2 DEFAULT NULL,
name varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_list_system_media_workflows_response_t;
Parameters
Parameter | Description |
---|---|
|
(optional) The ID of the compartment in which to list resources. |
|
(optional) A filter to return only the resources with their system defined, unique name matching the given name. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The maximum number of items to return. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_MEDIA_ASSET Function
Updates the MediaAsset.
Syntax
FUNCTION update_media_asset (
media_asset_id varchar2,
update_media_asset_details dbms_cloud_oci_media_services_update_media_asset_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_update_media_asset_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaAsset identifier |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_MEDIA_WORKFLOW Function
Updates the MediaWorkflow.
Syntax
FUNCTION update_media_workflow (
media_workflow_id varchar2,
update_media_workflow_details dbms_cloud_oci_media_services_update_media_workflow_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_update_media_workflow_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaWorkflow identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_MEDIA_WORKFLOW_CONFIGURATION Function
Updates the MediaWorkflowConfiguration.
Syntax
FUNCTION update_media_workflow_configuration (
media_workflow_configuration_id varchar2,
update_media_workflow_configuration_details dbms_cloud_oci_media_services_update_media_workflow_configuration_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_update_media_workflow_configuration_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaWorkflowConfiguration identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_MEDIA_WORKFLOW_JOB Function
Updates the MediaWorkflowJob.
Syntax
FUNCTION update_media_workflow_job (
media_workflow_job_id varchar2,
update_media_workflow_job_details dbms_cloud_oci_media_services_update_media_workflow_job_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_update_media_workflow_job_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique MediaWorkflowJob identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_STREAM_CDN_CONFIG Function
Updates the StreamCdnConfig.
Syntax
FUNCTION update_stream_cdn_config (
stream_cdn_config_id varchar2,
update_stream_cdn_config_details dbms_cloud_oci_media_services_update_stream_cdn_config_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_update_stream_cdn_config_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique StreamCdnConfig identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_STREAM_DISTRIBUTION_CHANNEL Function
Updates the Stream Distribution Channel.
Syntax
FUNCTION update_stream_distribution_channel (
stream_distribution_channel_id varchar2,
update_stream_distribution_channel_details dbms_cloud_oci_media_services_update_stream_distribution_channel_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_update_stream_distribution_channel_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Stream Distribution Channel path identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_STREAM_PACKAGING_CONFIG Function
Updates the Stream Packaging Configuration.
Syntax
FUNCTION update_stream_packaging_config (
stream_packaging_config_id varchar2,
update_stream_packaging_config_details dbms_cloud_oci_media_services_update_stream_packaging_config_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_mds_media_services_update_stream_packaging_config_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Stream Packaging Configuration path identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://mediaservices.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |