| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.DataBrew.Types.Job
Description
Synopsis
- data Job = Job' {
- accountId :: Maybe Text
- createDate :: Maybe POSIX
- createdBy :: Maybe Text
- dataCatalogOutputs :: Maybe (NonEmpty DataCatalogOutput)
- databaseOutputs :: Maybe (NonEmpty DatabaseOutput)
- datasetName :: Maybe Text
- encryptionKeyArn :: Maybe Text
- encryptionMode :: Maybe EncryptionMode
- jobSample :: Maybe JobSample
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe POSIX
- logSubscription :: Maybe LogSubscription
- maxCapacity :: Maybe Int
- maxRetries :: Maybe Natural
- outputs :: Maybe (NonEmpty Output)
- projectName :: Maybe Text
- recipeReference :: Maybe RecipeReference
- resourceArn :: Maybe Text
- roleArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- timeout :: Maybe Natural
- type' :: Maybe JobType
- validationConfigurations :: Maybe (NonEmpty ValidationConfiguration)
- name :: Text
- newJob :: Text -> Job
- job_accountId :: Lens' Job (Maybe Text)
- job_createDate :: Lens' Job (Maybe UTCTime)
- job_createdBy :: Lens' Job (Maybe Text)
- job_dataCatalogOutputs :: Lens' Job (Maybe (NonEmpty DataCatalogOutput))
- job_databaseOutputs :: Lens' Job (Maybe (NonEmpty DatabaseOutput))
- job_datasetName :: Lens' Job (Maybe Text)
- job_encryptionKeyArn :: Lens' Job (Maybe Text)
- job_encryptionMode :: Lens' Job (Maybe EncryptionMode)
- job_jobSample :: Lens' Job (Maybe JobSample)
- job_lastModifiedBy :: Lens' Job (Maybe Text)
- job_lastModifiedDate :: Lens' Job (Maybe UTCTime)
- job_logSubscription :: Lens' Job (Maybe LogSubscription)
- job_maxCapacity :: Lens' Job (Maybe Int)
- job_maxRetries :: Lens' Job (Maybe Natural)
- job_outputs :: Lens' Job (Maybe (NonEmpty Output))
- job_projectName :: Lens' Job (Maybe Text)
- job_recipeReference :: Lens' Job (Maybe RecipeReference)
- job_resourceArn :: Lens' Job (Maybe Text)
- job_roleArn :: Lens' Job (Maybe Text)
- job_tags :: Lens' Job (Maybe (HashMap Text Text))
- job_timeout :: Lens' Job (Maybe Natural)
- job_type :: Lens' Job (Maybe JobType)
- job_validationConfigurations :: Lens' Job (Maybe (NonEmpty ValidationConfiguration))
- job_name :: Lens' Job Text
Documentation
Represents all of the attributes of a DataBrew job.
See: newJob smart constructor.
Constructors
| Job' | |
Fields
| |
Instances
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:accountId:Job', job_accountId - The ID of the Amazon Web Services account that owns the job.
$sel:createDate:Job', job_createDate - The date and time that the job was created.
$sel:createdBy:Job', job_createdBy - The Amazon Resource Name (ARN) of the user who created the job.
$sel:dataCatalogOutputs:Job', job_dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from
running 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: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: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: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:lastModifiedBy:Job', job_lastModifiedBy - The Amazon Resource Name (ARN) of the user who last modified the job.
$sel:lastModifiedDate:Job', job_lastModifiedDate - The modification date and time of the job.
$sel:logSubscription:Job', job_logSubscription - The current status of Amazon CloudWatch logging for the job.
$sel:maxCapacity:Job', job_maxCapacity - The maximum number of nodes that can be consumed when the job processes
data.
$sel:maxRetries:Job', job_maxRetries - The maximum number of times to retry the job after a job run fails.
$sel:outputs:Job', job_outputs - One or more artifacts that represent output from running the job.
$sel:projectName:Job', job_projectName - The name of the project that the job is associated with.
$sel:recipeReference:Job', job_recipeReference - A set of steps that the job runs.
$sel:resourceArn:Job', job_resourceArn - The unique Amazon Resource Name (ARN) for the job.
$sel:roleArn:Job', job_roleArn - The Amazon Resource Name (ARN) of the role to be assumed for this job.
$sel:tags:Job', job_tags - Metadata tags that have been applied to the job.
$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: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:validationConfigurations:Job', job_validationConfigurations - List of validation configurations that are applied to the profile job.
job_accountId :: Lens' Job (Maybe Text) Source #
The ID of the Amazon Web Services account that owns the job.
job_createdBy :: Lens' Job (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user who created 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_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_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_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_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_lastModifiedBy :: Lens' Job (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user who last modified the job.
job_lastModifiedDate :: Lens' Job (Maybe UTCTime) Source #
The modification date and time of the job.
job_logSubscription :: Lens' Job (Maybe LogSubscription) Source #
The current status of Amazon CloudWatch logging for the job.
job_maxCapacity :: Lens' Job (Maybe Int) Source #
The maximum number of nodes that can be consumed when the job processes data.
job_maxRetries :: Lens' Job (Maybe Natural) Source #
The maximum number of times to retry the job after a job run fails.
job_outputs :: Lens' Job (Maybe (NonEmpty Output)) Source #
One or more artifacts that represent output from running the job.
job_projectName :: Lens' Job (Maybe Text) Source #
The name of the project that the job is associated with.
job_recipeReference :: Lens' Job (Maybe RecipeReference) Source #
A set of steps that the job runs.
job_resourceArn :: Lens' Job (Maybe Text) Source #
The unique Amazon Resource Name (ARN) for the job.
job_roleArn :: Lens' Job (Maybe Text) Source #
The Amazon Resource Name (ARN) of the role to be assumed for this job.
job_tags :: Lens' Job (Maybe (HashMap Text Text)) Source #
Metadata tags that have been applied to the job.
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_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_validationConfigurations :: Lens' Job (Maybe (NonEmpty ValidationConfiguration)) Source #
List of validation configurations that are applied to the profile job.