Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi
oci.GenerativeAi.getAgentAgents
Explore with Pulumi AI
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[_generativeai.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[_generativeai.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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:GenerativeAi/getAgentAgents:getAgentAgents
arguments:
# arguments dictionary
The following arguments are supported:
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Filters
List<Get
Agent Agents Filter> - State string
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Filters
[]Get
Agent Agents Filter - State string
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- compartment
Id String - The OCID of the compartment in which to list resources.
- display
Name String - A filter to return only resources that match the given display name exactly.
- filters
List<Get
Agent Agents Filter> - state String
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- compartment
Id string - The OCID of the compartment in which to list resources.
- display
Name string - A filter to return only resources that match the given display name exactly.
- filters
Get
Agent Agents Filter[] - 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[generativeai.
Get Agent Agents Filter] - state str
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- compartment
Id String - The OCID of the compartment in which to list resources.
- display
Name 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:
- Agent
Collections List<GetAgent Agents Agent Collection> - The list of agent_collection.
- Id string
- The provider-assigned unique ID for this managed resource.
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable.
- Filters
List<Get
Agent Agents Filter> - State string
- The current state of the agent.
- Agent
Collections []GetAgent Agents Agent Collection - The list of agent_collection.
- Id string
- The provider-assigned unique ID for this managed resource.
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable.
- Filters
[]Get
Agent Agents Filter - State string
- The current state of the agent.
- agent
Collections List<GetAgent Agents Agent Collection> - The list of agent_collection.
- id String
- The provider-assigned unique ID for this managed resource.
- compartment
Id String - The OCID of the compartment.
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable.
- filters
List<Get
Agent Agents Filter> - state String
- The current state of the agent.
- agent
Collections GetAgent Agents Agent Collection[] - The list of agent_collection.
- id string
- The provider-assigned unique ID for this managed resource.
- compartment
Id string - The OCID of the compartment.
- display
Name string - A user-friendly name. Does not have to be unique, and it's changeable.
- filters
Get
Agent Agents Filter[] - state string
- The current state of the agent.
- agent_
collections Sequence[generativeai.Get Agent Agents Agent Collection] - 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[generativeai.
Get Agent Agents Filter] - state str
- The current state of the agent.
- agent
Collections List<Property Map> - The list of agent_collection.
- id String
- The provider-assigned unique ID for this managed resource.
- compartment
Id String - The OCID of the compartment.
- display
Name 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
- Compartment
Id string - The OCID of the compartment in which to list resources.
- 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.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- 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.
- Knowledge
Base List<string>Ids - List of OCID of the knowledgeBases associated with agent.
- Lifecycle
Details 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.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - The date and time the agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Updated string - The date and time the agent was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Welcome
Message string - Details about purpose and responsibility of the agent
- Compartment
Id string - The OCID of the compartment in which to list resources.
- 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.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- 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.
- Knowledge
Base []stringIds - List of OCID of the knowledgeBases associated with agent.
- Lifecycle
Details 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.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - The date and time the agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Updated string - The date and time the agent was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Welcome
Message string - Details about purpose and responsibility of the agent
- compartment
Id String - The OCID of the compartment in which to list resources.
- 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.
- display
Name String - A filter to return only resources that match the given display name exactly.
- 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.
- knowledge
Base List<String>Ids - List of OCID of the knowledgeBases associated with agent.
- lifecycle
Details 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.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The date and time the agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Updated String - The date and time the agent was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- welcome
Message String - Details about purpose and responsibility of the agent
- compartment
Id string - The OCID of the compartment in which to list resources.
- {[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.
- display
Name string - A filter to return only resources that match the given display name exactly.
- {[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.
- knowledge
Base string[]Ids - List of OCID of the knowledgeBases associated with agent.
- lifecycle
Details 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.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created string - The date and time the agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Updated string - The date and time the agent was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- welcome
Message string - Details about purpose and responsibility of the agent
- compartment_
id str - The OCID of the compartment in which to list resources.
- 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.
- 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_ Sequence[str]ids - 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.
- 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
- compartment
Id String - The OCID of the compartment in which to list resources.
- 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.
- display
Name String - A filter to return only resources that match the given display name exactly.
- 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.
- knowledge
Base List<String>Ids - List of OCID of the knowledgeBases associated with agent.
- lifecycle
Details 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.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The date and time the agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Updated String - The date and time the agent was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- welcome
Message String - Details about purpose and responsibility of the agent
GetAgentAgentsFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.