ChannelSpecification - Amazon SageMaker


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



The name of the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9\.\-_]+

Required: Yes


The supported MIME types for the data.

Type: Array of strings

Length Constraints: Maximum length of 256.

Pattern: .*

Required: Yes


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.

Type: Array of strings

Array Members: Minimum number of 1 item.

Valid Values: Pipe | File | FastFile

Required: Yes


A brief description of the channel.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*

Required: No


Indicates whether the channel is required by the algorithm.

Type: Boolean

Required: No


The allowed compression types, if data compression is used.

Type: Array of strings

Valid Values: None | Gzip

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: