Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getNotebookSession

This data source provides details about a specific Notebook Session resource in Oracle Cloud Infrastructure Data Science service.

Gets the specified notebook session’s information.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testNotebookSession = Output.Create(Oci.DataScience.GetNotebookSession.InvokeAsync(new Oci.DataScience.GetNotebookSessionArgs
        {
            NotebookSessionId = oci_datascience_notebook_session.Test_notebook_session.Id,
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataScience.GetNotebookSession(ctx, &datascience.GetNotebookSessionArgs{
			NotebookSessionId: oci_datascience_notebook_session.Test_notebook_session.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_notebook_session = oci.DataScience.get_notebook_session(notebook_session_id=oci_datascience_notebook_session["test_notebook_session"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testNotebookSession = oci.DataScience.getNotebookSession({
    notebookSessionId: oci_datascience_notebook_session.test_notebook_session.id,
});

Coming soon!

Using getNotebookSession

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 getNotebookSession(args: GetNotebookSessionArgs, opts?: InvokeOptions): Promise<GetNotebookSessionResult>
function getNotebookSessionOutput(args: GetNotebookSessionOutputArgs, opts?: InvokeOptions): Output<GetNotebookSessionResult>
def get_notebook_session(notebook_session_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetNotebookSessionResult
def get_notebook_session_output(notebook_session_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetNotebookSessionResult]
func GetNotebookSession(ctx *Context, args *GetNotebookSessionArgs, opts ...InvokeOption) (*GetNotebookSessionResult, error)
func GetNotebookSessionOutput(ctx *Context, args *GetNotebookSessionOutputArgs, opts ...InvokeOption) GetNotebookSessionResultOutput

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

public static class GetNotebookSession 
{
    public static Task<GetNotebookSessionResult> InvokeAsync(GetNotebookSessionArgs args, InvokeOptions? opts = null)
    public static Output<GetNotebookSessionResult> Invoke(GetNotebookSessionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetNotebookSessionResult> getNotebookSession(GetNotebookSessionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:DataScience/getNotebookSession:getNotebookSession
  Arguments:
    # Arguments dictionary

The following arguments are supported:

NotebookSessionId string

The OCID of the notebook session.

NotebookSessionId string

The OCID of the notebook session.

notebookSessionId String

The OCID of the notebook session.

notebookSessionId string

The OCID of the notebook session.

notebook_session_id str

The OCID of the notebook session.

notebookSessionId String

The OCID of the notebook session.

getNotebookSession Result

The following output properties are available:

CompartmentId string

The OCID of the notebook session's compartment.

CreatedBy string

The OCID of the user who created the notebook session.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: My NotebookSession

FreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

Id string

The OCID of the notebook session.

LifecycleDetails string

Details about the state of the notebook session.

NotebookSessionConfigDetails List<GetNotebookSessionNotebookSessionConfigDetail>

Details for the notebook session configuration.

NotebookSessionConfigurationDetails List<GetNotebookSessionNotebookSessionConfigurationDetail>

Details for the notebook session configuration.

NotebookSessionId string
NotebookSessionUrl string

The URL to interact with the notebook session.

ProjectId string

The OCID of the project associated with the notebook session.

State string

The state of the notebook session.

TimeCreated string

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

CompartmentId string

The OCID of the notebook session's compartment.

CreatedBy string

The OCID of the user who created the notebook session.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: My NotebookSession

FreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

Id string

The OCID of the notebook session.

LifecycleDetails string

Details about the state of the notebook session.

NotebookSessionConfigDetails []GetNotebookSessionNotebookSessionConfigDetail

Details for the notebook session configuration.

NotebookSessionConfigurationDetails []GetNotebookSessionNotebookSessionConfigurationDetail

Details for the notebook session configuration.

NotebookSessionId string
NotebookSessionUrl string

The URL to interact with the notebook session.

ProjectId string

The OCID of the project associated with the notebook session.

State string

The state of the notebook session.

TimeCreated string

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

compartmentId String

The OCID of the notebook session's compartment.

createdBy String

The OCID of the user who created the notebook session.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: My NotebookSession

freeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

id String

The OCID of the notebook session.

lifecycleDetails String

Details about the state of the notebook session.

notebookSessionConfigDetails List<GetNotebookSessionNotebookSessionConfigDetail>

Details for the notebook session configuration.

notebookSessionConfigurationDetails List<GetNotebookSessionNotebookSessionConfigurationDetail>

Details for the notebook session configuration.

notebookSessionId String
notebookSessionUrl String

The URL to interact with the notebook session.

projectId String

The OCID of the project associated with the notebook session.

state String

The state of the notebook session.

timeCreated String

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

compartmentId string

The OCID of the notebook session's compartment.

createdBy string

The OCID of the user who created the notebook session.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: My NotebookSession

freeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

id string

The OCID of the notebook session.

lifecycleDetails string

Details about the state of the notebook session.

notebookSessionConfigDetails GetNotebookSessionNotebookSessionConfigDetail[]

Details for the notebook session configuration.

notebookSessionConfigurationDetails GetNotebookSessionNotebookSessionConfigurationDetail[]

Details for the notebook session configuration.

notebookSessionId string
notebookSessionUrl string

The URL to interact with the notebook session.

projectId string

The OCID of the project associated with the notebook session.

state string

The state of the notebook session.

timeCreated string

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

compartment_id str

The OCID of the notebook session's compartment.

created_by str

The OCID of the user who created the notebook session.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: My NotebookSession

freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

id str

The OCID of the notebook session.

lifecycle_details str

Details about the state of the notebook session.

notebook_session_config_details GetNotebookSessionNotebookSessionConfigDetail]

Details for the notebook session configuration.

notebook_session_configuration_details GetNotebookSessionNotebookSessionConfigurationDetail]

Details for the notebook session configuration.

notebook_session_id str
notebook_session_url str

The URL to interact with the notebook session.

project_id str

The OCID of the project associated with the notebook session.

state str

The state of the notebook session.

time_created str

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

compartmentId String

The OCID of the notebook session's compartment.

createdBy String

The OCID of the user who created the notebook session.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: My NotebookSession

freeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

id String

The OCID of the notebook session.

lifecycleDetails String

Details about the state of the notebook session.

notebookSessionConfigDetails List<Property Map>

Details for the notebook session configuration.

notebookSessionConfigurationDetails List<Property Map>

Details for the notebook session configuration.

notebookSessionId String
notebookSessionUrl String

The URL to interact with the notebook session.

projectId String

The OCID of the project associated with the notebook session.

state String

The state of the notebook session.

timeCreated String

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

Supporting Types

GetNotebookSessionNotebookSessionConfigDetail

BlockStorageSizeInGbs int

A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.

NotebookSessionShapeConfigDetails List<GetNotebookSessionNotebookSessionConfigDetailNotebookSessionShapeConfigDetail>

Details for the notebook session shape configuration.

Shape string

The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the ListNotebookSessionShapes endpoint.

SubnetId string

A notebook session instance is provided with a VNIC for network access. This specifies the OCID of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet.

BlockStorageSizeInGbs int

A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.

NotebookSessionShapeConfigDetails []GetNotebookSessionNotebookSessionConfigDetailNotebookSessionShapeConfigDetail

Details for the notebook session shape configuration.

Shape string

The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the ListNotebookSessionShapes endpoint.

SubnetId string

A notebook session instance is provided with a VNIC for network access. This specifies the OCID of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet.

blockStorageSizeInGbs Integer

A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.

notebookSessionShapeConfigDetails List<GetNotebookSessionNotebookSessionConfigDetailNotebookSessionShapeConfigDetail>

Details for the notebook session shape configuration.

shape String

The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the ListNotebookSessionShapes endpoint.

subnetId String

A notebook session instance is provided with a VNIC for network access. This specifies the OCID of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet.

blockStorageSizeInGbs number

A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.

notebookSessionShapeConfigDetails GetNotebookSessionNotebookSessionConfigDetailNotebookSessionShapeConfigDetail[]

Details for the notebook session shape configuration.

shape string

The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the ListNotebookSessionShapes endpoint.

subnetId string

A notebook session instance is provided with a VNIC for network access. This specifies the OCID of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet.

block_storage_size_in_gbs int

A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.

notebook_session_shape_config_details GetNotebookSessionNotebookSessionConfigDetailNotebookSessionShapeConfigDetail]

Details for the notebook session shape configuration.

shape str

The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the ListNotebookSessionShapes endpoint.

subnet_id str

A notebook session instance is provided with a VNIC for network access. This specifies the OCID of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet.

blockStorageSizeInGbs Number

A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.

notebookSessionShapeConfigDetails List<Property Map>

Details for the notebook session shape configuration.

shape String

The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the ListNotebookSessionShapes endpoint.

subnetId String

A notebook session instance is provided with a VNIC for network access. This specifies the OCID of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet.

GetNotebookSessionNotebookSessionConfigDetailNotebookSessionShapeConfigDetail

MemoryInGbs double

A notebook session instance of type VM.Standard.E3.Flex allows memory to be specified. This specifies the size of the memory in GBs.

Ocpus double

A notebook session instance of type VM.Standard.E3.Flex allows the ocpu count to be specified.

MemoryInGbs float64

A notebook session instance of type VM.Standard.E3.Flex allows memory to be specified. This specifies the size of the memory in GBs.

Ocpus float64

A notebook session instance of type VM.Standard.E3.Flex allows the ocpu count to be specified.

memoryInGbs Double

A notebook session instance of type VM.Standard.E3.Flex allows memory to be specified. This specifies the size of the memory in GBs.

ocpus Double

A notebook session instance of type VM.Standard.E3.Flex allows the ocpu count to be specified.

memoryInGbs number

A notebook session instance of type VM.Standard.E3.Flex allows memory to be specified. This specifies the size of the memory in GBs.

ocpus number

A notebook session instance of type VM.Standard.E3.Flex allows the ocpu count to be specified.

memory_in_gbs float

A notebook session instance of type VM.Standard.E3.Flex allows memory to be specified. This specifies the size of the memory in GBs.

ocpus float

A notebook session instance of type VM.Standard.E3.Flex allows the ocpu count to be specified.

memoryInGbs Number

A notebook session instance of type VM.Standard.E3.Flex allows memory to be specified. This specifies the size of the memory in GBs.

ocpus Number

A notebook session instance of type VM.Standard.E3.Flex allows the ocpu count to be specified.

GetNotebookSessionNotebookSessionConfigurationDetail

BlockStorageSizeInGbs int

A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.

NotebookSessionShapeConfigDetails List<GetNotebookSessionNotebookSessionConfigurationDetailNotebookSessionShapeConfigDetail>

Details for the notebook session shape configuration.

Shape string

The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the ListNotebookSessionShapes endpoint.

SubnetId string

A notebook session instance is provided with a VNIC for network access. This specifies the OCID of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet.

BlockStorageSizeInGbs int

A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.

NotebookSessionShapeConfigDetails []GetNotebookSessionNotebookSessionConfigurationDetailNotebookSessionShapeConfigDetail

Details for the notebook session shape configuration.

Shape string

The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the ListNotebookSessionShapes endpoint.

SubnetId string

A notebook session instance is provided with a VNIC for network access. This specifies the OCID of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet.

blockStorageSizeInGbs Integer

A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.

notebookSessionShapeConfigDetails List<GetNotebookSessionNotebookSessionConfigurationDetailNotebookSessionShapeConfigDetail>

Details for the notebook session shape configuration.

shape String

The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the ListNotebookSessionShapes endpoint.

subnetId String

A notebook session instance is provided with a VNIC for network access. This specifies the OCID of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet.

blockStorageSizeInGbs number

A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.

notebookSessionShapeConfigDetails GetNotebookSessionNotebookSessionConfigurationDetailNotebookSessionShapeConfigDetail[]

Details for the notebook session shape configuration.

shape string

The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the ListNotebookSessionShapes endpoint.

subnetId string

A notebook session instance is provided with a VNIC for network access. This specifies the OCID of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet.

block_storage_size_in_gbs int

A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.

notebook_session_shape_config_details GetNotebookSessionNotebookSessionConfigurationDetailNotebookSessionShapeConfigDetail]

Details for the notebook session shape configuration.

shape str

The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the ListNotebookSessionShapes endpoint.

subnet_id str

A notebook session instance is provided with a VNIC for network access. This specifies the OCID of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet.

blockStorageSizeInGbs Number

A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.

notebookSessionShapeConfigDetails List<Property Map>

Details for the notebook session shape configuration.

shape String

The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the ListNotebookSessionShapes endpoint.

subnetId String

A notebook session instance is provided with a VNIC for network access. This specifies the OCID of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet.

GetNotebookSessionNotebookSessionConfigurationDetailNotebookSessionShapeConfigDetail

MemoryInGbs double

A notebook session instance of type VM.Standard.E3.Flex allows memory to be specified. This specifies the size of the memory in GBs.

Ocpus double

A notebook session instance of type VM.Standard.E3.Flex allows the ocpu count to be specified.

MemoryInGbs float64

A notebook session instance of type VM.Standard.E3.Flex allows memory to be specified. This specifies the size of the memory in GBs.

Ocpus float64

A notebook session instance of type VM.Standard.E3.Flex allows the ocpu count to be specified.

memoryInGbs Double

A notebook session instance of type VM.Standard.E3.Flex allows memory to be specified. This specifies the size of the memory in GBs.

ocpus Double

A notebook session instance of type VM.Standard.E3.Flex allows the ocpu count to be specified.

memoryInGbs number

A notebook session instance of type VM.Standard.E3.Flex allows memory to be specified. This specifies the size of the memory in GBs.

ocpus number

A notebook session instance of type VM.Standard.E3.Flex allows the ocpu count to be specified.

memory_in_gbs float

A notebook session instance of type VM.Standard.E3.Flex allows memory to be specified. This specifies the size of the memory in GBs.

ocpus float

A notebook session instance of type VM.Standard.E3.Flex allows the ocpu count to be specified.

memoryInGbs Number

A notebook session instance of type VM.Standard.E3.Flex allows memory to be specified. This specifies the size of the memory in GBs.

ocpus Number

A notebook session instance of type VM.Standard.E3.Flex allows the ocpu count to be specified.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.