Amazonka.Glue.Types.Spigot

Documentation

data Spigot

Specifies a transform that writes samples of the data to an Amazon S3 bucket.

See: newSpigot smart constructor.

Constructors

Spigot'

Fields

• prob :: Maybe Double

  The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.

• topk :: Maybe Natural

  Specifies a number of records to write starting from the beginning of the dataset.

• name :: Text

  The name of the transform node.

• inputs :: NonEmpty Text

  The data inputs identified by their node names.

• path :: Text

  A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.

Instances

FromJSON Spigot

Defined in Amazonka.Glue.Types.Spigot

Methods

parseJSON :: Value -> Parser Spigot

parseJSONList :: Value -> Parser [Spigot]

ToJSON Spigot

Defined in Amazonka.Glue.Types.Spigot

Methods

toJSON :: Spigot -> Value

toEncoding :: Spigot -> Encoding

toJSONList :: [Spigot] -> Value

toEncodingList :: [Spigot] -> Encoding

Generic Spigot

Defined in Amazonka.Glue.Types.Spigot

Associated Types

type Rep Spigot :: Type -> Type

Methods

from :: Spigot -> Rep Spigot x

to :: Rep Spigot x -> Spigot

Read Spigot

Defined in Amazonka.Glue.Types.Spigot

Methods

readsPrec :: Int -> ReadS Spigot

readList :: ReadS [Spigot]

readPrec :: ReadPrec Spigot

readListPrec :: ReadPrec [Spigot]

Show Spigot

Defined in Amazonka.Glue.Types.Spigot

Methods

showsPrec :: Int -> Spigot -> ShowS

show :: Spigot -> String

showList :: [Spigot] -> ShowS

NFData Spigot

Defined in Amazonka.Glue.Types.Spigot

Methods

rnf :: Spigot -> ()

Eq Spigot

Defined in Amazonka.Glue.Types.Spigot

Methods

(==) :: Spigot -> Spigot -> Bool

(/=) :: Spigot -> Spigot -> Bool

Hashable Spigot

Defined in Amazonka.Glue.Types.Spigot

Methods

hashWithSalt :: Int -> Spigot -> Int

hash :: Spigot -> Int

type Rep Spigot

Defined in Amazonka.Glue.Types.Spigot

type Rep Spigot = D1 ('MetaData "Spigot" "Amazonka.Glue.Types.Spigot" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "Spigot'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "prob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "topk") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "inputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSpigot

Arguments

:: Text

$sel:name:Spigot'

-> NonEmpty Text

$sel:inputs:Spigot'

-> Text

$sel:path:Spigot'

-> Spigot

Create a value of Spigot 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:prob:Spigot', spigot_prob - The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.

$sel:topk:Spigot', spigot_topk - Specifies a number of records to write starting from the beginning of the dataset.

$sel:name:Spigot', spigot_name - The name of the transform node.

$sel:inputs:Spigot', spigot_inputs - The data inputs identified by their node names.

$sel:path:Spigot', spigot_path - A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.

spigot_prob :: Lens' Spigot (Maybe Double)

The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.

spigot_topk :: Lens' Spigot (Maybe Natural)

Specifies a number of records to write starting from the beginning of the dataset.

spigot_name :: Lens' Spigot Text

The name of the transform node.

spigot_inputs :: Lens' Spigot (NonEmpty Text)

The data inputs identified by their node names.

spigot_path :: Lens' Spigot Text

A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.