View a markdown version of this page

AWS::SageMaker::Algorithm ChannelSpecification - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::SageMaker::Algorithm ChannelSpecification

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Description" : String,
  "IsRequired" : Boolean,
  "Name" : String,
  "SupportedCompressionTypes" : [ String, ... ],
  "SupportedContentTypes" : [ String, ... ],
  "SupportedInputModes" : [ String, ... ]
}

YAML

  Description: String
  IsRequired: Boolean
  Name: String
  SupportedCompressionTypes: 
    - String
  SupportedContentTypes: 
    - String
  SupportedInputModes: 
    - String

Properties

Description

A brief description of the channel.

Required: No

Type: String

Maximum: 1024

Update requires: Replacement

IsRequired

Indicates whether the channel is required by the algorithm.

Required: No

Type: Boolean

Update requires: Replacement

Name

The name of the channel.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 64

Update requires: Replacement

SupportedCompressionTypes

The allowed compression types, if data compression is used.

Required: No

Type: Array of String

Allowed values: None | Gzip

Update requires: Replacement

SupportedContentTypes

The supported MIME types for the data.

Required: Yes

Type: Array of String

Maximum: 256

Update requires: Replacement

SupportedInputModes

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.

Required: Yes

Type: Array of String

Allowed values: Pipe | File | FastFile

Minimum: 1

Update requires: Replacement