| 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.CreateRecipeJob
Description
Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe
Synopsis
- data CreateRecipeJob = CreateRecipeJob' {
- dataCatalogOutputs :: Maybe (NonEmpty DataCatalogOutput)
- databaseOutputs :: Maybe (NonEmpty DatabaseOutput)
- datasetName :: Maybe Text
- encryptionKeyArn :: Maybe Text
- encryptionMode :: Maybe EncryptionMode
- logSubscription :: Maybe LogSubscription
- maxCapacity :: Maybe Int
- maxRetries :: Maybe Natural
- outputs :: Maybe (NonEmpty Output)
- projectName :: Maybe Text
- recipeReference :: Maybe RecipeReference
- tags :: Maybe (HashMap Text Text)
- timeout :: Maybe Natural
- name :: Text
- roleArn :: Text
- newCreateRecipeJob :: Text -> Text -> CreateRecipeJob
- createRecipeJob_dataCatalogOutputs :: Lens' CreateRecipeJob (Maybe (NonEmpty DataCatalogOutput))
- createRecipeJob_databaseOutputs :: Lens' CreateRecipeJob (Maybe (NonEmpty DatabaseOutput))
- createRecipeJob_datasetName :: Lens' CreateRecipeJob (Maybe Text)
- createRecipeJob_encryptionKeyArn :: Lens' CreateRecipeJob (Maybe Text)
- createRecipeJob_encryptionMode :: Lens' CreateRecipeJob (Maybe EncryptionMode)
- createRecipeJob_logSubscription :: Lens' CreateRecipeJob (Maybe LogSubscription)
- createRecipeJob_maxCapacity :: Lens' CreateRecipeJob (Maybe Int)
- createRecipeJob_maxRetries :: Lens' CreateRecipeJob (Maybe Natural)
- createRecipeJob_outputs :: Lens' CreateRecipeJob (Maybe (NonEmpty Output))
- createRecipeJob_projectName :: Lens' CreateRecipeJob (Maybe Text)
- createRecipeJob_recipeReference :: Lens' CreateRecipeJob (Maybe RecipeReference)
- createRecipeJob_tags :: Lens' CreateRecipeJob (Maybe (HashMap Text Text))
- createRecipeJob_timeout :: Lens' CreateRecipeJob (Maybe Natural)
- createRecipeJob_name :: Lens' CreateRecipeJob Text
- createRecipeJob_roleArn :: Lens' CreateRecipeJob Text
- data CreateRecipeJobResponse = CreateRecipeJobResponse' {
- httpStatus :: Int
- name :: Text
- newCreateRecipeJobResponse :: Int -> Text -> CreateRecipeJobResponse
- createRecipeJobResponse_httpStatus :: Lens' CreateRecipeJobResponse Int
- createRecipeJobResponse_name :: Lens' CreateRecipeJobResponse Text
Creating a Request
data CreateRecipeJob Source #
See: newCreateRecipeJob smart constructor.
Constructors
| CreateRecipeJob' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateRecipeJob |
Create a value of CreateRecipeJob 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:
CreateRecipeJob, createRecipeJob_dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from
running the job.
CreateRecipeJob, createRecipeJob_databaseOutputs - Represents a list of JDBC database output objects which defines the
output destination for a DataBrew recipe job to write to.
CreateRecipeJob, createRecipeJob_datasetName - The name of the dataset that this job processes.
CreateRecipeJob, createRecipeJob_encryptionKeyArn - The Amazon Resource Name (ARN) of an encryption key that is used to
protect the job.
CreateRecipeJob, createRecipeJob_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.
CreateRecipeJob, createRecipeJob_logSubscription - Enables or disables Amazon CloudWatch logging for the job. If logging is
enabled, CloudWatch writes one log stream for each job run.
CreateRecipeJob, createRecipeJob_maxCapacity - The maximum number of nodes that DataBrew can consume when the job
processes data.
CreateRecipeJob, createRecipeJob_maxRetries - The maximum number of times to retry the job after a job run fails.
CreateRecipeJob, createRecipeJob_outputs - One or more artifacts that represent the output from running the job.
CreateRecipeJob, createRecipeJob_projectName - Either the name of an existing project, or a combination of a recipe and
a dataset to associate with the recipe.
CreateRecipeJob, createRecipeJob_recipeReference - Undocumented member.
CreateRecipeJob, createRecipeJob_tags - Metadata tags to apply to this job.
CreateRecipeJob, createRecipeJob_timeout - The job's timeout in minutes. A job that attempts to run longer than
this timeout period ends with a status of TIMEOUT.
CreateRecipeJob, createRecipeJob_name - A unique name for the job. Valid characters are alphanumeric (A-Z, a-z,
0-9), hyphen (-), period (.), and space.
CreateRecipeJob, createRecipeJob_roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role to be assumed when DataBrew runs the job.
Request Lenses
createRecipeJob_dataCatalogOutputs :: Lens' CreateRecipeJob (Maybe (NonEmpty DataCatalogOutput)) Source #
One or more artifacts that represent the Glue Data Catalog output from running the job.
createRecipeJob_databaseOutputs :: Lens' CreateRecipeJob (Maybe (NonEmpty DatabaseOutput)) Source #
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.
createRecipeJob_datasetName :: Lens' CreateRecipeJob (Maybe Text) Source #
The name of the dataset that this job processes.
createRecipeJob_encryptionKeyArn :: Lens' CreateRecipeJob (Maybe Text) Source #
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
createRecipeJob_encryptionMode :: Lens' CreateRecipeJob (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.
createRecipeJob_logSubscription :: Lens' CreateRecipeJob (Maybe LogSubscription) Source #
Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
createRecipeJob_maxCapacity :: Lens' CreateRecipeJob (Maybe Int) Source #
The maximum number of nodes that DataBrew can consume when the job processes data.
createRecipeJob_maxRetries :: Lens' CreateRecipeJob (Maybe Natural) Source #
The maximum number of times to retry the job after a job run fails.
createRecipeJob_outputs :: Lens' CreateRecipeJob (Maybe (NonEmpty Output)) Source #
One or more artifacts that represent the output from running the job.
createRecipeJob_projectName :: Lens' CreateRecipeJob (Maybe Text) Source #
Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.
createRecipeJob_recipeReference :: Lens' CreateRecipeJob (Maybe RecipeReference) Source #
Undocumented member.
createRecipeJob_tags :: Lens' CreateRecipeJob (Maybe (HashMap Text Text)) Source #
Metadata tags to apply to this job.
createRecipeJob_timeout :: Lens' CreateRecipeJob (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.
createRecipeJob_name :: Lens' CreateRecipeJob Text Source #
A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
createRecipeJob_roleArn :: Lens' CreateRecipeJob Text Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
Destructuring the Response
data CreateRecipeJobResponse Source #
See: newCreateRecipeJobResponse smart constructor.
Constructors
| CreateRecipeJobResponse' | |
Fields
| |
Instances
newCreateRecipeJobResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> CreateRecipeJobResponse |
Create a value of CreateRecipeJobResponse 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:httpStatus:CreateRecipeJobResponse', createRecipeJobResponse_httpStatus - The response's http status code.
CreateRecipeJob, createRecipeJobResponse_name - The name of the job that you created.
Response Lenses
createRecipeJobResponse_httpStatus :: Lens' CreateRecipeJobResponse Int Source #
The response's http status code.
createRecipeJobResponse_name :: Lens' CreateRecipeJobResponse Text Source #
The name of the job that you created.