Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GenerativeAi
  5. getAgentAgents
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.GenerativeAi.getAgentAgents

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Agents in Oracle Cloud Infrastructure Generative Ai Agent service.

    ListAgents

    Gets a list of agents.

    Example Usage

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

const testAgents = oci.GenerativeAi.getAgentAgents({
    compartmentId: compartmentId,
    displayName: agentDisplayName,
    state: agentState,
});

    import pulumi
import pulumi_oci as oci

test_agents = oci.GenerativeAi.get_agent_agents(compartment_id=compartment_id,
    display_name=agent_display_name,
    state=agent_state)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := generativeai.GetAgentAgents(ctx, &generativeai.GetAgentAgentsArgs{
			CompartmentId: pulumi.StringRef(compartmentId),
			DisplayName:   pulumi.StringRef(agentDisplayName),
			State:         pulumi.StringRef(agentState),
		}, 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 testAgents = Oci.GenerativeAi.GetAgentAgents.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = agentDisplayName,
        State = agentState,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.GenerativeAiFunctions;
import com.pulumi.oci.GenerativeAi.inputs.GetAgentAgentsArgs;
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 testAgents = GenerativeAiFunctions.getAgentAgents(GetAgentAgentsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(agentDisplayName)
            .state(agentState)
            .build());

    }
}

    variables:
  testAgents:
    fn::invoke:
      function: oci:GenerativeAi:getAgentAgents
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${agentDisplayName}
        state: ${agentState}

    Using getAgentAgents

    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 getAgentAgents(args: GetAgentAgentsArgs, opts?: InvokeOptions): Promise<GetAgentAgentsResult>
function getAgentAgentsOutput(args: GetAgentAgentsOutputArgs, opts?: InvokeOptions): Output<GetAgentAgentsResult>
    def get_agent_agents(compartment_id: Optional[str] = None,
                     display_name: Optional[str] = None,
                     filters: Optional[Sequence[GetAgentAgentsFilter]] = None,
                     state: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetAgentAgentsResult
def get_agent_agents_output(compartment_id: Optional[pulumi.Input[str]] = None,
                     display_name: Optional[pulumi.Input[str]] = None,
                     filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetAgentAgentsFilterArgs]]]] = None,
                     state: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetAgentAgentsResult]
    func GetAgentAgents(ctx *Context, args *GetAgentAgentsArgs, opts ...InvokeOption) (*GetAgentAgentsResult, error)
func GetAgentAgentsOutput(ctx *Context, args *GetAgentAgentsOutputArgs, opts ...InvokeOption) GetAgentAgentsResultOutput

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

    public static class GetAgentAgents 
{
    public static Task<GetAgentAgentsResult> InvokeAsync(GetAgentAgentsArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentAgentsResult> Invoke(GetAgentAgentsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAgentAgentsResult> getAgentAgents(GetAgentAgentsArgs args, InvokeOptions options)
public static Output<GetAgentAgentsResult> getAgentAgents(GetAgentAgentsArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:GenerativeAi/getAgentAgents:getAgentAgents
  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.
    Filters List<GetAgentAgentsFilter>
    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.
    Filters []GetAgentAgentsFilter
    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.
    filters List<GetAgentAgentsFilter>
    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.
    filters GetAgentAgentsFilter[]
    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.
    filters Sequence[GetAgentAgentsFilter]
    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.
    filters List<Property Map>
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

    getAgentAgents Result

    The following output properties are available:

    AgentCollections List<GetAgentAgentsAgentCollection>
    The list of agent_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    Filters List<GetAgentAgentsFilter>
    State string
    The current state of the agent.
    AgentCollections []GetAgentAgentsAgentCollection
    The list of agent_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    Filters []GetAgentAgentsFilter
    State string
    The current state of the agent.
    agentCollections List<GetAgentAgentsAgentCollection>
    The list of agent_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters List<GetAgentAgentsFilter>
    state String
    The current state of the agent.
    agentCollections GetAgentAgentsAgentCollection[]
    The list of agent_collection.
    id string
    The provider-assigned unique ID for this managed resource.
    compartmentId string
    The OCID of the compartment.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters GetAgentAgentsFilter[]
    state string
    The current state of the agent.
    agent_collections Sequence[GetAgentAgentsAgentCollection]
    The list of agent_collection.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    filters Sequence[GetAgentAgentsFilter]
    state str
    The current state of the agent.
    agentCollections List<Property Map>
    The list of agent_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters List<Property Map>
    state String
    The current state of the agent.

    Supporting Types

    GetAgentAgentsAgentCollection

    GetAgentAgentsAgentCollectionItem

    CompartmentId string
    The OCID of the compartment in which to list resources.
    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"}
    Description string
    Description about the agent.
    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 agent.
    KnowledgeBaseIds List<string>
    List of OCID of the knowledgeBases associated with agent.
    LifecycleDetails string
    A message that describes the current state of the agent 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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    WelcomeMessage string
    Details about purpose and responsibility of the agent
    CompartmentId string
    The OCID of the compartment in which to list resources.
    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"}
    Description string
    Description about the agent.
    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 agent.
    KnowledgeBaseIds []string
    List of OCID of the knowledgeBases associated with agent.
    LifecycleDetails string
    A message that describes the current state of the agent 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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    WelcomeMessage string
    Details about purpose and responsibility of the agent
    compartmentId String
    The OCID of the compartment in which to list resources.
    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"}
    description String
    Description about the agent.
    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 agent.
    knowledgeBaseIds List<String>
    List of OCID of the knowledgeBases associated with agent.
    lifecycleDetails String
    A message that describes the current state of the agent 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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    welcomeMessage String
    Details about purpose and responsibility of the agent
    compartmentId string
    The OCID of the compartment in which to list resources.
    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"}
    description string
    Description about the agent.
    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 agent.
    knowledgeBaseIds string[]
    List of OCID of the knowledgeBases associated with agent.
    lifecycleDetails string
    A message that describes the current state of the agent 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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    welcomeMessage string
    Details about purpose and responsibility of the agent
    compartment_id str
    The OCID of the compartment in which to list resources.
    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"}
    description str
    Description about the agent.
    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 agent.
    knowledge_base_ids Sequence[str]
    List of OCID of the knowledgeBases associated with agent.
    lifecycle_details str
    A message that describes the current state of the agent 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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    welcome_message str
    Details about purpose and responsibility of the agent
    compartmentId String
    The OCID of the compartment in which to list resources.
    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"}
    description String
    Description about the agent.
    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 agent.
    knowledgeBaseIds List<String>
    List of OCID of the knowledgeBases associated with agent.
    lifecycleDetails String
    A message that describes the current state of the agent 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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    welcomeMessage String
    Details about purpose and responsibility of the agent

    GetAgentAgentsFilter

    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 v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci