Class: Aws::DataZone::Types::StartNotebookRunInput

Inherits:

Struct

• Object
• Struct
• Aws::DataZone::Types::StartNotebookRunInput

Defined in:

gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:metadata, :parameters]

Instance Attribute Summary

• #client_token ⇒ String

  A unique, case-sensitive identifier to ensure idempotency of the request.

• #compute_configuration ⇒ Types::ComputeConfig

  The compute configuration for the notebook run, including instance type and environment version.

• #domain_identifier ⇒ String

  The identifier of the Amazon SageMaker Unified Studio domain in which the notebook run is started.

• #metadata ⇒ Hash<String,String>

  The metadata for the notebook run, specified as key-value pairs.

• #network_configuration ⇒ Types::NetworkConfig

  The network configuration for the notebook run, including network access type and optional VPC settings.

• #notebook_identifier ⇒ String

  The identifier of the notebook to run.

• #notification_configuration ⇒ Types::NotificationConfig

  The notification configuration for the notebook run.

• #owning_project_identifier ⇒ String

  The identifier of the project that owns the notebook run.

• #parameters ⇒ Hash<String,String>

  The sensitive parameters for the notebook run, specified as key-value pairs.

• #schedule_identifier ⇒ String

  The identifier of the schedule associated with the notebook run.

• #timeout_configuration ⇒ Types::TimeoutConfig

  The timeout configuration for the notebook run.

• #trigger_source ⇒ Types::TriggerSource

  The source that triggered the notebook run.

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 22017

class StartNotebookRunInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :notebook_identifier,
  :schedule_identifier,
  :compute_configuration,
  :network_configuration,
  :timeout_configuration,
  :notification_configuration,
  :trigger_source,
  :metadata,
  :parameters,
  :client_token)
  SENSITIVE = [:metadata, :parameters]
  include Aws::Structure
end

#compute_configuration ⇒ Types::ComputeConfig

The compute configuration for the notebook run, including instance type and environment version.

Returns:

• (Types::ComputeConfig)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 22017

class StartNotebookRunInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :notebook_identifier,
  :schedule_identifier,
  :compute_configuration,
  :network_configuration,
  :timeout_configuration,
  :notification_configuration,
  :trigger_source,
  :metadata,
  :parameters,
  :client_token)
  SENSITIVE = [:metadata, :parameters]
  include Aws::Structure
end

#domain_identifier ⇒ String

The identifier of the Amazon SageMaker Unified Studio domain in which the notebook run is started.

Returns:

• (String)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 22017

class StartNotebookRunInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :notebook_identifier,
  :schedule_identifier,
  :compute_configuration,
  :network_configuration,
  :timeout_configuration,
  :notification_configuration,
  :trigger_source,
  :metadata,
  :parameters,
  :client_token)
  SENSITIVE = [:metadata, :parameters]
  include Aws::Structure
end

#metadata ⇒ Hash<String,String>

The metadata for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 22017

class StartNotebookRunInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :notebook_identifier,
  :schedule_identifier,
  :compute_configuration,
  :network_configuration,
  :timeout_configuration,
  :notification_configuration,
  :trigger_source,
  :metadata,
  :parameters,
  :client_token)
  SENSITIVE = [:metadata, :parameters]
  include Aws::Structure
end

#network_configuration ⇒ Types::NetworkConfig

The network configuration for the notebook run, including network access type and optional VPC settings.

Returns:

• (Types::NetworkConfig)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 22017

class StartNotebookRunInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :notebook_identifier,
  :schedule_identifier,
  :compute_configuration,
  :network_configuration,
  :timeout_configuration,
  :notification_configuration,
  :trigger_source,
  :metadata,
  :parameters,
  :client_token)
  SENSITIVE = [:metadata, :parameters]
  include Aws::Structure
end

#notebook_identifier ⇒ String

The identifier of the notebook to run.

Returns:

• (String)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 22017

class StartNotebookRunInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :notebook_identifier,
  :schedule_identifier,
  :compute_configuration,
  :network_configuration,
  :timeout_configuration,
  :notification_configuration,
  :trigger_source,
  :metadata,
  :parameters,
  :client_token)
  SENSITIVE = [:metadata, :parameters]
  include Aws::Structure
end

#notification_configuration ⇒ Types::NotificationConfig

The notification configuration for the notebook run. Use this to specify the notebook run states that trigger notifications.

Returns:

• (Types::NotificationConfig)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 22017

class StartNotebookRunInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :notebook_identifier,
  :schedule_identifier,
  :compute_configuration,
  :network_configuration,
  :timeout_configuration,
  :notification_configuration,
  :trigger_source,
  :metadata,
  :parameters,
  :client_token)
  SENSITIVE = [:metadata, :parameters]
  include Aws::Structure
end

#owning_project_identifier ⇒ String

The identifier of the project that owns the notebook run.

Returns:

• (String)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 22017

class StartNotebookRunInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :notebook_identifier,
  :schedule_identifier,
  :compute_configuration,
  :network_configuration,
  :timeout_configuration,
  :notification_configuration,
  :trigger_source,
  :metadata,
  :parameters,
  :client_token)
  SENSITIVE = [:metadata, :parameters]
  include Aws::Structure
end

#parameters ⇒ Hash<String,String>

The sensitive parameters for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 22017

class StartNotebookRunInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :notebook_identifier,
  :schedule_identifier,
  :compute_configuration,
  :network_configuration,
  :timeout_configuration,
  :notification_configuration,
  :trigger_source,
  :metadata,
  :parameters,
  :client_token)
  SENSITIVE = [:metadata, :parameters]
  include Aws::Structure
end

#schedule_identifier ⇒ String

The identifier of the schedule associated with the notebook run.

Returns:

• (String)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 22017

class StartNotebookRunInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :notebook_identifier,
  :schedule_identifier,
  :compute_configuration,
  :network_configuration,
  :timeout_configuration,
  :notification_configuration,
  :trigger_source,
  :metadata,
  :parameters,
  :client_token)
  SENSITIVE = [:metadata, :parameters]
  include Aws::Structure
end

#timeout_configuration ⇒ Types::TimeoutConfig

The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).

Returns:

• (Types::TimeoutConfig)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 22017

class StartNotebookRunInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :notebook_identifier,
  :schedule_identifier,
  :compute_configuration,
  :network_configuration,
  :timeout_configuration,
  :notification_configuration,
  :trigger_source,
  :metadata,
  :parameters,
  :client_token)
  SENSITIVE = [:metadata, :parameters]
  include Aws::Structure
end

#trigger_source ⇒ Types::TriggerSource

The source that triggered the notebook run.

Returns:

• (Types::TriggerSource)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 22017

class StartNotebookRunInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :notebook_identifier,
  :schedule_identifier,
  :compute_configuration,
  :network_configuration,
  :timeout_configuration,
  :notification_configuration,
  :trigger_source,
  :metadata,
  :parameters,
  :client_token)
  SENSITIVE = [:metadata, :parameters]
  include Aws::Structure
end