1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. oci
  5. getAiDataPlatformAiDataPlatforms
Oracle Cloud Infrastructure v3.11.1 published on Friday, Nov 14, 2025 by Pulumi
oci logo
Oracle Cloud Infrastructure v3.11.1 published on Friday, Nov 14, 2025 by Pulumi

    This data source provides the list of Ai Data Platforms in Oracle Cloud Infrastructure Ai Data Platform service.

    Gets a list of AiDataPlatforms.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testAiDataPlatforms = oci.oci.getAiDataPlatformAiDataPlatforms({
        compartmentId: compartmentId,
        displayName: aiDataPlatformDisplayName,
        excludeLifecycleState: aiDataPlatformExcludeLifecycleState,
        id: aiDataPlatformId,
        includeLegacy: aiDataPlatformIncludeLegacy,
        state: aiDataPlatformState,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_ai_data_platforms = oci.oci.get_ai_data_platform_ai_data_platforms(compartment_id=compartment_id,
        display_name=ai_data_platform_display_name,
        exclude_lifecycle_state=ai_data_platform_exclude_lifecycle_state,
        id=ai_data_platform_id,
        include_legacy=ai_data_platform_include_legacy,
        state=ai_data_platform_state)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/oci"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := oci.GetAiDataPlatformAiDataPlatforms(ctx, &oci.GetAiDataPlatformAiDataPlatformsArgs{
    			CompartmentId:         pulumi.StringRef(compartmentId),
    			DisplayName:           pulumi.StringRef(aiDataPlatformDisplayName),
    			ExcludeLifecycleState: pulumi.StringRef(aiDataPlatformExcludeLifecycleState),
    			Id:                    pulumi.StringRef(aiDataPlatformId),
    			IncludeLegacy:         pulumi.StringRef(aiDataPlatformIncludeLegacy),
    			State:                 pulumi.StringRef(aiDataPlatformState),
    		}, 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 testAiDataPlatforms = Oci.Oci.GetAiDataPlatformAiDataPlatforms.Invoke(new()
        {
            CompartmentId = compartmentId,
            DisplayName = aiDataPlatformDisplayName,
            ExcludeLifecycleState = aiDataPlatformExcludeLifecycleState,
            Id = aiDataPlatformId,
            IncludeLegacy = aiDataPlatformIncludeLegacy,
            State = aiDataPlatformState,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.oci.OciFunctions;
    import com.pulumi.oci.oci.inputs.GetAiDataPlatformAiDataPlatformsArgs;
    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 testAiDataPlatforms = OciFunctions.getAiDataPlatformAiDataPlatforms(GetAiDataPlatformAiDataPlatformsArgs.builder()
                .compartmentId(compartmentId)
                .displayName(aiDataPlatformDisplayName)
                .excludeLifecycleState(aiDataPlatformExcludeLifecycleState)
                .id(aiDataPlatformId)
                .includeLegacy(aiDataPlatformIncludeLegacy)
                .state(aiDataPlatformState)
                .build());
    
        }
    }
    
    variables:
      testAiDataPlatforms:
        fn::invoke:
          function: oci:oci:getAiDataPlatformAiDataPlatforms
          arguments:
            compartmentId: ${compartmentId}
            displayName: ${aiDataPlatformDisplayName}
            excludeLifecycleState: ${aiDataPlatformExcludeLifecycleState}
            id: ${aiDataPlatformId}
            includeLegacy: ${aiDataPlatformIncludeLegacy}
            state: ${aiDataPlatformState}
    

    Using getAiDataPlatformAiDataPlatforms

    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.

    function getAiDataPlatformAiDataPlatforms(args: GetAiDataPlatformAiDataPlatformsArgs, opts?: InvokeOptions): Promise<GetAiDataPlatformAiDataPlatformsResult>
    function getAiDataPlatformAiDataPlatformsOutput(args: GetAiDataPlatformAiDataPlatformsOutputArgs, opts?: InvokeOptions): Output<GetAiDataPlatformAiDataPlatformsResult>
    def get_ai_data_platform_ai_data_platforms(compartment_id: Optional[str] = None,
                                               display_name: Optional[str] = None,
                                               exclude_lifecycle_state: Optional[str] = None,
                                               filters: Optional[Sequence[GetAiDataPlatformAiDataPlatformsFilter]] = None,
                                               id: Optional[str] = None,
                                               include_legacy: Optional[str] = None,
                                               state: Optional[str] = None,
                                               opts: Optional[InvokeOptions] = None) -> GetAiDataPlatformAiDataPlatformsResult
    def get_ai_data_platform_ai_data_platforms_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                               display_name: Optional[pulumi.Input[str]] = None,
                                               exclude_lifecycle_state: Optional[pulumi.Input[str]] = None,
                                               filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetAiDataPlatformAiDataPlatformsFilterArgs]]]] = None,
                                               id: Optional[pulumi.Input[str]] = None,
                                               include_legacy: Optional[pulumi.Input[str]] = None,
                                               state: Optional[pulumi.Input[str]] = None,
                                               opts: Optional[InvokeOptions] = None) -> Output[GetAiDataPlatformAiDataPlatformsResult]
    func GetAiDataPlatformAiDataPlatforms(ctx *Context, args *GetAiDataPlatformAiDataPlatformsArgs, opts ...InvokeOption) (*GetAiDataPlatformAiDataPlatformsResult, error)
    func GetAiDataPlatformAiDataPlatformsOutput(ctx *Context, args *GetAiDataPlatformAiDataPlatformsOutputArgs, opts ...InvokeOption) GetAiDataPlatformAiDataPlatformsResultOutput

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

    public static class GetAiDataPlatformAiDataPlatforms 
    {
        public static Task<GetAiDataPlatformAiDataPlatformsResult> InvokeAsync(GetAiDataPlatformAiDataPlatformsArgs args, InvokeOptions? opts = null)
        public static Output<GetAiDataPlatformAiDataPlatformsResult> Invoke(GetAiDataPlatformAiDataPlatformsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAiDataPlatformAiDataPlatformsResult> getAiDataPlatformAiDataPlatforms(GetAiDataPlatformAiDataPlatformsArgs args, InvokeOptions options)
    public static Output<GetAiDataPlatformAiDataPlatformsResult> getAiDataPlatformAiDataPlatforms(GetAiDataPlatformAiDataPlatformsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: oci:oci/getAiDataPlatformAiDataPlatforms:getAiDataPlatformAiDataPlatforms
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    ExcludeLifecycleState string
    A filter to exclude resources that match the given lifecycle state. The state value is case-insensitive.
    Filters List<GetAiDataPlatformAiDataPlatformsFilter>
    Id string
    The OCID of the AiDataPlatform.
    IncludeLegacy string
    This flag will determine if legacy instances will be returned.
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    ExcludeLifecycleState string
    A filter to exclude resources that match the given lifecycle state. The state value is case-insensitive.
    Filters []GetAiDataPlatformAiDataPlatformsFilter
    Id string
    The OCID of the AiDataPlatform.
    IncludeLegacy string
    This flag will determine if legacy instances will be returned.
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId String
    The OCID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the given display name exactly.
    excludeLifecycleState String
    A filter to exclude resources that match the given lifecycle state. The state value is case-insensitive.
    filters List<GetAiDataPlatformAiDataPlatformsFilter>
    id String
    The OCID of the AiDataPlatform.
    includeLegacy String
    This flag will determine if legacy instances will be returned.
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId string
    The OCID of the compartment in which to list resources.
    displayName string
    A filter to return only resources that match the given display name exactly.
    excludeLifecycleState string
    A filter to exclude resources that match the given lifecycle state. The state value is case-insensitive.
    filters GetAiDataPlatformAiDataPlatformsFilter[]
    id string
    The OCID of the AiDataPlatform.
    includeLegacy string
    This flag will determine if legacy instances will be returned.
    state string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    compartment_id str
    The OCID of the compartment in which to list resources.
    display_name str
    A filter to return only resources that match the given display name exactly.
    exclude_lifecycle_state str
    A filter to exclude resources that match the given lifecycle state. The state value is case-insensitive.
    filters Sequence[GetAiDataPlatformAiDataPlatformsFilter]
    id str
    The OCID of the AiDataPlatform.
    include_legacy str
    This flag will determine if legacy instances will be returned.
    state str
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId String
    The OCID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the given display name exactly.
    excludeLifecycleState String
    A filter to exclude resources that match the given lifecycle state. The state value is case-insensitive.
    filters List<Property Map>
    id String
    The OCID of the AiDataPlatform.
    includeLegacy String
    This flag will determine if legacy instances will be returned.
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

    getAiDataPlatformAiDataPlatforms Result

    The following output properties are available:

    AiDataPlatformCollections List<GetAiDataPlatformAiDataPlatformsAiDataPlatformCollection>
    The list of ai_data_platform_collection.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    ExcludeLifecycleState string
    Filters List<GetAiDataPlatformAiDataPlatformsFilter>
    Id string
    The OCID of the AiDataPlatform.
    IncludeLegacy string
    State string
    The current state of the AiDataPlatform.
    AiDataPlatformCollections []GetAiDataPlatformAiDataPlatformsAiDataPlatformCollection
    The list of ai_data_platform_collection.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    ExcludeLifecycleState string
    Filters []GetAiDataPlatformAiDataPlatformsFilter
    Id string
    The OCID of the AiDataPlatform.
    IncludeLegacy string
    State string
    The current state of the AiDataPlatform.
    aiDataPlatformCollections List<GetAiDataPlatformAiDataPlatformsAiDataPlatformCollection>
    The list of ai_data_platform_collection.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    excludeLifecycleState String
    filters List<GetAiDataPlatformAiDataPlatformsFilter>
    id String
    The OCID of the AiDataPlatform.
    includeLegacy String
    state String
    The current state of the AiDataPlatform.
    aiDataPlatformCollections GetAiDataPlatformAiDataPlatformsAiDataPlatformCollection[]
    The list of ai_data_platform_collection.
    compartmentId string
    The OCID of the compartment.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    excludeLifecycleState string
    filters GetAiDataPlatformAiDataPlatformsFilter[]
    id string
    The OCID of the AiDataPlatform.
    includeLegacy string
    state string
    The current state of the AiDataPlatform.
    ai_data_platform_collections Sequence[GetAiDataPlatformAiDataPlatformsAiDataPlatformCollection]
    The list of ai_data_platform_collection.
    compartment_id str
    The OCID of the compartment.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable.
    exclude_lifecycle_state str
    filters Sequence[GetAiDataPlatformAiDataPlatformsFilter]
    id str
    The OCID of the AiDataPlatform.
    include_legacy str
    state str
    The current state of the AiDataPlatform.
    aiDataPlatformCollections List<Property Map>
    The list of ai_data_platform_collection.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    excludeLifecycleState String
    filters List<Property Map>
    id String
    The OCID of the AiDataPlatform.
    includeLegacy String
    state String
    The current state of the AiDataPlatform.

    Supporting Types

    GetAiDataPlatformAiDataPlatformsAiDataPlatformCollection

    GetAiDataPlatformAiDataPlatformsAiDataPlatformCollectionItem

    AiDataPlatformType string
    The AiDataPlatform type.
    AliasKey string
    The alias Id of the AiDataPlatform which is the short form of OCID.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    CreatedBy string
    The OCID of the IAM user.
    DefaultWorkspaceName string
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    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. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the AiDataPlatform.
    LifecycleDetails string
    A message that describes the current state of the AiDataPlatform in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the AiDataPlatform was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the AiDataPlatform was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    WebSocketEndpoint string
    The WebSocket URL of the AiDataPlatform.
    AiDataPlatformType string
    The AiDataPlatform type.
    AliasKey string
    The alias Id of the AiDataPlatform which is the short form of OCID.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    CreatedBy string
    The OCID of the IAM user.
    DefaultWorkspaceName string
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    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. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the AiDataPlatform.
    LifecycleDetails string
    A message that describes the current state of the AiDataPlatform in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the AiDataPlatform was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the AiDataPlatform was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    WebSocketEndpoint string
    The WebSocket URL of the AiDataPlatform.
    aiDataPlatformType String
    The AiDataPlatform type.
    aliasKey String
    The alias Id of the AiDataPlatform which is the short form of OCID.
    compartmentId String
    The OCID of the compartment in which to list resources.
    createdBy String
    The OCID of the IAM user.
    defaultWorkspaceName String
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    A filter to return only resources that match the given display name exactly.
    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. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the AiDataPlatform.
    lifecycleDetails String
    A message that describes the current state of the AiDataPlatform in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the AiDataPlatform was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the AiDataPlatform was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    webSocketEndpoint String
    The WebSocket URL of the AiDataPlatform.
    aiDataPlatformType string
    The AiDataPlatform type.
    aliasKey string
    The alias Id of the AiDataPlatform which is the short form of OCID.
    compartmentId string
    The OCID of the compartment in which to list resources.
    createdBy string
    The OCID of the IAM user.
    defaultWorkspaceName string
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    A filter to return only resources that match the given display name exactly.
    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. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of the AiDataPlatform.
    lifecycleDetails string
    A message that describes the current state of the AiDataPlatform in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the AiDataPlatform was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the AiDataPlatform was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    webSocketEndpoint string
    The WebSocket URL of the AiDataPlatform.
    ai_data_platform_type str
    The AiDataPlatform type.
    alias_key str
    The alias Id of the AiDataPlatform which is the short form of OCID.
    compartment_id str
    The OCID of the compartment in which to list resources.
    created_by str
    The OCID of the IAM user.
    default_workspace_name str
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    A filter to return only resources that match the given display name exactly.
    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. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The OCID of the AiDataPlatform.
    lifecycle_details str
    A message that describes the current state of the AiDataPlatform in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state str
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the AiDataPlatform was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the AiDataPlatform was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    web_socket_endpoint str
    The WebSocket URL of the AiDataPlatform.
    aiDataPlatformType String
    The AiDataPlatform type.
    aliasKey String
    The alias Id of the AiDataPlatform which is the short form of OCID.
    compartmentId String
    The OCID of the compartment in which to list resources.
    createdBy String
    The OCID of the IAM user.
    defaultWorkspaceName String
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    A filter to return only resources that match the given display name exactly.
    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the AiDataPlatform.
    lifecycleDetails String
    A message that describes the current state of the AiDataPlatform in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the AiDataPlatform was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the AiDataPlatform was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    webSocketEndpoint String
    The WebSocket URL of the AiDataPlatform.

    GetAiDataPlatformAiDataPlatformsFilter

    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

    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.11.1 published on Friday, Nov 14, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate