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.DataBrew.Types.Job

Description

Synopsis

data Job = Job' {
- dataCatalogOutputs :: Maybe (NonEmpty DataCatalogOutput)
- lastModifiedDate :: Maybe POSIX
- createDate :: Maybe POSIX
- recipeReference :: Maybe RecipeReference
- createdBy :: Maybe Text
- databaseOutputs :: Maybe (NonEmpty DatabaseOutput)
- accountId :: Maybe Text
- encryptionMode :: Maybe EncryptionMode
- outputs :: Maybe (NonEmpty Output)
- resourceArn :: Maybe Text
- logSubscription :: Maybe LogSubscription
- projectName :: Maybe Text
- maxRetries :: Maybe Natural
- datasetName :: Maybe Text
- encryptionKeyArn :: Maybe Text
- maxCapacity :: Maybe Int
- lastModifiedBy :: Maybe Text
- type' :: Maybe JobType
- timeout :: Maybe Natural
- tags :: Maybe (HashMap Text Text)
- roleArn :: Maybe Text
- jobSample :: Maybe JobSample
- name :: Text
}
newJob :: Text -> Job
job_dataCatalogOutputs :: Lens' Job (Maybe (NonEmpty DataCatalogOutput))
job_lastModifiedDate :: Lens' Job (Maybe UTCTime)
job_createDate :: Lens' Job (Maybe UTCTime)
job_recipeReference :: Lens' Job (Maybe RecipeReference)
job_createdBy :: Lens' Job (Maybe Text)
job_databaseOutputs :: Lens' Job (Maybe (NonEmpty DatabaseOutput))
job_accountId :: Lens' Job (Maybe Text)
job_encryptionMode :: Lens' Job (Maybe EncryptionMode)
job_outputs :: Lens' Job (Maybe (NonEmpty Output))
job_resourceArn :: Lens' Job (Maybe Text)
job_logSubscription :: Lens' Job (Maybe LogSubscription)
job_projectName :: Lens' Job (Maybe Text)
job_maxRetries :: Lens' Job (Maybe Natural)
job_datasetName :: Lens' Job (Maybe Text)
job_encryptionKeyArn :: Lens' Job (Maybe Text)
job_maxCapacity :: Lens' Job (Maybe Int)
job_lastModifiedBy :: Lens' Job (Maybe Text)
job_type :: Lens' Job (Maybe JobType)
job_timeout :: Lens' Job (Maybe Natural)
job_tags :: Lens' Job (Maybe (HashMap Text Text))
job_roleArn :: Lens' Job (Maybe Text)
job_jobSample :: Lens' Job (Maybe JobSample)
job_name :: Lens' Job Text

Documentation

data Job Source #

Represents all of the attributes of a DataBrew job.

See: newJob smart constructor.

Constructors

Job'

Fields

dataCatalogOutputs :: Maybe (NonEmpty DataCatalogOutput)
One or more artifacts that represent the Glue Data Catalog output from running the job.
lastModifiedDate :: Maybe POSIX
The modification date and time of the job.
createDate :: Maybe POSIX
The date and time that the job was created.
recipeReference :: Maybe RecipeReference
A set of steps that the job runs.
createdBy :: Maybe Text
The Amazon Resource Name (ARN) of the user who created the job.
databaseOutputs :: Maybe (NonEmpty DatabaseOutput)
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
accountId :: Maybe Text
The ID of the Amazon Web Services account that owns the job.
encryptionMode :: Maybe EncryptionMode
The encryption mode for the job, which can be one of the following:
- SSE-KMS - Server-side encryption with keys managed by KMS.
- SSE-S3 - Server-side encryption with keys managed by Amazon S3.
outputs :: Maybe (NonEmpty Output)
One or more artifacts that represent output from running the job.
resourceArn :: Maybe Text
The unique Amazon Resource Name (ARN) for the job.
logSubscription :: Maybe LogSubscription
The current status of Amazon CloudWatch logging for the job.
projectName :: Maybe Text
The name of the project that the job is associated with.
maxRetries :: Maybe Natural
The maximum number of times to retry the job after a job run fails.
datasetName :: Maybe Text
A dataset that the job is to process.
encryptionKeyArn :: Maybe Text
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see Encrypting data written by DataBrew jobs
maxCapacity :: Maybe Int
The maximum number of nodes that can be consumed when the job processes data.
lastModifiedBy :: Maybe Text
The Amazon Resource Name (ARN) of the user who last modified the job.
type' :: Maybe JobType
The job type of the job, which must be one of the following:
- PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.
- RECIPE - A job to apply one or more transformations to a dataset.
timeout :: Maybe Natural
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.
tags :: Maybe (HashMap Text Text)
Metadata tags that have been applied to the job.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) of the role to be assumed for this job.
jobSample :: Maybe JobSample
A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.
name :: Text
The unique name of the job.

