Skip to content

InsertMediaToSearchLibProps

Properties for defining a InsertMediaToSearchLib.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ice-insertmediatosearchlib

Initializer 

import ros_cdk_ice
ros_cdk_ice.InsertMediaToSearchLibProps(
  input: typing.Union[str, IResolvable],
  media_id: typing.Union[str, IResolvable] = None,
  media_type: typing.Union[str, IResolvable] = None,
  msg_body: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  search_lib_name: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
input typing.Union[str, ros_cdk_core.IResolvable] Property input: The URL of the video, audio, or image file that you want to import to the search library.
media_id typing.Union[str, ros_cdk_core.IResolvable] Property mediaId: The ID of the media asset.
media_type typing.Union[str, ros_cdk_core.IResolvable] Property mediaType: The type of the media asset.
msg_body typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property msgBody: The message body.
search_lib_name typing.Union[str, ros_cdk_core.IResolvable] Property searchLibName: The name of the search library.

inputRequired 

input: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property input: The URL of the video, audio, or image file that you want to import to the search library.

Note: Make sure that you specify a correct file name and the bucket in which the file resides is in the same region where this operation is called. Otherwise, the file cannot be found or the operation may fail. Specify an Object Storage Service (OSS) URL in the following format: oss://[Bucket name]/[File path]. For example, you can specify oss://[example-bucket-]/[object_path-]. Specify an HTTP URL in the following format: public endpoint. For example, you can specify http://example-test-****.mp4.

media_idOptional 

media_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property mediaId: The ID of the media asset.

Each media ID is unique. If you leave this parameter empty, a media ID is automatically generated for this parameter.

media_typeOptional 

media_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property mediaType: The type of the media asset.

Valid values: video (default) image audio

msg_bodyOptional 

msg_body: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property msgBody: The message body.

search_lib_nameOptional 

search_lib_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property searchLibName: The name of the search library.

Default value: ims-default-search-lib.