Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.DataScience.getModels

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testModels = oci.DataScience.getModels({
    compartmentId: compartmentId,
    category: modelCategory,
    createdBy: modelCreatedBy,
    displayName: modelDisplayName,
    id: modelId,
    modelVersionSetName: testModelVersionSet.name,
    projectId: testProject.id,
    state: modelState,
});

import pulumi
import pulumi_oci as oci

test_models = oci.DataScience.get_models(compartment_id=compartment_id,
    category=model_category,
    created_by=model_created_by,
    display_name=model_display_name,
    id=model_id,
    model_version_set_name=test_model_version_set["name"],
    project_id=test_project["id"],
    state=model_state)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/datascience"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datascience.GetModels(ctx, &datascience.GetModelsArgs{
			CompartmentId:       compartmentId,
			Category:            pulumi.StringRef(modelCategory),
			CreatedBy:           pulumi.StringRef(modelCreatedBy),
			DisplayName:         pulumi.StringRef(modelDisplayName),
			Id:                  pulumi.StringRef(modelId),
			ModelVersionSetName: pulumi.StringRef(testModelVersionSet.Name),
			ProjectId:           pulumi.StringRef(testProject.Id),
			State:               pulumi.StringRef(modelState),
		}, nil)
		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 testModels = Oci.DataScience.GetModels.Invoke(new()
    {
        CompartmentId = compartmentId,
        Category = modelCategory,
        CreatedBy = modelCreatedBy,
        DisplayName = modelDisplayName,
        Id = modelId,
        ModelVersionSetName = testModelVersionSet.Name,
        ProjectId = testProject.Id,
        State = modelState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataScience.DataScienceFunctions;
import com.pulumi.oci.DataScience.inputs.GetModelsArgs;
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) {
        final var testModels = DataScienceFunctions.getModels(GetModelsArgs.builder()
            .compartmentId(compartmentId)
            .category(modelCategory)
            .createdBy(modelCreatedBy)
            .displayName(modelDisplayName)
            .id(modelId)
            .modelVersionSetName(testModelVersionSet.name())
            .projectId(testProject.id())
            .state(modelState)
            .build());

    }
}

variables:
  testModels:
    fn::invoke:
      function: oci:DataScience:getModels
      arguments:
        compartmentId: ${compartmentId}
        category: ${modelCategory}
        createdBy: ${modelCreatedBy}
        displayName: ${modelDisplayName}
        id: ${modelId}
        modelVersionSetName: ${testModelVersionSet.name}
        projectId: ${testProject.id}
        state: ${modelState}

Using getModels

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getModels(args: GetModelsArgs, opts?: InvokeOptions): Promise<GetModelsResult>
function getModelsOutput(args: GetModelsOutputArgs, opts?: InvokeOptions): Output<GetModelsResult>

def get_models(category: Optional[str] = None,
               compartment_id: Optional[str] = None,
               created_by: Optional[str] = None,
               display_name: Optional[str] = None,
               filters: Optional[Sequence[_datascience.GetModelsFilter]] = None,
               id: Optional[str] = None,
               model_version_set_id: Optional[str] = None,
               model_version_set_name: Optional[str] = None,
               project_id: Optional[str] = None,
               state: Optional[str] = None,
               version_label: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetModelsResult
def get_models_output(category: Optional[pulumi.Input[str]] = None,
               compartment_id: Optional[pulumi.Input[str]] = None,
               created_by: Optional[pulumi.Input[str]] = None,
               display_name: Optional[pulumi.Input[str]] = None,
               filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datascience.GetModelsFilterArgs]]]] = None,
               id: Optional[pulumi.Input[str]] = None,
               model_version_set_id: Optional[pulumi.Input[str]] = None,
               model_version_set_name: Optional[pulumi.Input[str]] = None,
               project_id: Optional[pulumi.Input[str]] = None,
               state: Optional[pulumi.Input[str]] = None,
               version_label: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetModelsResult]