Instances

Instances details

Eq Job Source #
Instance details Defined in Amazonka.DataBrew.Types.Job Methods (==) :: Job -> Job -> Bool # (/=) :: Job -> Job -> Bool #
Read Job Source #
Instance details Defined in Amazonka.DataBrew.Types.Job Methods readsPrec :: Int -> ReadS Job # readList :: ReadS [Job] # readPrec :: ReadPrec Job # readListPrec :: ReadPrec [Job] #
Show Job Source #
Instance details Defined in Amazonka.DataBrew.Types.Job Methods showsPrec :: Int -> Job -> ShowS # show :: Job -> String # showList :: [Job] -> ShowS #
Generic Job Source #
Instance details Defined in Amazonka.DataBrew.Types.Job Associated Types type Rep Job :: Type -> Type # Methods from :: Job -> Rep Job x # to :: Rep Job x -> Job #
NFData Job Source #
Instance details Defined in Amazonka.DataBrew.Types.Job Methods rnf :: Job -> () #
Hashable Job Source #
Instance details Defined in Amazonka.DataBrew.Types.Job Methods hashWithSalt :: Int -> Job -> Int # hash :: Job -> Int #
FromJSON Job Source #
Instance details Defined in Amazonka.DataBrew.Types.Job Methods parseJSON :: Value -> Parser Job # parseJSONList :: Value -> Parser [Job] #
type Rep Job Source #
Instance details Defined in Amazonka.DataBrew.Types.Job type Rep Job = D1 ('MetaData "Job" "Amazonka.DataBrew.Types.Job" "libZSservicesZSamazonka-databrewZSamazonka-databrew" 'False) (C1 ('MetaCons "Job'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "dataCatalogOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataCatalogOutput))) :: S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "createDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "recipeReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecipeReference)) :: S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "databaseOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DatabaseOutput))) :: (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "encryptionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionMode)))) :: (S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Output))) :: (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "logSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogSubscription)))))) :: (((S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxRetries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "encryptionKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobType)) :: (S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "jobSample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobSample)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newJob Source #

Arguments

:: Text	`$sel:name:Job'`
-> Job

Create a value of Job 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:dataCatalogOutputs:Job', job_dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from running the job.

$sel:lastModifiedDate:Job', job_lastModifiedDate - The modification date and time of the job.

$sel:createDate:Job', job_createDate - The date and time that the job was created.

$sel:recipeReference:Job', job_recipeReference - A set of steps that the job runs.

$sel:createdBy:Job', job_createdBy - The Amazon Resource Name (ARN) of the user who created the job.

$sel:databaseOutputs:Job', job_databaseOutputs - Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

$sel:accountId:Job', job_accountId - The ID of the Amazon Web Services account that owns the job.

$sel:encryptionMode:Job', job_encryptionMode - The encryption mode for the job, which can be one of the following:

SSE-KMS - Server-side encryption with keys managed by KMS.
SSE-S3 - Server-side encryption with keys managed by Amazon S3.

$sel:outputs:Job', job_outputs - One or more artifacts that represent output from running the job.

$sel:resourceArn:Job', job_resourceArn - The unique Amazon Resource Name (ARN) for the job.

$sel:logSubscription:Job', job_logSubscription - The current status of Amazon CloudWatch logging for the job.

$sel:projectName:Job', job_projectName - The name of the project that the job is associated with.

$sel:maxRetries:Job', job_maxRetries - The maximum number of times to retry the job after a job run fails.

$sel:datasetName:Job', job_datasetName - A dataset that the job is to process.

$sel:encryptionKeyArn:Job', job_encryptionKeyArn - The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see Encrypting data written by DataBrew jobs

$sel:maxCapacity:Job', job_maxCapacity - The maximum number of nodes that can be consumed when the job processes data.

$sel:lastModifiedBy:Job', job_lastModifiedBy - The Amazon Resource Name (ARN) of the user who last modified the job.

$sel:type':Job', job_type - The job type of the job, which must be one of the following:

PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.
RECIPE - A job to apply one or more transformations to a dataset.

$sel:timeout:Job', job_timeout - The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

$sel:tags:Job', job_tags - Metadata tags that have been applied to the job.

$sel:roleArn:Job', job_roleArn - The Amazon Resource Name (ARN) of the role to be assumed for this job.

$sel:jobSample:Job', job_jobSample - A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.

$sel:name:Job', job_name - The unique name of the job.

job_dataCatalogOutputs :: Lens' Job (Maybe (NonEmpty DataCatalogOutput)) Source #

One or more artifacts that represent the Glue Data Catalog output from running the job.

job_lastModifiedDate :: Lens' Job (Maybe UTCTime) Source #

The modification date and time of the job.

job_createDate :: Lens' Job (Maybe UTCTime) Source #

The date and time that the job was created.

job_recipeReference :: Lens' Job (Maybe RecipeReference) Source #

A set of steps that the job runs.

job_createdBy :: Lens' Job (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who created the job.

job_databaseOutputs :: Lens' Job (Maybe (NonEmpty DatabaseOutput)) Source #

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

job_accountId :: Lens' Job (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the job.

job_encryptionMode :: Lens' Job (Maybe EncryptionMode) Source #

The encryption mode for the job, which can be one of the following:

SSE-KMS - Server-side encryption with keys managed by KMS.
SSE-S3 - Server-side encryption with keys managed by Amazon S3.

job_outputs :: Lens' Job (Maybe (NonEmpty Output)) Source #

One or more artifacts that represent output from running the job.

job_resourceArn :: Lens' Job (Maybe Text) Source #

The unique Amazon Resource Name (ARN) for the job.

job_logSubscription :: Lens' Job (Maybe LogSubscription) Source #

The current status of Amazon CloudWatch logging for the job.

job_projectName :: Lens' Job (Maybe Text) Source #

The name of the project that the job is associated with.

job_maxRetries :: Lens' Job (Maybe Natural) Source #

The maximum number of times to retry the job after a job run fails.

job_datasetName :: Lens' Job (Maybe Text) Source #

A dataset that the job is to process.

job_encryptionKeyArn :: Lens' Job (Maybe Text) Source #

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see Encrypting data written by DataBrew jobs

job_maxCapacity :: Lens' Job (Maybe Int) Source #

The maximum number of nodes that can be consumed when the job processes data.

job_lastModifiedBy :: Lens' Job (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who last modified the job.

job_type :: Lens' Job (Maybe JobType) Source #

The job type of the job, which must be one of the following:

PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.
RECIPE - A job to apply one or more transformations to a dataset.

job_timeout :: Lens' Job (Maybe Natural) Source #

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

job_tags :: Lens' Job (Maybe (HashMap Text Text)) Source #

Metadata tags that have been applied to the job.

job_roleArn :: Lens' Job (Maybe Text) Source #

The Amazon Resource Name (ARN) of the role to be assumed for this job.

job_jobSample :: Lens' Job (Maybe JobSample) Source #

A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.

job_name :: Lens' Job Text Source #

The unique name of the job.