MediaServicesClient¶

class oci.media_services.MediaServicesClient(config, **kwargs)¶

Media Services (includes Media Flow and Media Streams) is a fully managed service for processing media (video) source content. Use Media Flow and Media Streams to transcode and package digital video using configurable workflows and stream video outputs.

Use the Media Services API to configure media workflows and run Media Flow jobs, create distribution channels, ingest assets, create Preview URLs and play assets. For more information, see [Media Flow](/iaas/Content/dms-mediaflow/home.htm) and [Media Streams](/iaas/Content/dms-mediastream/home.htm).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`add_media_asset_lock`(add_lock_details, …)	Add a lock to an MediaAsset.
`add_media_workflow_configuration_lock`(…)	Add a lock to a MediaWorkflowConfiguration.
`add_media_workflow_job_lock`(…)	Add a lock to a MediaWorkflowJob.
`add_media_workflow_lock`(…)	Add a lock to a MediaWorkflow.
`add_stream_cdn_config_lock`(…)	Add a lock to a StreamCdnConfig.
`add_stream_distribution_channel_lock`(…)	Add a lock to a StreamDistributionChannel.
`add_stream_packaging_config_lock`(…)	Add a lock to a StreamPackagingConfig.
`change_media_asset_compartment`(…)	Moves a MediaAsset resource from one compartment identifier to another.
`change_media_workflow_compartment`(…)	Moves a MediaWorkflow resource from one compartment identifier to another.
`change_media_workflow_configuration_compartment`(…)	Moves a MediaWorkflowConfiguration resource from one compartment identifier to another.
`change_media_workflow_job_compartment`(…)	Moves a MediaWorkflowJob resource from one compartment identifier to another.
`change_stream_distribution_channel_compartment`(…)	Moves a Stream Distribution Channel resource from one compartment identifier to another.
`create_media_asset`(…)	Creates a new MediaAsset.
`create_media_workflow`(…)	Creates a new MediaWorkflow.
`create_media_workflow_configuration`(…)	Creates a new MediaWorkflowConfiguration.
`create_media_workflow_job`(…)	Run the MediaWorkflow according to the given mediaWorkflow definition and configuration.
`create_stream_cdn_config`(…)	Creates a new CDN Configuration.
`create_stream_distribution_channel`(…)	Creates a new Stream Distribution Channel.
`create_stream_packaging_config`(…)	Creates a new Packaging Configuration.
`delete_media_asset`(media_asset_id, **kwargs)	Deletes a MediaAsset resource by identifier.
`delete_media_asset_distribution_channel_attachment`(…)	Deletes a MediaAsset from the DistributionChannel by identifiers.
`delete_media_workflow`(media_workflow_id, …)	The MediaWorkflow lifecycleState will change to DELETED.
`delete_media_workflow_configuration`(…)	Deletes a MediaWorkflowConfiguration resource by identifier.
`delete_media_workflow_job`(…)	This is an asynchronous operation.
`delete_stream_cdn_config`(…)	The StreamCdnConfig lifecycleState will change to DELETED.
`delete_stream_distribution_channel`(…)	The Stream Distribution Channel lifecycleState will change to DELETED.
`delete_stream_packaging_config`(…)	The Stream Packaging Configuration lifecycleState will change to DELETED.
`get_media_asset`(media_asset_id, **kwargs)	Gets a MediaAsset by identifier.
`get_media_asset_distribution_channel_attachment`(…)	Gets a MediaAssetDistributionChannelAttachment for a MediaAsset by identifiers.
`get_media_workflow`(media_workflow_id, **kwargs)	Gets a MediaWorkflow by identifier.
`get_media_workflow_configuration`(…)	Gets a MediaWorkflowConfiguration by identifier
`get_media_workflow_job`(…)	Gets the MediaWorkflowJob.
`get_stream_cdn_config`(stream_cdn_config_id, …)	Gets a StreamCdnConfig by identifier.
`get_stream_distribution_channel`(…)	Gets a Stream Distribution Channel by identifier.
`get_stream_packaging_config`(…)	Gets a Stream Packaging Configuration by identifier.
`ingest_stream_distribution_channel`(…)	Ingests an Asset into a Distribution Channel.
`list_media_asset_distribution_channel_attachments`(…)	Lists the MediaAssetDistributionChannelAttachments for a MediaAsset by identifier.
`list_media_assets`(**kwargs)	Returns a list of MediaAssetSummary.
`list_media_workflow_configurations`(**kwargs)	Returns a list of MediaWorkflowConfigurations.
`list_media_workflow_jobs`(**kwargs)	Lists the MediaWorkflowJobs.
`list_media_workflow_task_declarations`(**kwargs)	Returns a list of MediaWorkflowTaskDeclarations.
`list_media_workflows`(**kwargs)	Lists the MediaWorkflows.
`list_stream_cdn_configs`(…)	Lists the StreamCdnConfig.
`list_stream_distribution_channels`(**kwargs)	Lists the Stream Distribution Channels.
`list_stream_packaging_configs`(…)	Lists the Stream Packaging Configurations.
`list_system_media_workflows`(**kwargs)	Lists the SystemMediaWorkflows that can be used to run a job by name or as a template to create a MediaWorkflow.
`remove_media_asset_lock`(remove_lock_details, …)	Remove a lock to an MediaAsset.
`remove_media_workflow_configuration_lock`(…)	Remove a lock from a MediaWorkflowConfiguration.
`remove_media_workflow_job_lock`(…)	Remove a lock from a MediaWorkflowJob.
`remove_media_workflow_lock`(…)	Remove a lock from a MediaWorkflow.
`remove_stream_cdn_config_lock`(…)	Remove a lock from a StreamCdnConfig.
`remove_stream_distribution_channel_lock`(…)	Remove a lock to a StreamDistributionChannel.
`remove_stream_packaging_config_lock`(…)	Remove a lock from a StreamPackagingConfig.
`update_media_asset`(media_asset_id, …)	Updates the MediaAsset.
`update_media_workflow`(media_workflow_id, …)	Updates the MediaWorkflow.
`update_media_workflow_configuration`(…)	Updates the MediaWorkflowConfiguration.
`update_media_workflow_job`(…)	Updates the MediaWorkflowJob.
`update_stream_cdn_config`(…)	Updates the StreamCdnConfig.
`update_stream_distribution_channel`(…)	Updates the Stream Distribution Channel.
`update_stream_packaging_config`(…)	Updates the Stream Packaging Configuration.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

