Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.Types.ChannelSpecification

Description

Documentation

data ChannelSpecification Source #

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

See: newChannelSpecification smart constructor.

Constructors

ChannelSpecification'

Fields

supportedCompressionTypes :: Maybe [CompressionType]
The allowed compression types, if data compression is used.
isRequired :: Maybe Bool
Indicates whether the channel is required by the algorithm.
description :: Maybe Text
A brief description of the channel.
name :: Text
The name of the channel.
supportedContentTypes :: [Text]
The supported MIME types for the data.
supportedInputModes :: NonEmpty TrainingInputMode
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.

Instances

Instances details

Eq ChannelSpecification Source #
Instance details Defined in Amazonka.SageMaker.Types.ChannelSpecification Methods (==) :: ChannelSpecification -> ChannelSpecification -> Bool # (/=) :: ChannelSpecification -> ChannelSpecification -> Bool #
Read ChannelSpecification Source #
Instance details Defined in Amazonka.SageMaker.Types.ChannelSpecification Methods readsPrec :: Int -> ReadS ChannelSpecification # readList :: ReadS [ChannelSpecification] # readPrec :: ReadPrec ChannelSpecification # readListPrec :: ReadPrec [ChannelSpecification] #
Show ChannelSpecification Source #
Instance details Defined in Amazonka.SageMaker.Types.ChannelSpecification Methods showsPrec :: Int -> ChannelSpecification -> ShowS # show :: ChannelSpecification -> String # showList :: [ChannelSpecification] -> ShowS #
Generic ChannelSpecification Source #
Instance details Defined in Amazonka.SageMaker.Types.ChannelSpecification Associated Types type Rep ChannelSpecification :: Type -> Type # Methods from :: ChannelSpecification -> Rep ChannelSpecification x # to :: Rep ChannelSpecification x -> ChannelSpecification #
NFData ChannelSpecification Source #
Instance details Defined in Amazonka.SageMaker.Types.ChannelSpecification Methods rnf :: ChannelSpecification -> () #
Hashable ChannelSpecification Source #
Instance details Defined in Amazonka.SageMaker.Types.ChannelSpecification Methods hashWithSalt :: Int -> ChannelSpecification -> Int # hash :: ChannelSpecification -> Int #
ToJSON ChannelSpecification Source #
Instance details Defined in Amazonka.SageMaker.Types.ChannelSpecification Methods toJSON :: ChannelSpecification -> Value # toEncoding :: ChannelSpecification -> Encoding # toJSONList :: [ChannelSpecification] -> Value # toEncodingList :: [ChannelSpecification] -> Encoding #
FromJSON ChannelSpecification Source #
Instance details Defined in Amazonka.SageMaker.Types.ChannelSpecification Methods parseJSON :: Value -> Parser ChannelSpecification # parseJSONList :: Value -> Parser [ChannelSpecification] #
type Rep ChannelSpecification Source #
Instance details Defined in Amazonka.SageMaker.Types.ChannelSpecification type Rep ChannelSpecification = D1 ('MetaData "ChannelSpecification" "Amazonka.SageMaker.Types.ChannelSpecification" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "ChannelSpecification'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "supportedCompressionTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CompressionType])) :: (S1 ('MetaSel ('Just "isRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "supportedContentTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "supportedInputModes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty TrainingInputMode))))))

newChannelSpecification Source #

Arguments

:: Text	`$sel:name:ChannelSpecification'`
-> NonEmpty TrainingInputMode	`$sel:supportedInputModes:ChannelSpecification'`
-> ChannelSpecification

Create a value of ChannelSpecification with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:supportedCompressionTypes:ChannelSpecification', channelSpecification_supportedCompressionTypes - The allowed compression types, if data compression is used.

$sel:isRequired:ChannelSpecification', channelSpecification_isRequired - Indicates whether the channel is required by the algorithm.

$sel:description:ChannelSpecification', channelSpecification_description - A brief description of the channel.

$sel:name:ChannelSpecification', channelSpecification_name - The name of the channel.

$sel:supportedContentTypes:ChannelSpecification', channelSpecification_supportedContentTypes - The supported MIME types for the data.

$sel:supportedInputModes:ChannelSpecification', channelSpecification_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.

channelSpecification_supportedCompressionTypes :: Lens' ChannelSpecification (Maybe [CompressionType]) Source #

The allowed compression types, if data compression is used.

channelSpecification_isRequired :: Lens' ChannelSpecification (Maybe Bool) Source #

Indicates whether the channel is required by the algorithm.

channelSpecification_description :: Lens' ChannelSpecification (Maybe Text) Source #

A brief description of the channel.

channelSpecification_name :: Lens' ChannelSpecification Text Source #

The name of the channel.

channelSpecification_supportedContentTypes :: Lens' ChannelSpecification [Text] Source #

The supported MIME types for the data.

channelSpecification_supportedInputModes :: Lens' ChannelSpecification (NonEmpty TrainingInputMode) Source #

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.