1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. AiVision
  5. StreamJob
Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi

oci.AiVision.StreamJob

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi

    This resource provides the Stream Job resource in Oracle Cloud Infrastructure Ai Vision service.

    Create a stream analysis job with given inputs and features.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testStreamJob = new oci.aivision.StreamJob("test_stream_job", {
        compartmentId: compartmentId,
        features: [{
            featureType: streamJobFeaturesFeatureType,
            maxResults: streamJobFeaturesMaxResults,
            shouldReturnLandmarks: streamJobFeaturesShouldReturnLandmarks,
            trackingTypes: [{
                biometricStoreCompartmentId: testCompartment.id,
                biometricStoreId: testBiometricStore.id,
                detectionModelId: testModel.id,
                maxResults: streamJobFeaturesTrackingTypesMaxResults,
                objects: streamJobFeaturesTrackingTypesObjects,
                shouldReturnLandmarks: streamJobFeaturesTrackingTypesShouldReturnLandmarks,
                trackingModelId: testModel.id,
            }],
        }],
        streamOutputLocation: {
            bucket: streamJobStreamOutputLocationBucket,
            namespace: streamJobStreamOutputLocationNamespace,
            outputLocationType: streamJobStreamOutputLocationOutputLocationType,
            prefix: streamJobStreamOutputLocationPrefix,
            oboToken: streamJobStreamOutputLocationOboToken,
        },
        streamSourceId: testStreamSource.id,
        definedTags: streamJobDefinedTags,
        displayName: streamJobDisplayName,
        freeformTags: streamJobFreeformTags,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_stream_job = oci.aivision.StreamJob("test_stream_job",
        compartment_id=compartment_id,
        features=[{
            "feature_type": stream_job_features_feature_type,
            "max_results": stream_job_features_max_results,
            "should_return_landmarks": stream_job_features_should_return_landmarks,
            "tracking_types": [{
                "biometric_store_compartment_id": test_compartment["id"],
                "biometric_store_id": test_biometric_store["id"],
                "detection_model_id": test_model["id"],
                "max_results": stream_job_features_tracking_types_max_results,
                "objects": stream_job_features_tracking_types_objects,
                "should_return_landmarks": stream_job_features_tracking_types_should_return_landmarks,
                "tracking_model_id": test_model["id"],
            }],
        }],
        stream_output_location={
            "bucket": stream_job_stream_output_location_bucket,
            "namespace": stream_job_stream_output_location_namespace,
            "output_location_type": stream_job_stream_output_location_output_location_type,
            "prefix": stream_job_stream_output_location_prefix,
            "obo_token": stream_job_stream_output_location_obo_token,
        },
        stream_source_id=test_stream_source["id"],
        defined_tags=stream_job_defined_tags,
        display_name=stream_job_display_name,
        freeform_tags=stream_job_freeform_tags)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/aivision"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := aivision.NewStreamJob(ctx, "test_stream_job", &aivision.StreamJobArgs{
    			CompartmentId: pulumi.Any(compartmentId),
    			Features: aivision.StreamJobFeatureArray{
    				&aivision.StreamJobFeatureArgs{
    					FeatureType:           pulumi.Any(streamJobFeaturesFeatureType),
    					MaxResults:            pulumi.Any(streamJobFeaturesMaxResults),
    					ShouldReturnLandmarks: pulumi.Any(streamJobFeaturesShouldReturnLandmarks),
    					TrackingTypes: aivision.StreamJobFeatureTrackingTypeArray{
    						&aivision.StreamJobFeatureTrackingTypeArgs{
    							BiometricStoreCompartmentId: pulumi.Any(testCompartment.Id),
    							BiometricStoreId:            pulumi.Any(testBiometricStore.Id),
    							DetectionModelId:            pulumi.Any(testModel.Id),
    							MaxResults:                  pulumi.Any(streamJobFeaturesTrackingTypesMaxResults),
    							Objects:                     pulumi.Any(streamJobFeaturesTrackingTypesObjects),
    							ShouldReturnLandmarks:       pulumi.Any(streamJobFeaturesTrackingTypesShouldReturnLandmarks),
    							TrackingModelId:             pulumi.Any(testModel.Id),
    						},
    					},
    				},
    			},
    			StreamOutputLocation: &aivision.StreamJobStreamOutputLocationArgs{
    				Bucket:             pulumi.Any(streamJobStreamOutputLocationBucket),
    				Namespace:          pulumi.Any(streamJobStreamOutputLocationNamespace),
    				OutputLocationType: pulumi.Any(streamJobStreamOutputLocationOutputLocationType),
    				Prefix:             pulumi.Any(streamJobStreamOutputLocationPrefix),
    				OboToken:           pulumi.Any(streamJobStreamOutputLocationOboToken),
    			},
    			StreamSourceId: pulumi.Any(testStreamSource.Id),
    			DefinedTags:    pulumi.Any(streamJobDefinedTags),
    			DisplayName:    pulumi.Any(streamJobDisplayName),
    			FreeformTags:   pulumi.Any(streamJobFreeformTags),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testStreamJob = new Oci.AiVision.StreamJob("test_stream_job", new()
        {
            CompartmentId = compartmentId,
            Features = new[]
            {
                new Oci.AiVision.Inputs.StreamJobFeatureArgs
                {
                    FeatureType = streamJobFeaturesFeatureType,
                    MaxResults = streamJobFeaturesMaxResults,
                    ShouldReturnLandmarks = streamJobFeaturesShouldReturnLandmarks,
                    TrackingTypes = new[]
                    {
                        new Oci.AiVision.Inputs.StreamJobFeatureTrackingTypeArgs
                        {
                            BiometricStoreCompartmentId = testCompartment.Id,
                            BiometricStoreId = testBiometricStore.Id,
                            DetectionModelId = testModel.Id,
                            MaxResults = streamJobFeaturesTrackingTypesMaxResults,
                            Objects = streamJobFeaturesTrackingTypesObjects,
                            ShouldReturnLandmarks = streamJobFeaturesTrackingTypesShouldReturnLandmarks,
                            TrackingModelId = testModel.Id,
                        },
                    },
                },
            },
            StreamOutputLocation = new Oci.AiVision.Inputs.StreamJobStreamOutputLocationArgs
            {
                Bucket = streamJobStreamOutputLocationBucket,
                Namespace = streamJobStreamOutputLocationNamespace,
                OutputLocationType = streamJobStreamOutputLocationOutputLocationType,
                Prefix = streamJobStreamOutputLocationPrefix,
                OboToken = streamJobStreamOutputLocationOboToken,
            },
            StreamSourceId = testStreamSource.Id,
            DefinedTags = streamJobDefinedTags,
            DisplayName = streamJobDisplayName,
            FreeformTags = streamJobFreeformTags,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.AiVision.StreamJob;
    import com.pulumi.oci.AiVision.StreamJobArgs;
    import com.pulumi.oci.AiVision.inputs.StreamJobFeatureArgs;
    import com.pulumi.oci.AiVision.inputs.StreamJobStreamOutputLocationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var testStreamJob = new StreamJob("testStreamJob", StreamJobArgs.builder()
                .compartmentId(compartmentId)
                .features(StreamJobFeatureArgs.builder()
                    .featureType(streamJobFeaturesFeatureType)
                    .maxResults(streamJobFeaturesMaxResults)
                    .shouldReturnLandmarks(streamJobFeaturesShouldReturnLandmarks)
                    .trackingTypes(StreamJobFeatureTrackingTypeArgs.builder()
                        .biometricStoreCompartmentId(testCompartment.id())
                        .biometricStoreId(testBiometricStore.id())
                        .detectionModelId(testModel.id())
                        .maxResults(streamJobFeaturesTrackingTypesMaxResults)
                        .objects(streamJobFeaturesTrackingTypesObjects)
                        .shouldReturnLandmarks(streamJobFeaturesTrackingTypesShouldReturnLandmarks)
                        .trackingModelId(testModel.id())
                        .build())
                    .build())
                .streamOutputLocation(StreamJobStreamOutputLocationArgs.builder()
                    .bucket(streamJobStreamOutputLocationBucket)
                    .namespace(streamJobStreamOutputLocationNamespace)
                    .outputLocationType(streamJobStreamOutputLocationOutputLocationType)
                    .prefix(streamJobStreamOutputLocationPrefix)
                    .oboToken(streamJobStreamOutputLocationOboToken)
                    .build())
                .streamSourceId(testStreamSource.id())
                .definedTags(streamJobDefinedTags)
                .displayName(streamJobDisplayName)
                .freeformTags(streamJobFreeformTags)
                .build());
    
        }
    }
    
    resources:
      testStreamJob:
        type: oci:AiVision:StreamJob
        name: test_stream_job
        properties:
          compartmentId: ${compartmentId}
          features:
            - featureType: ${streamJobFeaturesFeatureType}
              maxResults: ${streamJobFeaturesMaxResults}
              shouldReturnLandmarks: ${streamJobFeaturesShouldReturnLandmarks}
              trackingTypes:
                - biometricStoreCompartmentId: ${testCompartment.id}
                  biometricStoreId: ${testBiometricStore.id}
                  detectionModelId: ${testModel.id}
                  maxResults: ${streamJobFeaturesTrackingTypesMaxResults}
                  objects: ${streamJobFeaturesTrackingTypesObjects}
                  shouldReturnLandmarks: ${streamJobFeaturesTrackingTypesShouldReturnLandmarks}
                  trackingModelId: ${testModel.id}
          streamOutputLocation:
            bucket: ${streamJobStreamOutputLocationBucket}
            namespace: ${streamJobStreamOutputLocationNamespace}
            outputLocationType: ${streamJobStreamOutputLocationOutputLocationType}
            prefix: ${streamJobStreamOutputLocationPrefix}
            oboToken: ${streamJobStreamOutputLocationOboToken}
          streamSourceId: ${testStreamSource.id}
          definedTags: ${streamJobDefinedTags}
          displayName: ${streamJobDisplayName}
          freeformTags: ${streamJobFreeformTags}
    

    Create StreamJob Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new StreamJob(name: string, args: StreamJobArgs, opts?: CustomResourceOptions);
    @overload
    def StreamJob(resource_name: str,
                  args: StreamJobArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def StreamJob(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  compartment_id: Optional[str] = None,
                  features: Optional[Sequence[StreamJobFeatureArgs]] = None,
                  stream_output_location: Optional[StreamJobStreamOutputLocationArgs] = None,
                  stream_source_id: Optional[str] = None,
                  defined_tags: Optional[Mapping[str, str]] = None,
                  display_name: Optional[str] = None,
                  freeform_tags: Optional[Mapping[str, str]] = None,
                  state: Optional[str] = None)
    func NewStreamJob(ctx *Context, name string, args StreamJobArgs, opts ...ResourceOption) (*StreamJob, error)
    public StreamJob(string name, StreamJobArgs args, CustomResourceOptions? opts = null)
    public StreamJob(String name, StreamJobArgs args)
    public StreamJob(String name, StreamJobArgs args, CustomResourceOptions options)
    
    type: oci:AiVision:StreamJob
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args StreamJobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StreamJobArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StreamJobArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StreamJobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StreamJobArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var streamJobResource = new Oci.AiVision.StreamJob("streamJobResource", new()
    {
        CompartmentId = "string",
        Features = new[]
        {
            new Oci.AiVision.Inputs.StreamJobFeatureArgs
            {
                FeatureType = "string",
                MaxResults = 0,
                ShouldReturnLandmarks = false,
                TrackingTypes = new[]
                {
                    new Oci.AiVision.Inputs.StreamJobFeatureTrackingTypeArgs
                    {
                        BiometricStoreCompartmentId = "string",
                        BiometricStoreId = "string",
                        DetectionModelId = "string",
                        MaxResults = 0,
                        Objects = new[]
                        {
                            "string",
                        },
                        ShouldReturnLandmarks = false,
                        TrackingModelId = "string",
                    },
                },
            },
        },
        StreamOutputLocation = new Oci.AiVision.Inputs.StreamJobStreamOutputLocationArgs
        {
            Bucket = "string",
            Namespace = "string",
            OutputLocationType = "string",
            Prefix = "string",
            OboToken = "string",
        },
        StreamSourceId = "string",
        DefinedTags = 
        {
            { "string", "string" },
        },
        DisplayName = "string",
        FreeformTags = 
        {
            { "string", "string" },
        },
        State = "string",
    });
    
    example, err := aivision.NewStreamJob(ctx, "streamJobResource", &aivision.StreamJobArgs{
    	CompartmentId: pulumi.String("string"),
    	Features: aivision.StreamJobFeatureArray{
    		&aivision.StreamJobFeatureArgs{
    			FeatureType:           pulumi.String("string"),
    			MaxResults:            pulumi.Int(0),
    			ShouldReturnLandmarks: pulumi.Bool(false),
    			TrackingTypes: aivision.StreamJobFeatureTrackingTypeArray{
    				&aivision.StreamJobFeatureTrackingTypeArgs{
    					BiometricStoreCompartmentId: pulumi.String("string"),
    					BiometricStoreId:            pulumi.String("string"),
    					DetectionModelId:            pulumi.String("string"),
    					MaxResults:                  pulumi.Int(0),
    					Objects: pulumi.StringArray{
    						pulumi.String("string"),
    					},
    					ShouldReturnLandmarks: pulumi.Bool(false),
    					TrackingModelId:       pulumi.String("string"),
    				},
    			},
    		},
    	},
    	StreamOutputLocation: &aivision.StreamJobStreamOutputLocationArgs{
    		Bucket:             pulumi.String("string"),
    		Namespace:          pulumi.String("string"),
    		OutputLocationType: pulumi.String("string"),
    		Prefix:             pulumi.String("string"),
    		OboToken:           pulumi.String("string"),
    	},
    	StreamSourceId: pulumi.String("string"),
    	DefinedTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	DisplayName: pulumi.String("string"),
    	FreeformTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	State: pulumi.String("string"),
    })
    
    var streamJobResource = new StreamJob("streamJobResource", StreamJobArgs.builder()
        .compartmentId("string")
        .features(StreamJobFeatureArgs.builder()
            .featureType("string")
            .maxResults(0)
            .shouldReturnLandmarks(false)
            .trackingTypes(StreamJobFeatureTrackingTypeArgs.builder()
                .biometricStoreCompartmentId("string")
                .biometricStoreId("string")
                .detectionModelId("string")
                .maxResults(0)
                .objects("string")
                .shouldReturnLandmarks(false)
                .trackingModelId("string")
                .build())
            .build())
        .streamOutputLocation(StreamJobStreamOutputLocationArgs.builder()
            .bucket("string")
            .namespace("string")
            .outputLocationType("string")
            .prefix("string")
            .oboToken("string")
            .build())
        .streamSourceId("string")
        .definedTags(Map.of("string", "string"))
        .displayName("string")
        .freeformTags(Map.of("string", "string"))
        .state("string")
        .build());
    
    stream_job_resource = oci.aivision.StreamJob("streamJobResource",
        compartment_id="string",
        features=[{
            "feature_type": "string",
            "max_results": 0,
            "should_return_landmarks": False,
            "tracking_types": [{
                "biometric_store_compartment_id": "string",
                "biometric_store_id": "string",
                "detection_model_id": "string",
                "max_results": 0,
                "objects": ["string"],
                "should_return_landmarks": False,
                "tracking_model_id": "string",
            }],
        }],
        stream_output_location={
            "bucket": "string",
            "namespace": "string",
            "output_location_type": "string",
            "prefix": "string",
            "obo_token": "string",
        },
        stream_source_id="string",
        defined_tags={
            "string": "string",
        },
        display_name="string",
        freeform_tags={
            "string": "string",
        },
        state="string")
    
    const streamJobResource = new oci.aivision.StreamJob("streamJobResource", {
        compartmentId: "string",
        features: [{
            featureType: "string",
            maxResults: 0,
            shouldReturnLandmarks: false,
            trackingTypes: [{
                biometricStoreCompartmentId: "string",
                biometricStoreId: "string",
                detectionModelId: "string",
                maxResults: 0,
                objects: ["string"],
                shouldReturnLandmarks: false,
                trackingModelId: "string",
            }],
        }],
        streamOutputLocation: {
            bucket: "string",
            namespace: "string",
            outputLocationType: "string",
            prefix: "string",
            oboToken: "string",
        },
        streamSourceId: "string",
        definedTags: {
            string: "string",
        },
        displayName: "string",
        freeformTags: {
            string: "string",
        },
        state: "string",
    });
    
    type: oci:AiVision:StreamJob
    properties:
        compartmentId: string
        definedTags:
            string: string
        displayName: string
        features:
            - featureType: string
              maxResults: 0
              shouldReturnLandmarks: false
              trackingTypes:
                - biometricStoreCompartmentId: string
                  biometricStoreId: string
                  detectionModelId: string
                  maxResults: 0
                  objects:
                    - string
                  shouldReturnLandmarks: false
                  trackingModelId: string
        freeformTags:
            string: string
        state: string
        streamOutputLocation:
            bucket: string
            namespace: string
            oboToken: string
            outputLocationType: string
            prefix: string
        streamSourceId: string
    

    StreamJob Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The StreamJob resource accepts the following input properties:

    CompartmentId string
    (Updatable) OCID of the compartment
    Features List<StreamJobFeature>
    (Updatable) a list of stream analysis features.
    StreamOutputLocation StreamJobStreamOutputLocation
    (Updatable) Details about a where results will be Sent
    StreamSourceId string
    (Updatable) OCID of streamSource.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    DisplayName string
    (Updatable) Stream job display name.
    FreeformTags Dictionary<string, string>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
    State string

    (Updatable) The target state for the Stream Job. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    (Updatable) OCID of the compartment
    Features []StreamJobFeatureArgs
    (Updatable) a list of stream analysis features.
    StreamOutputLocation StreamJobStreamOutputLocationArgs
    (Updatable) Details about a where results will be Sent
    StreamSourceId string
    (Updatable) OCID of streamSource.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    DisplayName string
    (Updatable) Stream job display name.
    FreeformTags map[string]string
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
    State string

    (Updatable) The target state for the Stream Job. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) OCID of the compartment
    features List<StreamJobFeature>
    (Updatable) a list of stream analysis features.
    streamOutputLocation StreamJobStreamOutputLocation
    (Updatable) Details about a where results will be Sent
    streamSourceId String
    (Updatable) OCID of streamSource.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    displayName String
    (Updatable) Stream job display name.
    freeformTags Map<String,String>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
    state String

    (Updatable) The target state for the Stream Job. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string
    (Updatable) OCID of the compartment
    features StreamJobFeature[]
    (Updatable) a list of stream analysis features.
    streamOutputLocation StreamJobStreamOutputLocation
    (Updatable) Details about a where results will be Sent
    streamSourceId string
    (Updatable) OCID of streamSource.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    displayName string
    (Updatable) Stream job display name.
    freeformTags {[key: string]: string}
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
    state string

    (Updatable) The target state for the Stream Job. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str
    (Updatable) OCID of the compartment
    features Sequence[StreamJobFeatureArgs]
    (Updatable) a list of stream analysis features.
    stream_output_location StreamJobStreamOutputLocationArgs
    (Updatable) Details about a where results will be Sent
    stream_source_id str
    (Updatable) OCID of streamSource.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    display_name str
    (Updatable) Stream job display name.
    freeform_tags Mapping[str, str]
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
    state str

    (Updatable) The target state for the Stream Job. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) OCID of the compartment
    features List<Property Map>
    (Updatable) a list of stream analysis features.
    streamOutputLocation Property Map
    (Updatable) Details about a where results will be Sent
    streamSourceId String
    (Updatable) OCID of streamSource.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    displayName String
    (Updatable) Stream job display name.
    freeformTags Map<String>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
    state String

    (Updatable) The target state for the Stream Job. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StreamJob resource produces the following output properties:

    AgentParticipantId string
    participant id of agent where results need to be sent
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Additional details about current state of streamJob
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    TimeCreated string
    When the streamJob was created, as an RFC3339 datetime string.
    TimeUpdated string
    When the stream job was updated, as an RFC3339 datetime string.
    AgentParticipantId string
    participant id of agent where results need to be sent
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Additional details about current state of streamJob
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    TimeCreated string
    When the streamJob was created, as an RFC3339 datetime string.
    TimeUpdated string
    When the stream job was updated, as an RFC3339 datetime string.
    agentParticipantId String
    participant id of agent where results need to be sent
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Additional details about current state of streamJob
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    timeCreated String
    When the streamJob was created, as an RFC3339 datetime string.
    timeUpdated String
    When the stream job was updated, as an RFC3339 datetime string.
    agentParticipantId string
    participant id of agent where results need to be sent
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    Additional details about current state of streamJob
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    timeCreated string
    When the streamJob was created, as an RFC3339 datetime string.
    timeUpdated string
    When the stream job was updated, as an RFC3339 datetime string.
    agent_participant_id str
    participant id of agent where results need to be sent
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    Additional details about current state of streamJob
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    time_created str
    When the streamJob was created, as an RFC3339 datetime string.
    time_updated str
    When the stream job was updated, as an RFC3339 datetime string.
    agentParticipantId String
    participant id of agent where results need to be sent
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Additional details about current state of streamJob
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    timeCreated String
    When the streamJob was created, as an RFC3339 datetime string.
    timeUpdated String
    When the stream job was updated, as an RFC3339 datetime string.

    Look up Existing StreamJob Resource

    Get an existing StreamJob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: StreamJobState, opts?: CustomResourceOptions): StreamJob
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            agent_participant_id: Optional[str] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, str]] = None,
            display_name: Optional[str] = None,
            features: Optional[Sequence[StreamJobFeatureArgs]] = None,
            freeform_tags: Optional[Mapping[str, str]] = None,
            lifecycle_details: Optional[str] = None,
            state: Optional[str] = None,
            stream_output_location: Optional[StreamJobStreamOutputLocationArgs] = None,
            stream_source_id: Optional[str] = None,
            system_tags: Optional[Mapping[str, str]] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None) -> StreamJob
    func GetStreamJob(ctx *Context, name string, id IDInput, state *StreamJobState, opts ...ResourceOption) (*StreamJob, error)
    public static StreamJob Get(string name, Input<string> id, StreamJobState? state, CustomResourceOptions? opts = null)
    public static StreamJob get(String name, Output<String> id, StreamJobState state, CustomResourceOptions options)
    resources:  _:    type: oci:AiVision:StreamJob    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AgentParticipantId string
    participant id of agent where results need to be sent
    CompartmentId string
    (Updatable) OCID of the compartment
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    DisplayName string
    (Updatable) Stream job display name.
    Features List<StreamJobFeature>
    (Updatable) a list of stream analysis features.
    FreeformTags Dictionary<string, string>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
    LifecycleDetails string
    Additional details about current state of streamJob
    State string

    (Updatable) The target state for the Stream Job. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    StreamOutputLocation StreamJobStreamOutputLocation
    (Updatable) Details about a where results will be Sent
    StreamSourceId string
    (Updatable) OCID of streamSource.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    TimeCreated string
    When the streamJob was created, as an RFC3339 datetime string.
    TimeUpdated string
    When the stream job was updated, as an RFC3339 datetime string.
    AgentParticipantId string
    participant id of agent where results need to be sent
    CompartmentId string
    (Updatable) OCID of the compartment
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    DisplayName string
    (Updatable) Stream job display name.
    Features []StreamJobFeatureArgs
    (Updatable) a list of stream analysis features.
    FreeformTags map[string]string
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
    LifecycleDetails string
    Additional details about current state of streamJob
    State string

    (Updatable) The target state for the Stream Job. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    StreamOutputLocation StreamJobStreamOutputLocationArgs
    (Updatable) Details about a where results will be Sent
    StreamSourceId string
    (Updatable) OCID of streamSource.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    TimeCreated string
    When the streamJob was created, as an RFC3339 datetime string.
    TimeUpdated string
    When the stream job was updated, as an RFC3339 datetime string.
    agentParticipantId String
    participant id of agent where results need to be sent
    compartmentId String
    (Updatable) OCID of the compartment
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    displayName String
    (Updatable) Stream job display name.
    features List<StreamJobFeature>
    (Updatable) a list of stream analysis features.
    freeformTags Map<String,String>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
    lifecycleDetails String
    Additional details about current state of streamJob
    state String

    (Updatable) The target state for the Stream Job. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    streamOutputLocation StreamJobStreamOutputLocation
    (Updatable) Details about a where results will be Sent
    streamSourceId String
    (Updatable) OCID of streamSource.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    timeCreated String
    When the streamJob was created, as an RFC3339 datetime string.
    timeUpdated String
    When the stream job was updated, as an RFC3339 datetime string.
    agentParticipantId string
    participant id of agent where results need to be sent
    compartmentId string
    (Updatable) OCID of the compartment
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    displayName string
    (Updatable) Stream job display name.
    features StreamJobFeature[]
    (Updatable) a list of stream analysis features.
    freeformTags {[key: string]: string}
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
    lifecycleDetails string
    Additional details about current state of streamJob
    state string

    (Updatable) The target state for the Stream Job. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    streamOutputLocation StreamJobStreamOutputLocation
    (Updatable) Details about a where results will be Sent
    streamSourceId string
    (Updatable) OCID of streamSource.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    timeCreated string
    When the streamJob was created, as an RFC3339 datetime string.
    timeUpdated string
    When the stream job was updated, as an RFC3339 datetime string.
    agent_participant_id str
    participant id of agent where results need to be sent
    compartment_id str
    (Updatable) OCID of the compartment
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    display_name str
    (Updatable) Stream job display name.
    features Sequence[StreamJobFeatureArgs]
    (Updatable) a list of stream analysis features.
    freeform_tags Mapping[str, str]
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
    lifecycle_details str
    Additional details about current state of streamJob
    state str

    (Updatable) The target state for the Stream Job. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    stream_output_location StreamJobStreamOutputLocationArgs
    (Updatable) Details about a where results will be Sent
    stream_source_id str
    (Updatable) OCID of streamSource.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    time_created str
    When the streamJob was created, as an RFC3339 datetime string.
    time_updated str
    When the stream job was updated, as an RFC3339 datetime string.
    agentParticipantId String
    participant id of agent where results need to be sent
    compartmentId String
    (Updatable) OCID of the compartment
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    displayName String
    (Updatable) Stream job display name.
    features List<Property Map>
    (Updatable) a list of stream analysis features.
    freeformTags Map<String>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
    lifecycleDetails String
    Additional details about current state of streamJob
    state String

    (Updatable) The target state for the Stream Job. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    streamOutputLocation Property Map
    (Updatable) Details about a where results will be Sent
    streamSourceId String
    (Updatable) OCID of streamSource.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    timeCreated String
    When the streamJob was created, as an RFC3339 datetime string.
    timeUpdated String
    When the stream job was updated, as an RFC3339 datetime string.

    Supporting Types

    StreamJobFeature, StreamJobFeatureArgs

    FeatureType string
    (Updatable) The feature of video analysis. Allowed values are:

    • OBJECT_TRACKING: Object tracking feature(OT).
    • FACE_DETECTION: Face detection feature(FD).
    MaxResults int
    (Updatable) The maximum number of results to return.
    ShouldReturnLandmarks bool
    (Updatable) Whether or not return face landmarks.
    TrackingTypes List<StreamJobFeatureTrackingType>
    (Updatable) List of details of what to track.
    FeatureType string
    (Updatable) The feature of video analysis. Allowed values are:

    • OBJECT_TRACKING: Object tracking feature(OT).
    • FACE_DETECTION: Face detection feature(FD).
    MaxResults int
    (Updatable) The maximum number of results to return.
    ShouldReturnLandmarks bool
    (Updatable) Whether or not return face landmarks.
    TrackingTypes []StreamJobFeatureTrackingType
    (Updatable) List of details of what to track.
    featureType String
    (Updatable) The feature of video analysis. Allowed values are:

    • OBJECT_TRACKING: Object tracking feature(OT).
    • FACE_DETECTION: Face detection feature(FD).
    maxResults Integer
    (Updatable) The maximum number of results to return.
    shouldReturnLandmarks Boolean
    (Updatable) Whether or not return face landmarks.
    trackingTypes List<StreamJobFeatureTrackingType>
    (Updatable) List of details of what to track.
    featureType string
    (Updatable) The feature of video analysis. Allowed values are:

    • OBJECT_TRACKING: Object tracking feature(OT).
    • FACE_DETECTION: Face detection feature(FD).
    maxResults number
    (Updatable) The maximum number of results to return.
    shouldReturnLandmarks boolean
    (Updatable) Whether or not return face landmarks.
    trackingTypes StreamJobFeatureTrackingType[]
    (Updatable) List of details of what to track.
    feature_type str
    (Updatable) The feature of video analysis. Allowed values are:

    • OBJECT_TRACKING: Object tracking feature(OT).
    • FACE_DETECTION: Face detection feature(FD).
    max_results int
    (Updatable) The maximum number of results to return.
    should_return_landmarks bool
    (Updatable) Whether or not return face landmarks.
    tracking_types Sequence[StreamJobFeatureTrackingType]
    (Updatable) List of details of what to track.
    featureType String
    (Updatable) The feature of video analysis. Allowed values are:

    • OBJECT_TRACKING: Object tracking feature(OT).
    • FACE_DETECTION: Face detection feature(FD).
    maxResults Number
    (Updatable) The maximum number of results to return.
    shouldReturnLandmarks Boolean
    (Updatable) Whether or not return face landmarks.
    trackingTypes List<Property Map>
    (Updatable) List of details of what to track.

    StreamJobFeatureTrackingType, StreamJobFeatureTrackingTypeArgs

    BiometricStoreCompartmentId string
    (Updatable) compartment Id of biometric compartment.
    BiometricStoreId string
    (Updatable) Which biometric store user wants to do face recognition
    DetectionModelId string
    (Updatable) The detection model OCID.
    MaxResults int
    (Updatable) The maximum number of results to return.
    Objects List<string>
    (Updatable) List of the objects to be tracked.
    ShouldReturnLandmarks bool
    (Updatable) Whether or not return face landmarks.
    TrackingModelId string
    (Updatable) The tracking model OCID.
    BiometricStoreCompartmentId string
    (Updatable) compartment Id of biometric compartment.
    BiometricStoreId string
    (Updatable) Which biometric store user wants to do face recognition
    DetectionModelId string
    (Updatable) The detection model OCID.
    MaxResults int
    (Updatable) The maximum number of results to return.
    Objects []string
    (Updatable) List of the objects to be tracked.
    ShouldReturnLandmarks bool
    (Updatable) Whether or not return face landmarks.
    TrackingModelId string
    (Updatable) The tracking model OCID.
    biometricStoreCompartmentId String
    (Updatable) compartment Id of biometric compartment.
    biometricStoreId String
    (Updatable) Which biometric store user wants to do face recognition
    detectionModelId String
    (Updatable) The detection model OCID.
    maxResults Integer
    (Updatable) The maximum number of results to return.
    objects List<String>
    (Updatable) List of the objects to be tracked.
    shouldReturnLandmarks Boolean
    (Updatable) Whether or not return face landmarks.
    trackingModelId String
    (Updatable) The tracking model OCID.
    biometricStoreCompartmentId string
    (Updatable) compartment Id of biometric compartment.
    biometricStoreId string
    (Updatable) Which biometric store user wants to do face recognition
    detectionModelId string
    (Updatable) The detection model OCID.
    maxResults number
    (Updatable) The maximum number of results to return.
    objects string[]
    (Updatable) List of the objects to be tracked.
    shouldReturnLandmarks boolean
    (Updatable) Whether or not return face landmarks.
    trackingModelId string
    (Updatable) The tracking model OCID.
    biometric_store_compartment_id str
    (Updatable) compartment Id of biometric compartment.
    biometric_store_id str
    (Updatable) Which biometric store user wants to do face recognition
    detection_model_id str
    (Updatable) The detection model OCID.
    max_results int
    (Updatable) The maximum number of results to return.
    objects Sequence[str]
    (Updatable) List of the objects to be tracked.
    should_return_landmarks bool
    (Updatable) Whether or not return face landmarks.
    tracking_model_id str
    (Updatable) The tracking model OCID.
    biometricStoreCompartmentId String
    (Updatable) compartment Id of biometric compartment.
    biometricStoreId String
    (Updatable) Which biometric store user wants to do face recognition
    detectionModelId String
    (Updatable) The detection model OCID.
    maxResults Number
    (Updatable) The maximum number of results to return.
    objects List<String>
    (Updatable) List of the objects to be tracked.
    shouldReturnLandmarks Boolean
    (Updatable) Whether or not return face landmarks.
    trackingModelId String
    (Updatable) The tracking model OCID.

    StreamJobStreamOutputLocation, StreamJobStreamOutputLocationArgs

    Bucket string
    (Updatable) The Object Storage bucket name.
    Namespace string
    (Updatable) The Object Storage namespace.
    OutputLocationType string
    (Updatable) Type of device Allowed values are:

    • OBJECT_STORAGE
    • LIVEKIT_WEBRTC_AGENT
    Prefix string
    (Updatable) The Object Storage folder name.
    OboToken string
    (Updatable) Object storage output location
    Bucket string
    (Updatable) The Object Storage bucket name.
    Namespace string
    (Updatable) The Object Storage namespace.
    OutputLocationType string
    (Updatable) Type of device Allowed values are:

    • OBJECT_STORAGE
    • LIVEKIT_WEBRTC_AGENT
    Prefix string
    (Updatable) The Object Storage folder name.
    OboToken string
    (Updatable) Object storage output location
    bucket String
    (Updatable) The Object Storage bucket name.
    namespace String
    (Updatable) The Object Storage namespace.
    outputLocationType String
    (Updatable) Type of device Allowed values are:

    • OBJECT_STORAGE
    • LIVEKIT_WEBRTC_AGENT
    prefix String
    (Updatable) The Object Storage folder name.
    oboToken String
    (Updatable) Object storage output location
    bucket string
    (Updatable) The Object Storage bucket name.
    namespace string
    (Updatable) The Object Storage namespace.
    outputLocationType string
    (Updatable) Type of device Allowed values are:

    • OBJECT_STORAGE
    • LIVEKIT_WEBRTC_AGENT
    prefix string
    (Updatable) The Object Storage folder name.
    oboToken string
    (Updatable) Object storage output location
    bucket str
    (Updatable) The Object Storage bucket name.
    namespace str
    (Updatable) The Object Storage namespace.
    output_location_type str
    (Updatable) Type of device Allowed values are:

    • OBJECT_STORAGE
    • LIVEKIT_WEBRTC_AGENT
    prefix str
    (Updatable) The Object Storage folder name.
    obo_token str
    (Updatable) Object storage output location
    bucket String
    (Updatable) The Object Storage bucket name.
    namespace String
    (Updatable) The Object Storage namespace.
    outputLocationType String
    (Updatable) Type of device Allowed values are:

    • OBJECT_STORAGE
    • LIVEKIT_WEBRTC_AGENT
    prefix String
    (Updatable) The Object Storage folder name.
    oboToken String
    (Updatable) Object storage output location

    Import

    StreamJobs can be imported using the id, e.g.

    $ pulumi import oci:AiVision/streamJob:StreamJob test_stream_job "id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi