amazonka-glue-2.0: Amazon Glue SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Glue.Types.Spigot

Description

 
Synopsis

Documentation

data Spigot Source #

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

Instances details
FromJSON Spigot Source # 
Instance details

Defined in Amazonka.Glue.Types.Spigot

ToJSON Spigot Source # 
Instance details

Defined in Amazonka.Glue.Types.Spigot

Generic Spigot Source # 
Instance details

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 Source # 
Instance details

Defined in Amazonka.Glue.Types.Spigot

Show Spigot Source # 
Instance details

Defined in Amazonka.Glue.Types.Spigot

NFData Spigot Source # 
Instance details

Defined in Amazonka.Glue.Types.Spigot

Methods

rnf :: Spigot -> () #

Eq Spigot Source # 
Instance details

Defined in Amazonka.Glue.Types.Spigot

Methods

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

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

Hashable Spigot Source # 
Instance details

Defined in Amazonka.Glue.Types.Spigot

Methods

hashWithSalt :: Int -> Spigot -> Int #

hash :: Spigot -> Int #

type Rep Spigot Source # 
Instance details

Defined in Amazonka.Glue.Types.Spigot

newSpigot Source #

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

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

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

spigot_name :: Lens' Spigot Text Source #

The name of the transform node.

spigot_inputs :: Lens' Spigot (NonEmpty Text) Source #

The data inputs identified by their node names.

spigot_path :: Lens' Spigot Text Source #

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.