1. Registry
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getAgentKitSessions
Viewing docs for Databricks v1.118.1
published on Tuesday, Oct 27, 2026 by Pulumi
databricks logo databricks logo
Viewing docs for Databricks v1.118.1
published on Tuesday, Oct 27, 2026 by Pulumi

    Public Beta

    API Documentation

    Using getAgentKitSessions

    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 getAgentKitSessions(args: GetAgentKitSessionsArgs, opts?: InvokeOptions): Promise<GetAgentKitSessionsResult>
    function getAgentKitSessionsOutput(args: GetAgentKitSessionsOutputArgs, opts?: InvokeOutputOptions): Output<GetAgentKitSessionsResult>
    def get_agent_kit_sessions(filter: Optional[str] = None,
                               order_by: Optional[str] = None,
                               page_size: Optional[int] = None,
                               parent: Optional[str] = None,
                               provider_config: Optional[GetAgentKitSessionsProviderConfig] = None,
                               opts: Optional[InvokeOptions] = None) -> GetAgentKitSessionsResult
    def get_agent_kit_sessions_output(filter: pulumi.Input[Optional[str]] = None,
                               order_by: pulumi.Input[Optional[str]] = None,
                               page_size: pulumi.Input[Optional[int]] = None,
                               parent: pulumi.Input[Optional[str]] = None,
                               provider_config: pulumi.Input[Optional[GetAgentKitSessionsProviderConfigArgs]] = None,
                               opts: Optional[InvokeOutputOptions] = None) -> Output[GetAgentKitSessionsResult]
    func GetAgentKitSessions(ctx *Context, args *GetAgentKitSessionsArgs, opts ...InvokeOption) (*GetAgentKitSessionsResult, error)
    func GetAgentKitSessionsOutput(ctx *Context, args *GetAgentKitSessionsOutputArgs, opts ...InvokeOption) GetAgentKitSessionsResultOutput

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

    public static class GetAgentKitSessions 
    {
        public static Task<GetAgentKitSessionsResult> InvokeAsync(GetAgentKitSessionsArgs args, InvokeOptions? opts = null)
        public static Output<GetAgentKitSessionsResult> Invoke(GetAgentKitSessionsInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetAgentKitSessionsResult> Invoke(GetAgentKitSessionsInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetAgentKitSessionsResult> getAgentKitSessions(GetAgentKitSessionsArgs args, InvokeOptions options)
    public static Output<GetAgentKitSessionsResult> getAgentKitSessions(GetAgentKitSessionsArgs args, InvokeOptions options)
    public static Output<GetAgentKitSessionsResult> getAgentKitSessions(GetAgentKitSessionsArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: databricks:index/getAgentKitSessions:getAgentKitSessions
      arguments:
        # arguments dictionary
    data "databricks_get_agent_kit_sessions" "name" {
        # arguments
    }

    The following arguments are supported:

    Parent string
    Resource name of the containing session store, in the form session-stores/{session_store_id}
    Filter string
    Filter expression. Supported fields include actorId and metadata; for example, actorId = "support-customer-123"
    OrderBy string
    Sort order. Defaults to lastActivityTime desc. Page-token continuation is exactly-once when ordering by createTime (immutable); ordering by lastActivityTime is best-effort, because that value changes as a session gains activity, so a session updated between page requests may be repeated or skipped. To enumerate every session exactly once, order by createTime
    PageSize int
    Maximum number of sessions to return. Defaults to 10; must be between 1 and 100
    ProviderConfig GetAgentKitSessionsProviderConfig
    Configure the provider for management through account provider.
    Parent string
    Resource name of the containing session store, in the form session-stores/{session_store_id}
    Filter string
    Filter expression. Supported fields include actorId and metadata; for example, actorId = "support-customer-123"
    OrderBy string
    Sort order. Defaults to lastActivityTime desc. Page-token continuation is exactly-once when ordering by createTime (immutable); ordering by lastActivityTime is best-effort, because that value changes as a session gains activity, so a session updated between page requests may be repeated or skipped. To enumerate every session exactly once, order by createTime
    PageSize int
    Maximum number of sessions to return. Defaults to 10; must be between 1 and 100
    ProviderConfig GetAgentKitSessionsProviderConfig
    Configure the provider for management through account provider.
    parent string
    Resource name of the containing session store, in the form session-stores/{session_store_id}
    filter string
    Filter expression. Supported fields include actorId and metadata; for example, actorId = "support-customer-123"
    order_by string
    Sort order. Defaults to lastActivityTime desc. Page-token continuation is exactly-once when ordering by createTime (immutable); ordering by lastActivityTime is best-effort, because that value changes as a session gains activity, so a session updated between page requests may be repeated or skipped. To enumerate every session exactly once, order by createTime
    page_size number
    Maximum number of sessions to return. Defaults to 10; must be between 1 and 100
    provider_config object
    Configure the provider for management through account provider.
    parent String
    Resource name of the containing session store, in the form session-stores/{session_store_id}
    filter String
    Filter expression. Supported fields include actorId and metadata; for example, actorId = "support-customer-123"
    orderBy String
    Sort order. Defaults to lastActivityTime desc. Page-token continuation is exactly-once when ordering by createTime (immutable); ordering by lastActivityTime is best-effort, because that value changes as a session gains activity, so a session updated between page requests may be repeated or skipped. To enumerate every session exactly once, order by createTime
    pageSize Integer
    Maximum number of sessions to return. Defaults to 10; must be between 1 and 100
    providerConfig GetAgentKitSessionsProviderConfig
    Configure the provider for management through account provider.
    parent string
    Resource name of the containing session store, in the form session-stores/{session_store_id}
    filter string
    Filter expression. Supported fields include actorId and metadata; for example, actorId = "support-customer-123"
    orderBy string
    Sort order. Defaults to lastActivityTime desc. Page-token continuation is exactly-once when ordering by createTime (immutable); ordering by lastActivityTime is best-effort, because that value changes as a session gains activity, so a session updated between page requests may be repeated or skipped. To enumerate every session exactly once, order by createTime
    pageSize number
    Maximum number of sessions to return. Defaults to 10; must be between 1 and 100
    providerConfig GetAgentKitSessionsProviderConfig
    Configure the provider for management through account provider.
    parent str
    Resource name of the containing session store, in the form session-stores/{session_store_id}
    filter str
    Filter expression. Supported fields include actorId and metadata; for example, actorId = "support-customer-123"
    order_by str
    Sort order. Defaults to lastActivityTime desc. Page-token continuation is exactly-once when ordering by createTime (immutable); ordering by lastActivityTime is best-effort, because that value changes as a session gains activity, so a session updated between page requests may be repeated or skipped. To enumerate every session exactly once, order by createTime
    page_size int
    Maximum number of sessions to return. Defaults to 10; must be between 1 and 100
    provider_config GetAgentKitSessionsProviderConfig
    Configure the provider for management through account provider.
    parent String
    Resource name of the containing session store, in the form session-stores/{session_store_id}
    filter String
    Filter expression. Supported fields include actorId and metadata; for example, actorId = "support-customer-123"
    orderBy String
    Sort order. Defaults to lastActivityTime desc. Page-token continuation is exactly-once when ordering by createTime (immutable); ordering by lastActivityTime is best-effort, because that value changes as a session gains activity, so a session updated between page requests may be repeated or skipped. To enumerate every session exactly once, order by createTime
    pageSize Number
    Maximum number of sessions to return. Defaults to 10; must be between 1 and 100
    providerConfig Property Map
    Configure the provider for management through account provider.

    getAgentKitSessions Result

    The following output properties are available:

    Supporting Types

    GetAgentKitSessionsProviderConfig

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id str
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

    GetAgentKitSessionsSession

    ActorId string
    (string) - Opaque caller-provided identifier for the application actor associated with the session.
    CreateTime string
    (string) - Time when the session was created
    LastActivityTime string
    (string) - Time when the session's item history was last mutated
    Metadata Dictionary<string, string>
    (object) - Mutable caller-defined string labels
    Name string
    (string) - Resource name in the form session-stores/{session_store_id}/sessions/{session_id}
    ParentSessionId string
    (string) - Immediate parent session ID. Set only at creation for child sessions, immutable thereafter, and restricted to the same store
    RootSessionId string
    (string) - Top-level session ID in the spawn tree. This equals sessionId for a root or fork and is inherited transitively by child sessions
    SessionId string
    (string) - Unique session ID. The service generates a UUID unless the caller supplies CreateSessionRequest.session_id
    UpdateTime string
    (string) - Time when session resource fields last changed
    ProviderConfig GetAgentKitSessionsSessionProviderConfig
    Configure the provider for management through account provider.
    ActorId string
    (string) - Opaque caller-provided identifier for the application actor associated with the session.
    CreateTime string
    (string) - Time when the session was created
    LastActivityTime string
    (string) - Time when the session's item history was last mutated
    Metadata map[string]string
    (object) - Mutable caller-defined string labels
    Name string
    (string) - Resource name in the form session-stores/{session_store_id}/sessions/{session_id}
    ParentSessionId string
    (string) - Immediate parent session ID. Set only at creation for child sessions, immutable thereafter, and restricted to the same store
    RootSessionId string
    (string) - Top-level session ID in the spawn tree. This equals sessionId for a root or fork and is inherited transitively by child sessions
    SessionId string
    (string) - Unique session ID. The service generates a UUID unless the caller supplies CreateSessionRequest.session_id
    UpdateTime string
    (string) - Time when session resource fields last changed
    ProviderConfig GetAgentKitSessionsSessionProviderConfig
    Configure the provider for management through account provider.
    actor_id string
    (string) - Opaque caller-provided identifier for the application actor associated with the session.
    create_time string
    (string) - Time when the session was created
    last_activity_time string
    (string) - Time when the session's item history was last mutated
    metadata map(string)
    (object) - Mutable caller-defined string labels
    name string
    (string) - Resource name in the form session-stores/{session_store_id}/sessions/{session_id}
    parent_session_id string
    (string) - Immediate parent session ID. Set only at creation for child sessions, immutable thereafter, and restricted to the same store
    root_session_id string
    (string) - Top-level session ID in the spawn tree. This equals sessionId for a root or fork and is inherited transitively by child sessions
    session_id string
    (string) - Unique session ID. The service generates a UUID unless the caller supplies CreateSessionRequest.session_id
    update_time string
    (string) - Time when session resource fields last changed
    provider_config object
    Configure the provider for management through account provider.
    actorId String
    (string) - Opaque caller-provided identifier for the application actor associated with the session.
    createTime String
    (string) - Time when the session was created
    lastActivityTime String
    (string) - Time when the session's item history was last mutated
    metadata Map<String,String>
    (object) - Mutable caller-defined string labels
    name String
    (string) - Resource name in the form session-stores/{session_store_id}/sessions/{session_id}
    parentSessionId String
    (string) - Immediate parent session ID. Set only at creation for child sessions, immutable thereafter, and restricted to the same store
    rootSessionId String
    (string) - Top-level session ID in the spawn tree. This equals sessionId for a root or fork and is inherited transitively by child sessions
    sessionId String
    (string) - Unique session ID. The service generates a UUID unless the caller supplies CreateSessionRequest.session_id
    updateTime String
    (string) - Time when session resource fields last changed
    providerConfig GetAgentKitSessionsSessionProviderConfig
    Configure the provider for management through account provider.
    actorId string
    (string) - Opaque caller-provided identifier for the application actor associated with the session.
    createTime string
    (string) - Time when the session was created
    lastActivityTime string
    (string) - Time when the session's item history was last mutated
    metadata {[key: string]: string}
    (object) - Mutable caller-defined string labels
    name string
    (string) - Resource name in the form session-stores/{session_store_id}/sessions/{session_id}
    parentSessionId string
    (string) - Immediate parent session ID. Set only at creation for child sessions, immutable thereafter, and restricted to the same store
    rootSessionId string
    (string) - Top-level session ID in the spawn tree. This equals sessionId for a root or fork and is inherited transitively by child sessions
    sessionId string
    (string) - Unique session ID. The service generates a UUID unless the caller supplies CreateSessionRequest.session_id
    updateTime string
    (string) - Time when session resource fields last changed
    providerConfig GetAgentKitSessionsSessionProviderConfig
    Configure the provider for management through account provider.
    actor_id str
    (string) - Opaque caller-provided identifier for the application actor associated with the session.
    create_time str
    (string) - Time when the session was created
    last_activity_time str
    (string) - Time when the session's item history was last mutated
    metadata Mapping[str, str]
    (object) - Mutable caller-defined string labels
    name str
    (string) - Resource name in the form session-stores/{session_store_id}/sessions/{session_id}
    parent_session_id str
    (string) - Immediate parent session ID. Set only at creation for child sessions, immutable thereafter, and restricted to the same store
    root_session_id str
    (string) - Top-level session ID in the spawn tree. This equals sessionId for a root or fork and is inherited transitively by child sessions
    session_id str
    (string) - Unique session ID. The service generates a UUID unless the caller supplies CreateSessionRequest.session_id
    update_time str
    (string) - Time when session resource fields last changed
    provider_config GetAgentKitSessionsSessionProviderConfig
    Configure the provider for management through account provider.
    actorId String
    (string) - Opaque caller-provided identifier for the application actor associated with the session.
    createTime String
    (string) - Time when the session was created
    lastActivityTime String
    (string) - Time when the session's item history was last mutated
    metadata Map<String>
    (object) - Mutable caller-defined string labels
    name String
    (string) - Resource name in the form session-stores/{session_store_id}/sessions/{session_id}
    parentSessionId String
    (string) - Immediate parent session ID. Set only at creation for child sessions, immutable thereafter, and restricted to the same store
    rootSessionId String
    (string) - Top-level session ID in the spawn tree. This equals sessionId for a root or fork and is inherited transitively by child sessions
    sessionId String
    (string) - Unique session ID. The service generates a UUID unless the caller supplies CreateSessionRequest.session_id
    updateTime String
    (string) - Time when session resource fields last changed
    providerConfig Property Map
    Configure the provider for management through account provider.

    GetAgentKitSessionsSessionProviderConfig

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id str
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo databricks logo
    Viewing docs for Databricks v1.118.1
    published on Tuesday, Oct 27, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial