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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/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, FastFile
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A brief description of the channel.

Returns:

  • (String)


3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3358

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

#is_requiredBoolean

Indicates whether the channel is required by the algorithm.

Returns:

  • (Boolean)


3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3358

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

#nameString

The name of the channel.

Returns:

  • (String)


3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3358

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

#supported_compression_typesArray<String>

The allowed compression types, if data compression is used.

Returns:

  • (Array<String>)


3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3358

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

#supported_content_typesArray<String>

The supported MIME types for the data.

Returns:

  • (Array<String>)


3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3358

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

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


3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3358

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