add_media_asset_lock(add_lock_details, media_asset_id, **kwargs)¶

Add a lock to an MediaAsset.

Parameters:	add_lock_details (oci.media_services.models.AddLockDetails) – (required) The details to be updated for the AddLock. media_asset_id (str) – (required) Unique MediaAsset identifier opc_retry_token (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaAsset`
Return type:	`Response`
Example:

Click here to see an example of how to use add_media_asset_lock API.

add_media_workflow_configuration_lock(add_resource_lock_details, media_workflow_configuration_id, **kwargs)¶

Add a lock to a MediaWorkflowConfiguration.

Parameters:	add_resource_lock_details (oci.media_services.models.AddLockDetails) – (required) AddResourceLockDetails body parameter media_workflow_configuration_id (str) – (required) Unique MediaWorkflowConfiguration identifier. if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflowConfiguration`
Return type:	`Response`
Example:

Click here to see an example of how to use add_media_workflow_configuration_lock API.

add_media_workflow_job_lock(add_lock_details, media_workflow_job_id, **kwargs)¶

Add a lock to a MediaWorkflowJob.

Parameters:	add_lock_details (oci.media_services.models.AddLockDetails) – (required) The details to be updated for the AddLock. media_workflow_job_id (str) – (required) Unique MediaWorkflowJob identifier. opc_retry_token (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflowJob`
Return type:	`Response`
Example:

Click here to see an example of how to use add_media_workflow_job_lock API.

add_media_workflow_lock(add_resource_lock_details, media_workflow_id, **kwargs)¶

Add a lock to a MediaWorkflow.

Parameters:	add_resource_lock_details (oci.media_services.models.AddLockDetails) – (required) AddResourceLockDetails body parameter media_workflow_id (str) – (required) Unique MediaWorkflow identifier. opc_retry_token (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflow`
Return type:	`Response`
Example:

Click here to see an example of how to use add_media_workflow_lock API.

add_stream_cdn_config_lock(add_resource_lock_details, stream_cdn_config_id, **kwargs)¶

Add a lock to a StreamCdnConfig.

Parameters:	add_resource_lock_details (oci.media_services.models.AddLockDetails) – (required) AddResourceLockDetails body parameter stream_cdn_config_id (str) – (required) Unique StreamCdnConfig identifier. if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamCdnConfig`
Return type:	`Response`
Example:

Click here to see an example of how to use add_stream_cdn_config_lock API.

add_stream_distribution_channel_lock(add_resource_lock_details, stream_distribution_channel_id, **kwargs)¶

Add a lock to a StreamDistributionChannel.

Parameters:	add_resource_lock_details (oci.media_services.models.AddLockDetails) – (required) AddResourceLockDetails body parameter stream_distribution_channel_id (str) – (required) Unique Stream Distribution Channel path identifier. if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamDistributionChannel`
Return type:	`Response`
Example:

Click here to see an example of how to use add_stream_distribution_channel_lock API.

add_stream_packaging_config_lock(add_resource_lock_details, stream_packaging_config_id, **kwargs)¶

Add a lock to a StreamPackagingConfig.

Parameters:	add_resource_lock_details (oci.media_services.models.AddLockDetails) – (required) AddResourceLockDetails body parameter stream_packaging_config_id (str) – (required) Unique Stream Packaging Configuration path identifier. if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamPackagingConfig`
Return type:	`Response`
Example:

Click here to see an example of how to use add_stream_packaging_config_lock API.

change_media_asset_compartment(media_asset_id, change_media_asset_compartment_details, **kwargs)¶

Moves a MediaAsset resource from one compartment identifier to another.

Parameters:	media_asset_id (str) – (required) Unique MediaAsset identifier change_media_asset_compartment_details (oci.media_services.models.ChangeMediaAssetCompartmentDetails) – (required) The information to be updated. is_lock_override (bool) – (optional) Whether to override locks (if any exist). opc_retry_token (str) – (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. if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_media_asset_compartment API.

change_media_workflow_compartment(media_workflow_id, change_media_workflow_compartment_details, **kwargs)¶

Moves a MediaWorkflow resource from one compartment identifier to another.

Parameters:	media_workflow_id (str) – (required) Unique MediaWorkflow identifier. change_media_workflow_compartment_details (oci.media_services.models.ChangeMediaWorkflowCompartmentDetails) – (required) The change compartment payload. is_lock_override (bool) – (optional) Whether to override locks (if any exist). opc_retry_token (str) – (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. if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_media_workflow_compartment API.

change_media_workflow_configuration_compartment(media_workflow_configuration_id, change_media_workflow_configuration_compartment_details, **kwargs)¶

Moves a MediaWorkflowConfiguration resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:	media_workflow_configuration_id (str) – (required) Unique MediaWorkflowConfiguration identifier. change_media_workflow_configuration_compartment_details (oci.media_services.models.ChangeMediaWorkflowConfigurationCompartmentDetails) – (required) The information to be updated. is_lock_override (bool) – (optional) Whether to override locks (if any exist). opc_retry_token (str) – (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. if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_media_workflow_configuration_compartment API.

change_media_workflow_job_compartment(media_workflow_job_id, change_media_workflow_job_compartment_details, **kwargs)¶

Moves a MediaWorkflowJob resource from one compartment identifier to another.

Parameters:	media_workflow_job_id (str) – (required) Unique MediaWorkflowJob identifier. change_media_workflow_job_compartment_details (oci.media_services.models.ChangeMediaWorkflowJobCompartmentDetails) – (required) The change compartment payload. is_lock_override (bool) – (optional) Whether to override locks (if any exist). opc_retry_token (str) – (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. if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_media_workflow_job_compartment API.

change_stream_distribution_channel_compartment(stream_distribution_channel_id, change_stream_distribution_channel_compartment_details, **kwargs)¶

Moves a Stream Distribution Channel resource from one compartment identifier to another.

Parameters:	stream_distribution_channel_id (str) – (required) Unique Stream Distribution Channel path identifier. change_stream_distribution_channel_compartment_details (oci.media_services.models.ChangeStreamDistributionChannelCompartmentDetails) – (required) The change compartment payload. is_lock_override (bool) – (optional) Whether to override locks (if any exist). opc_retry_token (str) – (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. if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_stream_distribution_channel_compartment API.

create_media_asset(create_media_asset_details, **kwargs)¶

Creates a new MediaAsset.

Parameters:	create_media_asset_details (oci.media_services.models.CreateMediaAssetDetails) – (required) Details for the new MediaAsset. opc_retry_token (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaAsset`
Return type:	`Response`
Example:

Click here to see an example of how to use create_media_asset API.

create_media_workflow(create_media_workflow_details, **kwargs)¶

Creates a new MediaWorkflow.

Parameters:	create_media_workflow_details (oci.media_services.models.CreateMediaWorkflowDetails) – (required) Details for the new MediaWorkflow. opc_retry_token (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflow`
Return type:	`Response`
Example:

Click here to see an example of how to use create_media_workflow API.

create_media_workflow_configuration(create_media_workflow_configuration_details, **kwargs)¶

Creates a new MediaWorkflowConfiguration.

Parameters:	create_media_workflow_configuration_details (oci.media_services.models.CreateMediaWorkflowConfigurationDetails) – (required) Details for the new MediaWorkflowConfiguration. opc_retry_token (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflowConfiguration`
Return type:	`Response`
Example:

Click here to see an example of how to use create_media_workflow_configuration API.

create_media_workflow_job(create_media_workflow_job_details, **kwargs)¶

Run the MediaWorkflow according to the given mediaWorkflow definition and configuration.

Parameters:	create_media_workflow_job_details (oci.media_services.models.CreateMediaWorkflowJobDetails) – (required) The information to run the mediaWorkflow. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflowJob`
Return type:	`Response`
Example:

Click here to see an example of how to use create_media_workflow_job API.

create_stream_cdn_config(create_stream_cdn_config_details, **kwargs)¶

Creates a new CDN Configuration.

Parameters:	create_stream_cdn_config_details (oci.media_services.models.CreateStreamCdnConfigDetails) – (required) Details for the new StreamCdnConfig. opc_retry_token (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamCdnConfig`
Return type:	`Response`
Example:

Click here to see an example of how to use create_stream_cdn_config API.

create_stream_distribution_channel(create_stream_distribution_channel_details, **kwargs)¶

Creates a new Stream Distribution Channel.

Parameters:	create_stream_distribution_channel_details (oci.media_services.models.CreateStreamDistributionChannelDetails) – (required) Details for the new Stream Distribution Channel. opc_retry_token (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamDistributionChannel`
Return type:	`Response`
Example:

Click here to see an example of how to use create_stream_distribution_channel API.

create_stream_packaging_config(create_stream_packaging_config_details, **kwargs)¶

Creates a new Packaging Configuration.

Parameters:	create_stream_packaging_config_details (oci.media_services.models.CreateStreamPackagingConfigDetails) – (required) Details for the new Stream Packaging Configuration. opc_retry_token (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamPackagingConfig`
Return type:	`Response`
Example:

Click here to see an example of how to use create_stream_packaging_config API.

delete_media_asset(media_asset_id, **kwargs)¶

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.

Parameters:	media_asset_id (str) – (required) Unique MediaAsset identifier is_lock_override (bool) – (optional) Whether to override locks (if any exist). if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. delete_mode (str) – (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” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_media_asset API.

delete_media_asset_distribution_channel_attachment(media_asset_id, distribution_channel_id, **kwargs)¶

Deletes a MediaAsset from the DistributionChannel by identifiers.

Parameters:	media_asset_id (str) – (required) Unique MediaAsset identifier distribution_channel_id (str) – (required) Unique DistributionChannel identifier. is_lock_override (bool) – (optional) Whether to override locks (if any exist). if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. version (int) – (optional) Version of the attachment. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_media_asset_distribution_channel_attachment API.

delete_media_workflow(media_workflow_id, **kwargs)¶

The MediaWorkflow lifecycleState will change to DELETED.

Parameters:	media_workflow_id (str) – (required) Unique MediaWorkflow identifier. is_lock_override (bool) – (optional) Whether to override locks (if any exist). opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_media_workflow API.

delete_media_workflow_configuration(media_workflow_configuration_id, **kwargs)¶

Deletes a MediaWorkflowConfiguration resource by identifier.

Parameters:	media_workflow_configuration_id (str) – (required) Unique MediaWorkflowConfiguration identifier. is_lock_override (bool) – (optional) Whether to override locks (if any exist). if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_media_workflow_configuration API.

delete_media_workflow_job(media_workflow_job_id, **kwargs)¶

This is an asynchronous operation. The MediaWorkflowJob lifecycleState will change to CANCELING temporarily until the job is completely CANCELED.

Parameters:	media_workflow_job_id (str) – (required) Unique MediaWorkflowJob identifier. is_lock_override (bool) – (optional) Whether to override locks (if any exist). opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_media_workflow_job API.

delete_stream_cdn_config(stream_cdn_config_id, **kwargs)¶

The StreamCdnConfig lifecycleState will change to DELETED.

Parameters:	stream_cdn_config_id (str) – (required) Unique StreamCdnConfig identifier. is_lock_override (bool) – (optional) Whether to override locks (if any exist). opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_stream_cdn_config API.

delete_stream_distribution_channel(stream_distribution_channel_id, **kwargs)¶

The Stream Distribution Channel lifecycleState will change to DELETED.

Parameters:	stream_distribution_channel_id (str) – (required) Unique Stream Distribution Channel path identifier. is_lock_override (bool) – (optional) Whether to override locks (if any exist). opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_stream_distribution_channel API.

delete_stream_packaging_config(stream_packaging_config_id, **kwargs)¶

The Stream Packaging Configuration lifecycleState will change to DELETED.

Parameters:	stream_packaging_config_id (str) – (required) Unique Stream Packaging Configuration path identifier. is_lock_override (bool) – (optional) Whether to override locks (if any exist). opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_stream_packaging_config API.

get_media_asset(media_asset_id, **kwargs)¶

Gets a MediaAsset by identifier.

Parameters:	media_asset_id (str) – (required) Unique MediaAsset identifier opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaAsset`
Return type:	`Response`
Example:

Click here to see an example of how to use get_media_asset API.

get_media_asset_distribution_channel_attachment(media_asset_id, distribution_channel_id, **kwargs)¶

Gets a MediaAssetDistributionChannelAttachment for a MediaAsset by identifiers.

Parameters:	media_asset_id (str) – (required) Unique MediaAsset identifier distribution_channel_id (str) – (required) Unique DistributionChannel identifier. opc_request_id (str) – (optional) The client request ID for tracing. version (int) – (optional) Version of the attachment. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaAssetDistributionChannelAttachment`
Return type:	`Response`
Example:

Click here to see an example of how to use get_media_asset_distribution_channel_attachment API.

get_media_workflow(media_workflow_id, **kwargs)¶

Gets a MediaWorkflow by identifier.

Parameters:	media_workflow_id (str) – (required) Unique MediaWorkflow identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflow`
Return type:	`Response`
Example:

Click here to see an example of how to use get_media_workflow API.

get_media_workflow_configuration(media_workflow_configuration_id, **kwargs)¶

Gets a MediaWorkflowConfiguration by identifier

Parameters:	media_workflow_configuration_id (str) – (required) Unique MediaWorkflowConfiguration identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflowConfiguration`
Return type:	`Response`
Example:

Click here to see an example of how to use get_media_workflow_configuration API.

get_media_workflow_job(media_workflow_job_id, **kwargs)¶

Gets the MediaWorkflowJob.

Parameters:	media_workflow_job_id (str) – (required) Unique MediaWorkflowJob identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflowJob`
Return type:	`Response`
Example:

Click here to see an example of how to use get_media_workflow_job API.

get_stream_cdn_config(stream_cdn_config_id, **kwargs)¶

Gets a StreamCdnConfig by identifier.

Parameters:	stream_cdn_config_id (str) – (required) Unique StreamCdnConfig identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamCdnConfig`
Return type:	`Response`
Example:

Click here to see an example of how to use get_stream_cdn_config API.

get_stream_distribution_channel(stream_distribution_channel_id, **kwargs)¶

Gets a Stream Distribution Channel by identifier.

Parameters:	stream_distribution_channel_id (str) – (required) Unique Stream Distribution Channel path identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamDistributionChannel`
Return type:	`Response`
Example:

Click here to see an example of how to use get_stream_distribution_channel API.

get_stream_packaging_config(stream_packaging_config_id, **kwargs)¶

Gets a Stream Packaging Configuration by identifier.

Parameters:	stream_packaging_config_id (str) – (required) Unique Stream Packaging Configuration path identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamPackagingConfig`
Return type:	`Response`
Example:

Click here to see an example of how to use get_stream_packaging_config API.

ingest_stream_distribution_channel(stream_distribution_channel_id, ingest_stream_distribution_channel_details, **kwargs)¶

Ingests an Asset into a Distribution Channel.

Parameters:	stream_distribution_channel_id (str) – (required) Unique Stream Distribution Channel path identifier. ingest_stream_distribution_channel_details (oci.media_services.models.IngestStreamDistributionChannelDetails) – (required) Playlist entry information. opc_retry_token (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `IngestStreamDistributionChannelResult`
Return type:	`Response`
Example:

Click here to see an example of how to use ingest_stream_distribution_channel API.

list_media_asset_distribution_channel_attachments(media_asset_id, **kwargs)¶

Lists the MediaAssetDistributionChannelAttachments for a MediaAsset by identifier.

Parameters:	media_asset_id (str) – (required) Unique MediaAsset identifier display_name (str) – (optional) A filter to return only the resources that match the entire display name given. limit (int) – (optional) The maximum number of items to return. page (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (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” distribution_channel_id (str) – (optional) Unique DistributionChannel identifier. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaAssetDistributionChannelAttachmentCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_media_asset_distribution_channel_attachments API.

list_media_assets(**kwargs)¶

Returns a list of MediaAssetSummary.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only the resources that match the entire display name given. limit (int) – (optional) The maximum number of items to return. page (str) – (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. lifecycle_state (str) – (optional) A filter to return only the resources with lifecycleState matching the given lifecycleState. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (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” opc_request_id (str) – (optional) The client request ID for tracing. distribution_channel_id (str) – (optional) Unique DistributionChannel identifier. parent_media_asset_id (str) – (optional) Unique MediaAsset identifier of the asset from which this asset is derived. master_media_asset_id (str) – (optional) Unique MediaAsset identifier of the first asset upload. type (str) – (optional) Filter MediaAsset by the asset type. Allowed values are: “AUDIO”, “VIDEO”, “PLAYLIST”, “IMAGE”, “CAPTION_FILE”, “UNKNOWN” bucket_name (str) – (optional) Filter MediaAsset by the bucket where the object is stored. object_name (str) – (optional) Filter MediaAsset by the name of the object in object storage. media_workflow_job_id (str) – (optional) The ID of the MediaWorkflowJob used to produce this asset, if this parameter is supplied then the workflow ID must also be supplied. source_media_workflow_id (str) – (optional) The ID of the MediaWorkflow used to produce this asset. source_media_workflow_version (int) – (optional) The version of the MediaWorkflow used to produce this asset. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaAssetCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_media_assets API.

list_media_workflow_configurations(**kwargs)¶

Returns a list of MediaWorkflowConfigurations.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. lifecycle_state (str) – (optional) A filter to return only the resources with lifecycleState matching the given lifecycleState. Allowed values are: “ACTIVE”, “NEEDS_ATTENTION”, “DELETED” display_name (str) – (optional) A filter to return only the resources that match the entire display name given. id (str) – (optional) Unique MediaWorkflowConfiguration identifier. limit (int) – (optional) The maximum number of items to return. page (str) – (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. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (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” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflowConfigurationCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_media_workflow_configurations API.

list_media_workflow_jobs(**kwargs)¶

Lists the MediaWorkflowJobs.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. id (str) – (optional) unique MediaWorkflowJob identifier media_workflow_id (str) – (optional) Unique MediaWorkflow identifier. display_name (str) – (optional) A filter to return only the resources that match the entire display name given. lifecycle_state (str) – (optional) A filter to return only the resources with lifecycleState matching the given lifecycleState. Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “REJECTED”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED” page (str) – (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. limit (int) – (optional) The maximum number of items to return. sort_by (str) – (optional) The parameter sort by. Allowed values are: “timeCreated”, “workflowId”, “lifecycleState” sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflowJobCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_media_workflow_jobs API.

list_media_workflow_task_declarations(**kwargs)¶

Returns a list of MediaWorkflowTaskDeclarations.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. name (str) – (optional) A filter to return only the resources with their system defined, unique name matching the given name. version (int) – (optional) A filter to select MediaWorkflowTaskDeclaration by version. is_current (bool) – (optional) A filter to only select the newest version for each MediaWorkflowTaskDeclaration name. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Allowed values are: “name”, “version” limit (int) – (optional) The maximum number of items to return. page (str) – (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. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflowTaskDeclarationCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_media_workflow_task_declarations API.

list_media_workflows(**kwargs)¶

Lists the MediaWorkflows.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. id (str) – (optional) Unique MediaWorkflow identifier. lifecycle_state (str) – (optional) A filter to return only the resources with lifecycleState matching the given lifecycleState. Allowed values are: “ACTIVE”, “NEEDS_ATTENTION”, “DELETED” display_name (str) – (optional) A filter to return only the resources that match the entire display name given. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (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” page (str) – (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. limit (int) – (optional) The maximum number of items to return. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflowCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_media_workflows API.

list_stream_cdn_configs(distribution_channel_id, **kwargs)¶

Lists the StreamCdnConfig.

Parameters:	distribution_channel_id (str) – (required) The Stream Distribution Channel identifier this CdnConfig belongs to. id (str) – (optional) Unique StreamCdnConfig identifier. lifecycle_state (str) – (optional) A filter to return only the resources with lifecycleState matching the given lifecycleState. Allowed values are: “ACTIVE”, “NEEDS_ATTENTION”, “DELETED” display_name (str) – (optional) A filter to return only the resources that match the entire display name given. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (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” page (str) – (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. limit (int) – (optional) The maximum number of items to return. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamCdnConfigCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_stream_cdn_configs API.

list_stream_distribution_channels(**kwargs)¶

Lists the Stream Distribution Channels.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. id (str) – (optional) Unique Stream Distribution Channel identifier. lifecycle_state (str) – (optional) A filter to return only the resources with lifecycleState matching the given lifecycleState. Allowed values are: “ACTIVE”, “NEEDS_ATTENTION”, “DELETED” display_name (str) – (optional) A filter to return only the resources that match the entire display name given. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (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” page (str) – (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. limit (int) – (optional) The maximum number of items to return. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamDistributionChannelCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_stream_distribution_channels API.

list_stream_packaging_configs(distribution_channel_id, **kwargs)¶

Lists the Stream Packaging Configurations.

Parameters:	distribution_channel_id (str) – (required) Unique Stream Distribution Channel identifier. stream_packaging_config_id (str) – (optional) Unique Stream Packaging Configuration identifier. lifecycle_state (str) – (optional) A filter to return only the resources with lifecycleState matching the given lifecycleState. Allowed values are: “ACTIVE”, “NEEDS_ATTENTION”, “DELETED” display_name (str) – (optional) A filter to return only the resources that match the entire display name given. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (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” page (str) – (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. limit (int) – (optional) The maximum number of items to return. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamPackagingConfigCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_stream_packaging_configs API.

list_system_media_workflows(**kwargs)¶

Lists the SystemMediaWorkflows that can be used to run a job by name or as a template to create a MediaWorkflow.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. name (str) – (optional) A filter to return only the resources with their system defined, unique name matching the given name. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” page (str) – (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. limit (int) – (optional) The maximum number of items to return. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SystemMediaWorkflowCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_system_media_workflows API.

remove_media_asset_lock(remove_lock_details, media_asset_id, **kwargs)¶

Remove a lock to an MediaAsset.

Parameters:	remove_lock_details (oci.media_services.models.RemoveLockDetails) – (required) The details to be updated for the RemoveLock. media_asset_id (str) – (required) Unique MediaAsset identifier opc_retry_token (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaAsset`
Return type:	`Response`
Example:

Click here to see an example of how to use remove_media_asset_lock API.

remove_media_workflow_configuration_lock(remove_resource_lock_details, media_workflow_configuration_id, **kwargs)¶

Remove a lock from a MediaWorkflowConfiguration.

Parameters:	remove_resource_lock_details (oci.media_services.models.RemoveLockDetails) – (required) RemoveResourceLockDetails body parameter media_workflow_configuration_id (str) – (required) Unique MediaWorkflowConfiguration identifier. if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflowConfiguration`
Return type:	`Response`
Example:

Click here to see an example of how to use remove_media_workflow_configuration_lock API.

remove_media_workflow_job_lock(remove_lock_details, media_workflow_job_id, **kwargs)¶

Remove a lock from a MediaWorkflowJob.

Parameters:	remove_lock_details (oci.media_services.models.RemoveLockDetails) – (required) The details to be updated for the RemoveLock. media_workflow_job_id (str) – (required) Unique MediaWorkflowJob identifier. opc_retry_token (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflowJob`
Return type:	`Response`
Example:

Click here to see an example of how to use remove_media_workflow_job_lock API.

remove_media_workflow_lock(remove_resource_lock_details, media_workflow_id, **kwargs)¶

Remove a lock from a MediaWorkflow.

Parameters:	remove_resource_lock_details (oci.media_services.models.RemoveLockDetails) – (required) RemoveResourceLockDetails body parameter media_workflow_id (str) – (required) Unique MediaWorkflow identifier. opc_retry_token (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflow`
Return type:	`Response`
Example:

Click here to see an example of how to use remove_media_workflow_lock API.

remove_stream_cdn_config_lock(remove_resource_lock_details, stream_cdn_config_id, **kwargs)¶

Remove a lock from a StreamCdnConfig.

Parameters:	remove_resource_lock_details (oci.media_services.models.RemoveLockDetails) – (required) RemoveResourceLockDetails body parameter stream_cdn_config_id (str) – (required) Unique StreamCdnConfig identifier. if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamCdnConfig`
Return type:	`Response`
Example:

Click here to see an example of how to use remove_stream_cdn_config_lock API.

remove_stream_distribution_channel_lock(remove_resource_lock_details, stream_distribution_channel_id, **kwargs)¶

Remove a lock to a StreamDistributionChannel.

Parameters:	remove_resource_lock_details (oci.media_services.models.RemoveLockDetails) – (required) RemoveResourceLockDetails body parameter stream_distribution_channel_id (str) – (required) Unique Stream Distribution Channel path identifier. if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamDistributionChannel`
Return type:	`Response`
Example:

Click here to see an example of how to use remove_stream_distribution_channel_lock API.

remove_stream_packaging_config_lock(remove_resource_lock_details, stream_packaging_config_id, **kwargs)¶

Remove a lock from a StreamPackagingConfig.

Parameters:	remove_resource_lock_details (oci.media_services.models.RemoveLockDetails) – (required) RemoveResourceLockDetails body parameter stream_packaging_config_id (str) – (required) Unique Stream Packaging Configuration path identifier. if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamPackagingConfig`
Return type:	`Response`
Example:

Click here to see an example of how to use remove_stream_packaging_config_lock API.

update_media_asset(media_asset_id, update_media_asset_details, **kwargs)¶

Updates the MediaAsset.

Parameters:	media_asset_id (str) – (required) Unique MediaAsset identifier update_media_asset_details (oci.media_services.models.UpdateMediaAssetDetails) – (required) The information to be updated. is_lock_override (bool) – (optional) Whether to override locks (if any exist). if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaAsset`
Return type:	`Response`
Example:

Click here to see an example of how to use update_media_asset API.

update_media_workflow(media_workflow_id, update_media_workflow_details, **kwargs)¶

Updates the MediaWorkflow.

Parameters:	media_workflow_id (str) – (required) Unique MediaWorkflow identifier. update_media_workflow_details (oci.media_services.models.UpdateMediaWorkflowDetails) – (required) The information to be updated. is_lock_override (bool) – (optional) Whether to override locks (if any exist). if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflow`
Return type:	`Response`
Example:

Click here to see an example of how to use update_media_workflow API.

update_media_workflow_configuration(media_workflow_configuration_id, update_media_workflow_configuration_details, **kwargs)¶

Updates the MediaWorkflowConfiguration.

Parameters:	media_workflow_configuration_id (str) – (required) Unique MediaWorkflowConfiguration identifier. update_media_workflow_configuration_details (oci.media_services.models.UpdateMediaWorkflowConfigurationDetails) – (required) The information to be updated. is_lock_override (bool) – (optional) Whether to override locks (if any exist). if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflowConfiguration`
Return type:	`Response`
Example:

Click here to see an example of how to use update_media_workflow_configuration API.

update_media_workflow_job(media_workflow_job_id, update_media_workflow_job_details, **kwargs)¶

Updates the MediaWorkflowJob.

Parameters:	media_workflow_job_id (str) – (required) Unique MediaWorkflowJob identifier. update_media_workflow_job_details (oci.media_services.models.UpdateMediaWorkflowJobDetails) – (required) The information to be updated. is_lock_override (bool) – (optional) Whether to override locks (if any exist). if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MediaWorkflowJob`
Return type:	`Response`
Example:

Click here to see an example of how to use update_media_workflow_job API.

update_stream_cdn_config(stream_cdn_config_id, update_stream_cdn_config_details, **kwargs)¶

Updates the StreamCdnConfig.

Parameters:	stream_cdn_config_id (str) – (required) Unique StreamCdnConfig identifier. update_stream_cdn_config_details (oci.media_services.models.UpdateStreamCdnConfigDetails) – (required) The information to be updated. is_lock_override (bool) – (optional) Whether to override locks (if any exist). if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamCdnConfig`
Return type:	`Response`
Example:

Click here to see an example of how to use update_stream_cdn_config API.

update_stream_distribution_channel(stream_distribution_channel_id, update_stream_distribution_channel_details, **kwargs)¶

Updates the Stream Distribution Channel.

Parameters:	stream_distribution_channel_id (str) – (required) Unique Stream Distribution Channel path identifier. update_stream_distribution_channel_details (oci.media_services.models.UpdateStreamDistributionChannelDetails) – (required) The information to be updated. is_lock_override (bool) – (optional) Whether to override locks (if any exist). if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamDistributionChannel`
Return type:	`Response`
Example:

Click here to see an example of how to use update_stream_distribution_channel API.

update_stream_packaging_config(stream_packaging_config_id, update_stream_packaging_config_details, **kwargs)¶

Updates the Stream Packaging Configuration.

Parameters:	stream_packaging_config_id (str) – (required) Unique Stream Packaging Configuration path identifier. update_stream_packaging_config_details (oci.media_services.models.UpdateStreamPackagingConfigDetails) – (required) The information to be updated. is_lock_override (bool) – (optional) Whether to override locks (if any exist). if_match (str) – (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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `StreamPackagingConfig`
Return type:	`Response`
Example:

Click here to see an example of how to use update_stream_packaging_config API.