Viewing docs for Databricks v1.118.1
published on Tuesday, Oct 27, 2026 by Pulumi
published on Tuesday, Oct 27, 2026 by Pulumi
Viewing docs for Databricks v1.118.1
published on Tuesday, Oct 27, 2026 by Pulumi
published on Tuesday, Oct 27, 2026 by Pulumi
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 dictionarydata "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
actorIdandmetadata; for example,actorId = "support-customer-123" - Order
By string - Sort order. Defaults to
lastActivityTime desc. Page-token continuation is exactly-once when ordering bycreateTime(immutable); ordering bylastActivityTimeis 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 bycreateTime - Page
Size int - Maximum number of sessions to return. Defaults to 10; must be between 1 and 100
- Provider
Config GetAgent Kit Sessions Provider Config - 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
actorIdandmetadata; for example,actorId = "support-customer-123" - Order
By string - Sort order. Defaults to
lastActivityTime desc. Page-token continuation is exactly-once when ordering bycreateTime(immutable); ordering bylastActivityTimeis 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 bycreateTime - Page
Size int - Maximum number of sessions to return. Defaults to 10; must be between 1 and 100
- Provider
Config GetAgent Kit Sessions Provider Config - 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
actorIdandmetadata; for example,actorId = "support-customer-123" - order_
by string - Sort order. Defaults to
lastActivityTime desc. Page-token continuation is exactly-once when ordering bycreateTime(immutable); ordering bylastActivityTimeis 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 bycreateTime - 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
actorIdandmetadata; for example,actorId = "support-customer-123" - order
By String - Sort order. Defaults to
lastActivityTime desc. Page-token continuation is exactly-once when ordering bycreateTime(immutable); ordering bylastActivityTimeis 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 bycreateTime - page
Size Integer - Maximum number of sessions to return. Defaults to 10; must be between 1 and 100
- provider
Config GetAgent Kit Sessions Provider Config - 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
actorIdandmetadata; for example,actorId = "support-customer-123" - order
By string - Sort order. Defaults to
lastActivityTime desc. Page-token continuation is exactly-once when ordering bycreateTime(immutable); ordering bylastActivityTimeis 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 bycreateTime - page
Size number - Maximum number of sessions to return. Defaults to 10; must be between 1 and 100
- provider
Config GetAgent Kit Sessions Provider Config - 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
actorIdandmetadata; for example,actorId = "support-customer-123" - order_
by str - Sort order. Defaults to
lastActivityTime desc. Page-token continuation is exactly-once when ordering bycreateTime(immutable); ordering bylastActivityTimeis 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 bycreateTime - page_
size int - Maximum number of sessions to return. Defaults to 10; must be between 1 and 100
- provider_
config GetAgent Kit Sessions Provider Config - 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
actorIdandmetadata; for example,actorId = "support-customer-123" - order
By String - Sort order. Defaults to
lastActivityTime desc. Page-token continuation is exactly-once when ordering bycreateTime(immutable); ordering bylastActivityTimeis 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 bycreateTime - page
Size Number - Maximum number of sessions to return. Defaults to 10; must be between 1 and 100
- provider
Config Property Map - Configure the provider for management through account provider.
getAgentKitSessions Result
The following output properties are available:
- parent string
- sessions list(object)
- filter string
- order_
by string - page_
size number - provider_
config object
- parent String
- sessions
List<Get
Agent Kit Sessions Session> - filter String
- order
By String - page
Size Integer - provider
Config GetAgent Kit Sessions Provider Config
- parent string
- sessions
Get
Agent Kit Sessions Session[] - filter string
- order
By string - page
Size number - provider
Config GetAgent Kit Sessions Provider Config
- parent String
- sessions List<Property Map>
- filter String
- order
By String - page
Size Number - provider
Config Property Map
Supporting Types
GetAgentKitSessionsProviderConfig
- Workspace
Id 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.
- workspace_
id 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.
- workspace
Id 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.
- workspace
Id String - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
GetAgentKitSessionsSession
- 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 stringTime - (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} - Parent
Session stringId - (string) - Immediate parent session ID. Set only at creation for child sessions, immutable thereafter, and restricted to the same store
- Root
Session stringId - (string) - Top-level session ID in the spawn tree. This equals
sessionIdfor 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 GetAgent Kit Sessions Session Provider Config - 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 stringTime - (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} - Parent
Session stringId - (string) - Immediate parent session ID. Set only at creation for child sessions, immutable thereafter, and restricted to the same store
- Root
Session stringId - (string) - Top-level session ID in the spawn tree. This equals
sessionIdfor 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 GetAgent Kit Sessions Session Provider Config - 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_ stringtime - (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_ stringid - (string) - Immediate parent session ID. Set only at creation for child sessions, immutable thereafter, and restricted to the same store
- root_
session_ stringid - (string) - Top-level session ID in the spawn tree. This equals
sessionIdfor 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.
- 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 StringTime - (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} - parent
Session StringId - (string) - Immediate parent session ID. Set only at creation for child sessions, immutable thereafter, and restricted to the same store
- root
Session StringId - (string) - Top-level session ID in the spawn tree. This equals
sessionIdfor 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 GetAgent Kit Sessions Session Provider Config - 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 stringTime - (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} - parent
Session stringId - (string) - Immediate parent session ID. Set only at creation for child sessions, immutable thereafter, and restricted to the same store
- root
Session stringId - (string) - Top-level session ID in the spawn tree. This equals
sessionIdfor 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 GetAgent Kit Sessions Session Provider Config - 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_ strtime - (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_ strid - (string) - Immediate parent session ID. Set only at creation for child sessions, immutable thereafter, and restricted to the same store
- root_
session_ strid - (string) - Top-level session ID in the spawn tree. This equals
sessionIdfor 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 GetAgent Kit Sessions Session Provider Config - 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 StringTime - (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 StringId - (string) - Immediate parent session ID. Set only at creation for child sessions, immutable thereafter, and restricted to the same store
- root
Session StringId - (string) - Top-level session ID in the spawn tree. This equals
sessionIdfor 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 Property Map - Configure the provider for management through account provider.
GetAgentKitSessionsSessionProviderConfig
- Workspace
Id 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.
- workspace_
id 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.
- workspace
Id 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.
- workspace
Id 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
databricksTerraform Provider.
Viewing docs for Databricks v1.118.1
published on Tuesday, Oct 27, 2026 by Pulumi
published on Tuesday, Oct 27, 2026 by Pulumi