Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. sagemaker
  6. getNotebookInstance

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.sagemaker.getNotebookInstance

aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::SageMaker::NotebookInstance

    Using getNotebookInstance

    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 getNotebookInstance(args: GetNotebookInstanceArgs, opts?: InvokeOptions): Promise<GetNotebookInstanceResult>
function getNotebookInstanceOutput(args: GetNotebookInstanceOutputArgs, opts?: InvokeOutputOptions): Output<GetNotebookInstanceResult>
    def get_notebook_instance(notebook_instance_arn: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetNotebookInstanceResult
def get_notebook_instance_output(notebook_instance_arn: pulumi.Input[Optional[str]] = None,
                          opts: Optional[InvokeOutputOptions] = None) -> Output[GetNotebookInstanceResult]
    func LookupNotebookInstance(ctx *Context, args *LookupNotebookInstanceArgs, opts ...InvokeOption) (*LookupNotebookInstanceResult, error)
func LookupNotebookInstanceOutput(ctx *Context, args *LookupNotebookInstanceOutputArgs, opts ...InvokeOption) LookupNotebookInstanceResultOutput

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

    public static class GetNotebookInstance 
{
    public static Task<GetNotebookInstanceResult> InvokeAsync(GetNotebookInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetNotebookInstanceResult> Invoke(GetNotebookInstanceInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetNotebookInstanceResult> Invoke(GetNotebookInstanceInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetNotebookInstanceResult> getNotebookInstance(GetNotebookInstanceArgs args, InvokeOptions options)
public static Output<GetNotebookInstanceResult> getNotebookInstance(GetNotebookInstanceArgs args, InvokeOptions options)
public static Output<GetNotebookInstanceResult> getNotebookInstance(GetNotebookInstanceArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:sagemaker:getNotebookInstance
  arguments:
    # arguments dictionary
    data "aws-native_sagemaker_get_notebook_instance" "name" {
    # arguments
}

    The following arguments are supported:

    NotebookInstanceArn string
    The Amazon Resource Name (ARN) of the notebook instance.
    NotebookInstanceArn string
    The Amazon Resource Name (ARN) of the notebook instance.
    notebook_instance_arn string
    The Amazon Resource Name (ARN) of the notebook instance.
    notebookInstanceArn String
    The Amazon Resource Name (ARN) of the notebook instance.
    notebookInstanceArn string
    The Amazon Resource Name (ARN) of the notebook instance.
    notebook_instance_arn str
    The Amazon Resource Name (ARN) of the notebook instance.
    notebookInstanceArn String
    The Amazon Resource Name (ARN) of the notebook instance.

    getNotebookInstance Result

    The following output properties are available:

    AcceleratorTypes List<string>
    A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance.
    AdditionalCodeRepositories List<string>
    An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance.
    DefaultCodeRepository string
    The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository.
    InstanceMetadataServiceConfiguration Pulumi.AwsNative.SageMaker.Outputs.NotebookInstanceInstanceMetadataServiceConfiguration
    Information on the IMDS configuration of the notebook instance.
    InstanceType string
    The type of ML compute instance to launch for the notebook instance. Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
    LifecycleConfigName string
    The name of a lifecycle configuration to associate with the notebook instance.
    NotebookInstanceArn string
    The Amazon Resource Name (ARN) of the notebook instance.
    RoleArn string
    When you send any requests to AWS resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission.
    RootAccess string
    Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled. Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of key-value pairs to apply to this resource.
    VolumeSizeInGb int
    The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
    AcceleratorTypes []string
    A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance.
    AdditionalCodeRepositories []string
    An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance.
    DefaultCodeRepository string
    The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository.
    InstanceMetadataServiceConfiguration NotebookInstanceInstanceMetadataServiceConfiguration
    Information on the IMDS configuration of the notebook instance.
    InstanceType string
    The type of ML compute instance to launch for the notebook instance. Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
    LifecycleConfigName string
    The name of a lifecycle configuration to associate with the notebook instance.
    NotebookInstanceArn string
    The Amazon Resource Name (ARN) of the notebook instance.
    RoleArn string
    When you send any requests to AWS resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission.
    RootAccess string
    Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled. Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
    Tags Tag
    A list of key-value pairs to apply to this resource.
    VolumeSizeInGb int
    The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
    accelerator_types list(string)
    A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance.
    additional_code_repositories list(string)
    An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance.
    default_code_repository string
    The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository.
    instance_metadata_service_configuration object
    Information on the IMDS configuration of the notebook instance.
    instance_type string
    The type of ML compute instance to launch for the notebook instance. Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
    lifecycle_config_name string
    The name of a lifecycle configuration to associate with the notebook instance.
    notebook_instance_arn string
    The Amazon Resource Name (ARN) of the notebook instance.
    role_arn string
    When you send any requests to AWS resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission.
    root_access string
    Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled. Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
    tags list(object)
    A list of key-value pairs to apply to this resource.
    volume_size_in_gb number
    The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
    acceleratorTypes List<String>
    A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance.
    additionalCodeRepositories List<String>
    An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance.
    defaultCodeRepository String
    The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository.
    instanceMetadataServiceConfiguration NotebookInstanceInstanceMetadataServiceConfiguration
    Information on the IMDS configuration of the notebook instance.
    instanceType String
    The type of ML compute instance to launch for the notebook instance. Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
    lifecycleConfigName String
    The name of a lifecycle configuration to associate with the notebook instance.
    notebookInstanceArn String
    The Amazon Resource Name (ARN) of the notebook instance.
    roleArn String
    When you send any requests to AWS resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission.
    rootAccess String
    Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled. Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
    tags List<Tag>
    A list of key-value pairs to apply to this resource.
    volumeSizeInGb Integer
    The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
    acceleratorTypes string[]
    A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance.
    additionalCodeRepositories string[]
    An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance.
    defaultCodeRepository string
    The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository.
    instanceMetadataServiceConfiguration NotebookInstanceInstanceMetadataServiceConfiguration
    Information on the IMDS configuration of the notebook instance.
    instanceType string
    The type of ML compute instance to launch for the notebook instance. Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
    lifecycleConfigName string
    The name of a lifecycle configuration to associate with the notebook instance.
    notebookInstanceArn string
    The Amazon Resource Name (ARN) of the notebook instance.
    roleArn string
    When you send any requests to AWS resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission.
    rootAccess string
    Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled. Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
    tags Tag[]
    A list of key-value pairs to apply to this resource.
    volumeSizeInGb number
    The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
    accelerator_types Sequence[str]
    A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance.
    additional_code_repositories Sequence[str]
    An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance.
    default_code_repository str
    The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository.
    instance_metadata_service_configuration NotebookInstanceInstanceMetadataServiceConfiguration
    Information on the IMDS configuration of the notebook instance.
    instance_type str
    The type of ML compute instance to launch for the notebook instance. Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
    lifecycle_config_name str
    The name of a lifecycle configuration to associate with the notebook instance.
    notebook_instance_arn str
    The Amazon Resource Name (ARN) of the notebook instance.
    role_arn str
    When you send any requests to AWS resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission.
    root_access str
    Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled. Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
    tags Sequence[root_Tag]
    A list of key-value pairs to apply to this resource.
    volume_size_in_gb int
    The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
    acceleratorTypes List<String>
    A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance.
    additionalCodeRepositories List<String>
    An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance.
    defaultCodeRepository String
    The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository.
    instanceMetadataServiceConfiguration Property Map
    Information on the IMDS configuration of the notebook instance.
    instanceType String
    The type of ML compute instance to launch for the notebook instance. Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
    lifecycleConfigName String
    The name of a lifecycle configuration to associate with the notebook instance.
    notebookInstanceArn String
    The Amazon Resource Name (ARN) of the notebook instance.
    roleArn String
    When you send any requests to AWS resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission.
    rootAccess String
    Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled. Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
    tags List<Property Map>
    A list of key-value pairs to apply to this resource.
    volumeSizeInGb Number
    The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.

    Supporting Types

    NotebookInstanceInstanceMetadataServiceConfiguration

    MinimumInstanceMetadataServiceVersion string
    Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.
    MinimumInstanceMetadataServiceVersion string
    Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.
    minimum_instance_metadata_service_version string
    Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.
    minimumInstanceMetadataServiceVersion String
    Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.
    minimumInstanceMetadataServiceVersion string
    Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.
    minimum_instance_metadata_service_version str
    Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.
    minimumInstanceMetadataServiceVersion String
    Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.81.0
    published on Monday, Sep 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial