You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ChannelSpecification as input to an Aws::Client method, you can use a vanilla 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:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A brief description of the channel.

Returns:

  • (String) —

    A brief description of the channel.

#is_required ⇒ Boolean

Indicates whether the channel is required by the algorithm.

Returns:

  • (Boolean) —

    Indicates whether the channel is required by the algorithm.

#name ⇒ String

The name of the channel.

Returns:

  • (String) —

    The name of the channel.

#supported_compression_types ⇒ Array<String>

The allowed compression types, if data compression is used.

Returns:

  • (Array<String>) —

    The allowed compression types, if data compression is used.

#supported_content_types ⇒ Array<String>

The supported MIME types for the data.

Returns:

  • (Array<String>) —

    The supported MIME types for the data.

#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>) —

    The allowed input mode, either FILE or PIPE.