Class: Aws::DataZone::Types::StartNotebookSyncInput

Inherits:

Struct

• Object
• Struct
• Aws::DataZone::Types::StartNotebookSyncInput

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:name, :description]

Instance Attribute Summary

• #client_token ⇒ String

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

• #description ⇒ String

  The description of the notebook.

• #domain_identifier ⇒ String

  The identifier of the Amazon SageMaker Unified Studio domain in which to sync the notebook.

• #git_metadata ⇒ Types::GitMetadata

  The Git metadata for the notebook sync, including repository, branch, and commit information.

• #name ⇒ String

  The name of the notebook.

• #notebook_id ⇒ String

  The identifier of an existing notebook to sync.

• #owning_project_identifier ⇒ String

  The identifier of the project that will own the synced notebook.

• #source_location ⇒ Types::SourceLocation

  The source location of the notebook to sync.

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 22134

class StartNotebookSyncInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :source_location,
  :git_metadata,
  :notebook_id,
  :name,
  :description,
  :client_token)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#description ⇒ String

The description of the notebook.

Returns:

• (String)

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

class StartNotebookSyncInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :source_location,
  :git_metadata,
  :notebook_id,
  :name,
  :description,
  :client_token)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#domain_identifier ⇒ String

The identifier of the Amazon SageMaker Unified Studio domain in which to sync the notebook.

Returns:

• (String)

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

class StartNotebookSyncInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :source_location,
  :git_metadata,
  :notebook_id,
  :name,
  :description,
  :client_token)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#git_metadata ⇒ Types::GitMetadata

The Git metadata for the notebook sync, including repository, branch, and commit information.

Returns:

• (Types::GitMetadata)

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

class StartNotebookSyncInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :source_location,
  :git_metadata,
  :notebook_id,
  :name,
  :description,
  :client_token)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#name ⇒ String

The name of the notebook. The name must be between 1 and 256 characters.

Returns:

• (String)

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

class StartNotebookSyncInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :source_location,
  :git_metadata,
  :notebook_id,
  :name,
  :description,
  :client_token)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#notebook_id ⇒ String

The identifier of an existing notebook to sync. If not specified, a new notebook is created.

Returns:

• (String)

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

class StartNotebookSyncInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :source_location,
  :git_metadata,
  :notebook_id,
  :name,
  :description,
  :client_token)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#owning_project_identifier ⇒ String

The identifier of the project that will own the synced notebook.

Returns:

• (String)

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

class StartNotebookSyncInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :source_location,
  :git_metadata,
  :notebook_id,
  :name,
  :description,
  :client_token)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#source_location ⇒ Types::SourceLocation

The source location of the notebook to sync. This specifies the Amazon Simple Storage Service URI of the notebook file.

Returns:

• (Types::SourceLocation)

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

class StartNotebookSyncInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :source_location,
  :git_metadata,
  :notebook_id,
  :name,
  :description,
  :client_token)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end