Class: Aws::SageMaker::Types::ChannelSpecification

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::ChannelSpecification

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass ChannelSpecification data as a hash:

{
  name: "ChannelName", # required
  description: "EntityDescription",
  is_required: false,
  supported_content_types: ["ContentType"], # required
  supported_compression_types: ["None"], # accepts None, Gzip
  supported_input_modes: ["Pipe"], # required, accepts Pipe, File
}

Defines a named input source, called a channel, to be used by an algorithm.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #description ⇒ String

  A brief description of the channel.

• #is_required ⇒ Boolean

  Indicates whether the channel is required by the algorithm.

• #name ⇒ String

  The name of the channel.

• #supported_compression_types ⇒ Array<String>

  The allowed compression types, if data compression is used.

• #supported_content_types ⇒ Array<String>

  The supported MIME types for the data.

• #supported_input_modes ⇒ Array<String>

  The allowed input mode, either FILE or PIPE.

Instance Attribute Details

#description ⇒ String

A brief description of the channel.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 1523

class ChannelSpecification < Struct.new(
  :name,
  :description,
  :is_required,
  :supported_content_types,
  :supported_compression_types,
  :supported_input_modes)
  include Aws::Structure
end

#is_required ⇒ Boolean

Indicates whether the channel is required by the algorithm.

Returns:

• (Boolean)

# File 'lib/aws-sdk-sagemaker/types.rb', line 1523

class ChannelSpecification < Struct.new(
  :name,
  :description,
  :is_required,
  :supported_content_types,
  :supported_compression_types,
  :supported_input_modes)
  include Aws::Structure
end

#name ⇒ String

The name of the channel.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 1523

class ChannelSpecification < Struct.new(
  :name,
  :description,
  :is_required,
  :supported_content_types,
  :supported_compression_types,
  :supported_input_modes)
  include Aws::Structure
end

#supported_compression_types ⇒ Array<String>

The allowed compression types, if data compression is used.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 1523

class ChannelSpecification < Struct.new(
  :name,
  :description,
  :is_required,
  :supported_content_types,
  :supported_compression_types,
  :supported_input_modes)
  include Aws::Structure
end

#supported_content_types ⇒ Array<String>

The supported MIME types for the data.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 1523

class ChannelSpecification < Struct.new(
  :name,
  :description,
  :is_required,
  :supported_content_types,
  :supported_compression_types,
  :supported_input_modes)
  include Aws::Structure
end

#supported_input_modes ⇒ Array<String>

The allowed input mode, either FILE or PIPE.

In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 1523

class ChannelSpecification < Struct.new(
  :name,
  :description,
  :is_required,
  :supported_content_types,
  :supported_compression_types,
  :supported_input_modes)
  include Aws::Structure
end