func GetModels(ctx *Context, args *GetModelsArgs, opts ...InvokeOption) (*GetModelsResult, error)
func GetModelsOutput(ctx *Context, args *GetModelsOutputArgs, opts ...InvokeOption) GetModelsResultOutput

> Note: This function is named GetModels in the Go SDK.

public static class GetModels 
{
    public static Task<GetModelsResult> InvokeAsync(GetModelsArgs args, InvokeOptions? opts = null)
    public static Output<GetModelsResult> Invoke(GetModelsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetModelsResult> getModels(GetModelsArgs args, InvokeOptions options)
public static Output<GetModelsResult> getModels(GetModelsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:DataScience/getModels:getModels
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: Filter results by the OCID of the compartment.
Category string: Specifies the type of models to list. By default, user models are listed.
CreatedBy string: Filter results by the OCID of the user who created the resource.
DisplayName string: Filter results by its user-friendly name.
Filters List<GetModelsFilter>
Id string: Filter results by OCID. Must be an OCID of the correct type for the resource type.
ModelVersionSetId string: The OCID of the model version set that the model is associated to.
ModelVersionSetName string: The name of the model version set that the model is associated to.
ProjectId string: Filter results by the OCID of the project.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
VersionLabel string

CompartmentId string: Filter results by the OCID of the compartment.
Category string: Specifies the type of models to list. By default, user models are listed.
CreatedBy string: Filter results by the OCID of the user who created the resource.
DisplayName string: Filter results by its user-friendly name.
Filters []GetModelsFilter
Id string: Filter results by OCID. Must be an OCID of the correct type for the resource type.
ModelVersionSetId string: The OCID of the model version set that the model is associated to.
ModelVersionSetName string: The name of the model version set that the model is associated to.
ProjectId string: Filter results by the OCID of the project.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
VersionLabel string

compartmentId String: Filter results by the OCID of the compartment.
category String: Specifies the type of models to list. By default, user models are listed.
createdBy String: Filter results by the OCID of the user who created the resource.
displayName String: Filter results by its user-friendly name.
filters List<GetModelsFilter>
id String: Filter results by OCID. Must be an OCID of the correct type for the resource type.
modelVersionSetId String: The OCID of the model version set that the model is associated to.
modelVersionSetName String: The name of the model version set that the model is associated to.
projectId String: Filter results by the OCID of the project.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
versionLabel String

compartmentId string: Filter results by the OCID of the compartment.
category string: Specifies the type of models to list. By default, user models are listed.
createdBy string: Filter results by the OCID of the user who created the resource.
displayName string: Filter results by its user-friendly name.
filters GetModelsFilter[]
id string: Filter results by OCID. Must be an OCID of the correct type for the resource type.
modelVersionSetId string: The OCID of the model version set that the model is associated to.
modelVersionSetName string: The name of the model version set that the model is associated to.
projectId string: Filter results by the OCID of the project.
state string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
versionLabel string

compartment_id str: Filter results by the OCID of the compartment.
category str: Specifies the type of models to list. By default, user models are listed.
created_by str: Filter results by the OCID of the user who created the resource.
display_name str: Filter results by its user-friendly name.
filters Sequence[datascience.GetModelsFilter]
id str: Filter results by OCID. Must be an OCID of the correct type for the resource type.
model_version_set_id str: The OCID of the model version set that the model is associated to.
model_version_set_name str: The name of the model version set that the model is associated to.
project_id str: Filter results by the OCID of the project.
state str: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
version_label str

compartmentId String: Filter results by the OCID of the compartment.
category String: Specifies the type of models to list. By default, user models are listed.
createdBy String: Filter results by the OCID of the user who created the resource.
displayName String: Filter results by its user-friendly name.
filters List<Property Map>
id String: Filter results by OCID. Must be an OCID of the correct type for the resource type.
modelVersionSetId String: The OCID of the model version set that the model is associated to.
modelVersionSetName String: The name of the model version set that the model is associated to.
projectId String: Filter results by the OCID of the project.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
versionLabel String

getModels Result

The following output properties are available:

CompartmentId string: The OCID of the model's compartment.
Models List<GetModelsModel>: The list of models.
Category string: Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,Reports,Readme,other".
CreatedBy string: The OCID of the user who created the model.
DisplayName string: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
Filters List<GetModelsFilter>
Id string: The OCID of the model.
ModelVersionSetId string: The OCID of the model version set that the model is associated to.
ModelVersionSetName string: The name of the model version set that the model is associated to.
ProjectId string: The OCID of the project associated with the model.
State string: The state of the model.
VersionLabel string

CompartmentId string: The OCID of the model's compartment.
Models []GetModelsModel: The list of models.
Category string: Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,Reports,Readme,other".
CreatedBy string: The OCID of the user who created the model.
DisplayName string: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
Filters []GetModelsFilter
Id string: The OCID of the model.
ModelVersionSetId string: The OCID of the model version set that the model is associated to.
ModelVersionSetName string: The name of the model version set that the model is associated to.
ProjectId string: The OCID of the project associated with the model.
State string: The state of the model.
VersionLabel string

compartmentId String: The OCID of the model's compartment.
models List<GetModelsModel>: The list of models.
category String: Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,Reports,Readme,other".
createdBy String: The OCID of the user who created the model.
displayName String: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
filters List<GetModelsFilter>
id String: The OCID of the model.
modelVersionSetId String: The OCID of the model version set that the model is associated to.
modelVersionSetName String: The name of the model version set that the model is associated to.
projectId String: The OCID of the project associated with the model.
state String: The state of the model.
versionLabel String

compartmentId string: The OCID of the model's compartment.
models GetModelsModel[]: The list of models.
category string: Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,Reports,Readme,other".
createdBy string: The OCID of the user who created the model.
displayName string: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
filters GetModelsFilter[]
id string: The OCID of the model.
modelVersionSetId string: The OCID of the model version set that the model is associated to.
modelVersionSetName string: The name of the model version set that the model is associated to.
projectId string: The OCID of the project associated with the model.
state string: The state of the model.
versionLabel string

compartment_id str: The OCID of the model's compartment.
models Sequence[datascience.GetModelsModel]: The list of models.
category str: Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,Reports,Readme,other".
created_by str: The OCID of the user who created the model.
display_name str: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
filters Sequence[datascience.GetModelsFilter]
id str: The OCID of the model.
model_version_set_id str: The OCID of the model version set that the model is associated to.
model_version_set_name str: The name of the model version set that the model is associated to.
project_id str: The OCID of the project associated with the model.
state str: The state of the model.
version_label str

compartmentId String: The OCID of the model's compartment.
models List<Property Map>: The list of models.
category String: Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,Reports,Readme,other".
createdBy String: The OCID of the user who created the model.
displayName String: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
filters List<Property Map>
id String: The OCID of the model.
modelVersionSetId String: The OCID of the model version set that the model is associated to.
modelVersionSetName String: The name of the model version set that the model is associated to.
projectId String: The OCID of the project associated with the model.
state String: The state of the model.
versionLabel String

Supporting Types

GetModelsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

GetModelsModel

ArtifactContentDisposition string
ArtifactContentLength string
ArtifactContentMd5 string
ArtifactLastModified string
BackupOperationDetails List<GetModelsModelBackupOperationDetail>: Backup operation details of the model.
BackupSettings List<GetModelsModelBackupSetting>: Back up setting details of the model.
Category string: Specifies the type of models to list. By default, user models are listed.
CompartmentId string: Filter results by the OCID of the compartment.
CreatedBy string: Filter results by the OCID of the user who created the resource.
CustomMetadataLists List<GetModelsModelCustomMetadataList>: An array of custom metadata details for the model.
DefinedMetadataLists List<GetModelsModelDefinedMetadataList>: An array of defined metadata details for the model.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: A short description of the model.
DisplayName string: Filter results by its user-friendly name.
EmptyModel bool
FreeformTags Dictionary<string, string>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
Id string: Filter results by OCID. Must be an OCID of the correct type for the resource type.
InputSchema string: Input schema file content in String format
IsModelByReference bool: Identifier to indicate whether a model artifact resides in the Service Tenancy or Customer Tenancy.
LifecycleDetails string: Details about the lifecycle state of the model.
ModelArtifact string
ModelVersionSetId string: The OCID of the model version set that the model is associated to.
ModelVersionSetName string: The name of the model version set that the model is associated to.
OutputSchema string: Output schema file content in String format
ProjectId string: Filter results by the OCID of the project.
RetentionOperationDetails List<GetModelsModelRetentionOperationDetail>: Retention operation details for the model.
RetentionSettings List<GetModelsModelRetentionSetting>: Retention setting details of the model.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
TimeCreated string: The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z
VersionLabel string

ArtifactContentDisposition string
ArtifactContentLength string
ArtifactContentMd5 string
ArtifactLastModified string
BackupOperationDetails []GetModelsModelBackupOperationDetail: Backup operation details of the model.
BackupSettings []GetModelsModelBackupSetting: Back up setting details of the model.
Category string: Specifies the type of models to list. By default, user models are listed.
CompartmentId string: Filter results by the OCID of the compartment.
CreatedBy string: Filter results by the OCID of the user who created the resource.
CustomMetadataLists []GetModelsModelCustomMetadataList: An array of custom metadata details for the model.
DefinedMetadataLists []GetModelsModelDefinedMetadataList: An array of defined metadata details for the model.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: A short description of the model.
DisplayName string: Filter results by its user-friendly name.
EmptyModel bool
FreeformTags map[string]string: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
Id string: Filter results by OCID. Must be an OCID of the correct type for the resource type.
InputSchema string: Input schema file content in String format
IsModelByReference bool: Identifier to indicate whether a model artifact resides in the Service Tenancy or Customer Tenancy.
LifecycleDetails string: Details about the lifecycle state of the model.
ModelArtifact string
ModelVersionSetId string: The OCID of the model version set that the model is associated to.
ModelVersionSetName string: The name of the model version set that the model is associated to.
OutputSchema string: Output schema file content in String format
ProjectId string: Filter results by the OCID of the project.
RetentionOperationDetails []GetModelsModelRetentionOperationDetail: Retention operation details for the model.
RetentionSettings []GetModelsModelRetentionSetting: Retention setting details of the model.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
TimeCreated string: The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z
VersionLabel string

artifactContentDisposition String
artifactContentLength String
artifactContentMd5 String
artifactLastModified String
backupOperationDetails List<GetModelsModelBackupOperationDetail>: Backup operation details of the model.
backupSettings List<GetModelsModelBackupSetting>: Back up setting details of the model.
category String: Specifies the type of models to list. By default, user models are listed.
compartmentId String: Filter results by the OCID of the compartment.
createdBy String: Filter results by the OCID of the user who created the resource.
customMetadataLists List<GetModelsModelCustomMetadataList>: An array of custom metadata details for the model.
definedMetadataLists List<GetModelsModelDefinedMetadataList>: An array of defined metadata details for the model.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: A short description of the model.
displayName String: Filter results by its user-friendly name.
emptyModel Boolean
freeformTags Map<String,String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
id String: Filter results by OCID. Must be an OCID of the correct type for the resource type.
inputSchema String: Input schema file content in String format
isModelByReference Boolean: Identifier to indicate whether a model artifact resides in the Service Tenancy or Customer Tenancy.
lifecycleDetails String: Details about the lifecycle state of the model.
modelArtifact String
modelVersionSetId String: The OCID of the model version set that the model is associated to.
modelVersionSetName String: The name of the model version set that the model is associated to.
outputSchema String: Output schema file content in String format
projectId String: Filter results by the OCID of the project.
retentionOperationDetails List<GetModelsModelRetentionOperationDetail>: Retention operation details for the model.
retentionSettings List<GetModelsModelRetentionSetting>: Retention setting details of the model.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
timeCreated String: The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z
versionLabel String

artifactContentDisposition string
artifactContentLength string
artifactContentMd5 string
artifactLastModified string
backupOperationDetails GetModelsModelBackupOperationDetail[]: Backup operation details of the model.
backupSettings GetModelsModelBackupSetting[]: Back up setting details of the model.
category string: Specifies the type of models to list. By default, user models are listed.
compartmentId string: Filter results by the OCID of the compartment.
createdBy string: Filter results by the OCID of the user who created the resource.
customMetadataLists GetModelsModelCustomMetadataList[]: An array of custom metadata details for the model.
definedMetadataLists GetModelsModelDefinedMetadataList[]: An array of defined metadata details for the model.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
description string: A short description of the model.
displayName string: Filter results by its user-friendly name.
emptyModel boolean
freeformTags {[key: string]: string}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
id string: Filter results by OCID. Must be an OCID of the correct type for the resource type.
inputSchema string: Input schema file content in String format
isModelByReference boolean: Identifier to indicate whether a model artifact resides in the Service Tenancy or Customer Tenancy.
lifecycleDetails string: Details about the lifecycle state of the model.
modelArtifact string
modelVersionSetId string: The OCID of the model version set that the model is associated to.
modelVersionSetName string: The name of the model version set that the model is associated to.
outputSchema string: Output schema file content in String format
projectId string: Filter results by the OCID of the project.
retentionOperationDetails GetModelsModelRetentionOperationDetail[]: Retention operation details for the model.
retentionSettings GetModelsModelRetentionSetting[]: Retention setting details of the model.
state string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
timeCreated string: The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z
versionLabel string

artifact_content_disposition str
artifact_content_length str
artifact_content_md5 str
artifact_last_modified str
backup_operation_details Sequence[datascience.GetModelsModelBackupOperationDetail]: Backup operation details of the model.
backup_settings Sequence[datascience.GetModelsModelBackupSetting]: Back up setting details of the model.
category str: Specifies the type of models to list. By default, user models are listed.
compartment_id str: Filter results by the OCID of the compartment.
created_by str: Filter results by the OCID of the user who created the resource.
custom_metadata_lists Sequence[datascience.GetModelsModelCustomMetadataList]: An array of custom metadata details for the model.
defined_metadata_lists Sequence[datascience.GetModelsModelDefinedMetadataList]: An array of defined metadata details for the model.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
description str: A short description of the model.
display_name str: Filter results by its user-friendly name.
empty_model bool
freeform_tags Mapping[str, str]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
id str: Filter results by OCID. Must be an OCID of the correct type for the resource type.
input_schema str: Input schema file content in String format
is_model_by_reference bool: Identifier to indicate whether a model artifact resides in the Service Tenancy or Customer Tenancy.
lifecycle_details str: Details about the lifecycle state of the model.
model_artifact str
model_version_set_id str: The OCID of the model version set that the model is associated to.
model_version_set_name str: The name of the model version set that the model is associated to.
output_schema str: Output schema file content in String format
project_id str: Filter results by the OCID of the project.
retention_operation_details Sequence[datascience.GetModelsModelRetentionOperationDetail]: Retention operation details for the model.
retention_settings Sequence[datascience.GetModelsModelRetentionSetting]: Retention setting details of the model.
state str: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
time_created str: The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z
version_label str

artifactContentDisposition String
artifactContentLength String
artifactContentMd5 String
artifactLastModified String
backupOperationDetails List<Property Map>: Backup operation details of the model.
backupSettings List<Property Map>: Back up setting details of the model.
category String: Specifies the type of models to list. By default, user models are listed.
compartmentId String: Filter results by the OCID of the compartment.
createdBy String: Filter results by the OCID of the user who created the resource.
customMetadataLists List<Property Map>: An array of custom metadata details for the model.
definedMetadataLists List<Property Map>: An array of defined metadata details for the model.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: A short description of the model.
displayName String: Filter results by its user-friendly name.
emptyModel Boolean
freeformTags Map<String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
id String: Filter results by OCID. Must be an OCID of the correct type for the resource type.
inputSchema String: Input schema file content in String format
isModelByReference Boolean: Identifier to indicate whether a model artifact resides in the Service Tenancy or Customer Tenancy.
lifecycleDetails String: Details about the lifecycle state of the model.
modelArtifact String
modelVersionSetId String: The OCID of the model version set that the model is associated to.
modelVersionSetName String: The name of the model version set that the model is associated to.
outputSchema String: Output schema file content in String format
projectId String: Filter results by the OCID of the project.
retentionOperationDetails List<Property Map>: Retention operation details for the model.
retentionSettings List<Property Map>: Retention setting details of the model.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
timeCreated String: The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z
versionLabel String

GetModelsModelBackupOperationDetail

BackupState string: The backup status of the model.
BackupStateDetails string: The backup execution status details of the model.
TimeLastBackup string: The last backup execution time of the model.

BackupState string: The backup status of the model.
BackupStateDetails string: The backup execution status details of the model.
TimeLastBackup string: The last backup execution time of the model.

backupState String: The backup status of the model.
backupStateDetails String: The backup execution status details of the model.
timeLastBackup String: The last backup execution time of the model.

backupState string: The backup status of the model.
backupStateDetails string: The backup execution status details of the model.
timeLastBackup string: The last backup execution time of the model.

backup_state str: The backup status of the model.
backup_state_details str: The backup execution status details of the model.
time_last_backup str: The last backup execution time of the model.

backupState String: The backup status of the model.
backupStateDetails String: The backup execution status details of the model.
timeLastBackup String: The last backup execution time of the model.

GetModelsModelBackupSetting

BackupRegion string: Oracle Cloud Infrastructure backup region for the model.
CustomerNotificationType string: Customer notification options on success/failure of archival, deletion events.
IsBackupEnabled bool: Boolean flag representing whether backup needs to be enabled/disabled for the model.

BackupRegion string: Oracle Cloud Infrastructure backup region for the model.
CustomerNotificationType string: Customer notification options on success/failure of archival, deletion events.
IsBackupEnabled bool: Boolean flag representing whether backup needs to be enabled/disabled for the model.

backupRegion String: Oracle Cloud Infrastructure backup region for the model.
customerNotificationType String: Customer notification options on success/failure of archival, deletion events.
isBackupEnabled Boolean: Boolean flag representing whether backup needs to be enabled/disabled for the model.

backupRegion string: Oracle Cloud Infrastructure backup region for the model.
customerNotificationType string: Customer notification options on success/failure of archival, deletion events.
isBackupEnabled boolean: Boolean flag representing whether backup needs to be enabled/disabled for the model.

backup_region str: Oracle Cloud Infrastructure backup region for the model.
customer_notification_type str: Customer notification options on success/failure of archival, deletion events.
is_backup_enabled bool: Boolean flag representing whether backup needs to be enabled/disabled for the model.

backupRegion String: Oracle Cloud Infrastructure backup region for the model.
customerNotificationType String: Customer notification options on success/failure of archival, deletion events.
isBackupEnabled Boolean: Boolean flag representing whether backup needs to be enabled/disabled for the model.

GetModelsModelCustomMetadataList

Category string

Specifies the type of models to list. By default, user models are listed.

Description string

A short description of the model.

HasArtifact bool

Is there any artifact present for the metadata.

Key string

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

useCaseType
libraryName
libraryVersion
estimatorClass
hyperParameters
testArtifactresults
fineTuningConfiguration
deploymentConfiguration
readme
license
evaluationConfiguration

Keywords List<string>

list of keywords for searching

Value string

Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other

Category string

Specifies the type of models to list. By default, user models are listed.

Description string

A short description of the model.

HasArtifact bool

Is there any artifact present for the metadata.

Key string

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

useCaseType
libraryName
libraryVersion
estimatorClass
hyperParameters
testArtifactresults
fineTuningConfiguration
deploymentConfiguration
readme
license
evaluationConfiguration

Keywords []string

list of keywords for searching

Value string

category String

Specifies the type of models to list. By default, user models are listed.

description String

A short description of the model.

hasArtifact Boolean

Is there any artifact present for the metadata.

key String

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

useCaseType
libraryName
libraryVersion
estimatorClass
hyperParameters
testArtifactresults
fineTuningConfiguration
deploymentConfiguration
readme
license
evaluationConfiguration

keywords List<String>

list of keywords for searching

value String

category string

Specifies the type of models to list. By default, user models are listed.

description string

A short description of the model.

hasArtifact boolean

Is there any artifact present for the metadata.

key string

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

useCaseType
libraryName
libraryVersion
estimatorClass
hyperParameters
testArtifactresults
fineTuningConfiguration
deploymentConfiguration
readme
license
evaluationConfiguration

keywords string[]

list of keywords for searching

value string

category str

Specifies the type of models to list. By default, user models are listed.

description str

A short description of the model.

has_artifact bool

Is there any artifact present for the metadata.

key str

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

useCaseType
libraryName
libraryVersion
estimatorClass
hyperParameters
testArtifactresults
fineTuningConfiguration
deploymentConfiguration
readme
license
evaluationConfiguration

keywords Sequence[str]

list of keywords for searching

value str

category String

Specifies the type of models to list. By default, user models are listed.

description String

A short description of the model.

hasArtifact Boolean

Is there any artifact present for the metadata.

key String

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

useCaseType
libraryName
libraryVersion
estimatorClass
hyperParameters
testArtifactresults
fineTuningConfiguration
deploymentConfiguration
readme
license
evaluationConfiguration

keywords List<String>

list of keywords for searching

value String

GetModelsModelDefinedMetadataList

Category string

Specifies the type of models to list. By default, user models are listed.

Description string

A short description of the model.

HasArtifact bool

Is there any artifact present for the metadata.

Key string

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

useCaseType
libraryName
libraryVersion
estimatorClass
hyperParameters
testArtifactresults
fineTuningConfiguration
deploymentConfiguration
readme
license
evaluationConfiguration

Keywords List<string>

list of keywords for searching

Value string

Category string

Specifies the type of models to list. By default, user models are listed.

Description string

A short description of the model.

HasArtifact bool

Is there any artifact present for the metadata.

Key string

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

useCaseType
libraryName
libraryVersion
estimatorClass
hyperParameters
testArtifactresults
fineTuningConfiguration
deploymentConfiguration
readme
license
evaluationConfiguration

Keywords []string

list of keywords for searching

Value string

category String

Specifies the type of models to list. By default, user models are listed.

description String

A short description of the model.

hasArtifact Boolean

Is there any artifact present for the metadata.

key String

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

useCaseType
libraryName
libraryVersion
estimatorClass
hyperParameters
testArtifactresults
fineTuningConfiguration
deploymentConfiguration
readme
license
evaluationConfiguration

keywords List<String>

list of keywords for searching

value String

category string

Specifies the type of models to list. By default, user models are listed.

description string

A short description of the model.

hasArtifact boolean

Is there any artifact present for the metadata.

key string

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

useCaseType
libraryName
libraryVersion
estimatorClass
hyperParameters
testArtifactresults
fineTuningConfiguration
deploymentConfiguration
readme
license
evaluationConfiguration

keywords string[]

list of keywords for searching

value string

category str

Specifies the type of models to list. By default, user models are listed.

description str

A short description of the model.

has_artifact bool

Is there any artifact present for the metadata.

key str

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

useCaseType
libraryName
libraryVersion
estimatorClass
hyperParameters
testArtifactresults
fineTuningConfiguration
deploymentConfiguration
readme
license
evaluationConfiguration

keywords Sequence[str]

list of keywords for searching

value str

category String

Specifies the type of models to list. By default, user models are listed.

description String

A short description of the model.

hasArtifact Boolean

Is there any artifact present for the metadata.

key String

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

useCaseType
libraryName
libraryVersion
estimatorClass
hyperParameters
testArtifactresults
fineTuningConfiguration
deploymentConfiguration
readme
license
evaluationConfiguration

keywords List<String>

list of keywords for searching

value String

GetModelsModelRetentionOperationDetail

ArchiveState string: The archival status of model.
ArchiveStateDetails string: The archival state details of the model.
DeleteState string: The deletion status of the archived model.
DeleteStateDetails string: The deletion status details of the archived model.
TimeArchivalScheduled string: The estimated archival time of the model based on the provided retention setting.
TimeDeletionScheduled string: The estimated deletion time of the model based on the provided retention setting.

ArchiveState string: The archival status of model.
ArchiveStateDetails string: The archival state details of the model.
DeleteState string: The deletion status of the archived model.
DeleteStateDetails string: The deletion status details of the archived model.
TimeArchivalScheduled string: The estimated archival time of the model based on the provided retention setting.
TimeDeletionScheduled string: The estimated deletion time of the model based on the provided retention setting.

archiveState String: The archival status of model.
archiveStateDetails String: The archival state details of the model.
deleteState String: The deletion status of the archived model.
deleteStateDetails String: The deletion status details of the archived model.
timeArchivalScheduled String: The estimated archival time of the model based on the provided retention setting.
timeDeletionScheduled String: The estimated deletion time of the model based on the provided retention setting.

archiveState string: The archival status of model.
archiveStateDetails string: The archival state details of the model.
deleteState string: The deletion status of the archived model.
deleteStateDetails string: The deletion status details of the archived model.
timeArchivalScheduled string: The estimated archival time of the model based on the provided retention setting.
timeDeletionScheduled string: The estimated deletion time of the model based on the provided retention setting.

archive_state str: The archival status of model.
archive_state_details str: The archival state details of the model.
delete_state str: The deletion status of the archived model.
delete_state_details str: The deletion status details of the archived model.
time_archival_scheduled str: The estimated archival time of the model based on the provided retention setting.
time_deletion_scheduled str: The estimated deletion time of the model based on the provided retention setting.

archiveState String: The archival status of model.
archiveStateDetails String: The archival state details of the model.
deleteState String: The deletion status of the archived model.
deleteStateDetails String: The deletion status details of the archived model.
timeArchivalScheduled String: The estimated archival time of the model based on the provided retention setting.
timeDeletionScheduled String: The estimated deletion time of the model based on the provided retention setting.

GetModelsModelRetentionSetting

ArchiveAfterDays int: Number of days after which the model will be archived.
CustomerNotificationType string: Customer notification options on success/failure of archival, deletion events.
DeleteAfterDays int: Number of days after which the archived model will be deleted.

ArchiveAfterDays int: Number of days after which the model will be archived.
CustomerNotificationType string: Customer notification options on success/failure of archival, deletion events.
DeleteAfterDays int: Number of days after which the archived model will be deleted.

archiveAfterDays Integer: Number of days after which the model will be archived.
customerNotificationType String: Customer notification options on success/failure of archival, deletion events.
deleteAfterDays Integer: Number of days after which the archived model will be deleted.

archiveAfterDays number: Number of days after which the model will be archived.
customerNotificationType string: Customer notification options on success/failure of archival, deletion events.
deleteAfterDays number: Number of days after which the archived model will be deleted.

archive_after_days int: Number of days after which the model will be archived.
customer_notification_type str: Customer notification options on success/failure of archival, deletion events.
delete_after_days int: Number of days after which the archived model will be deleted.

archiveAfterDays Number: Number of days after which the model will be archived.
customerNotificationType String: Customer notification options on success/failure of archival, deletion events.
deleteAfterDays Number: Number of days after which the archived model will be deleted.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.DataScience.getModels

On this page

On this page

Example Usage

Using getModels

getModels Result

Supporting Types

GetModelsFilter

GetModelsModel

GetModelsModelBackupOperationDetail

GetModelsModelBackupSetting

GetModelsModelCustomMetadataList

GetModelsModelDefinedMetadataList

GetModelsModelRetentionOperationDetail

GetModelsModelRetentionSetting

Package Details

On this page

On this page