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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

dataCatalogOutputs :: Maybe (NonEmpty DataCatalogOutput)
One or more artifacts that represent the Glue Data Catalog output from running 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 to.
datasetName :: Maybe Text
The name of the dataset that this job processes.
encryptionKeyArn :: Maybe Text
The Amazon Resource Name (ARN) of an encryption key that is used to protect 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.
logSubscription :: Maybe LogSubscription
Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
maxCapacity :: Maybe Int
The maximum number of nodes that DataBrew can consume when the job processes data.
maxRetries :: Maybe Natural
The maximum number of times to retry the job after a job run fails.
outputs :: Maybe (NonEmpty Output)
One or more artifacts that represent the output from running the job.
projectName :: Maybe Text
Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.
recipeReference :: Maybe RecipeReference
tags :: Maybe (HashMap Text Text)
Metadata tags to apply to this job.
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.
name :: Text
A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
roleArn :: Text
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

Instances

Instances details

ToJSON CreateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob Methods toJSON :: CreateRecipeJob -> Value # toEncoding :: CreateRecipeJob -> Encoding # toJSONList :: [CreateRecipeJob] -> Value # toEncodingList :: [CreateRecipeJob] -> Encoding #
ToHeaders CreateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob Methods toHeaders :: CreateRecipeJob -> [Header] #
ToPath CreateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob Methods toPath :: CreateRecipeJob -> ByteString #
ToQuery CreateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob Methods toQuery :: CreateRecipeJob -> QueryString #
AWSRequest CreateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob Associated Types type AWSResponse CreateRecipeJob # Methods request :: (Service -> Service) -> CreateRecipeJob -> Request CreateRecipeJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateRecipeJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateRecipeJob))) #
Generic CreateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob Associated Types type Rep CreateRecipeJob :: Type -> Type # Methods from :: CreateRecipeJob -> Rep CreateRecipeJob x # to :: Rep CreateRecipeJob x -> CreateRecipeJob #
Read CreateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob Methods readsPrec :: Int -> ReadS CreateRecipeJob # readList :: ReadS [CreateRecipeJob] # readPrec :: ReadPrec CreateRecipeJob # readListPrec :: ReadPrec [CreateRecipeJob] #
Show CreateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob Methods showsPrec :: Int -> CreateRecipeJob -> ShowS # show :: CreateRecipeJob -> String # showList :: [CreateRecipeJob] -> ShowS #
NFData CreateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob Methods rnf :: CreateRecipeJob -> () #
Eq CreateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob Methods (==) :: CreateRecipeJob -> CreateRecipeJob -> Bool # (/=) :: CreateRecipeJob -> CreateRecipeJob -> Bool #
Hashable CreateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob Methods hashWithSalt :: Int -> CreateRecipeJob -> Int # hash :: CreateRecipeJob -> Int #
type AWSResponse CreateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob type AWSResponse CreateRecipeJob = CreateRecipeJobResponse
type Rep CreateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob type Rep CreateRecipeJob = D1 ('MetaData "CreateRecipeJob" "Amazonka.DataBrew.CreateRecipeJob" "amazonka-databrew-2.0-GJMXoRzRb387Yq6XNY29RM" 'False) (C1 ('MetaCons "CreateRecipeJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dataCatalogOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataCatalogOutput))) :: (S1 ('MetaSel ('Just "databaseOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DatabaseOutput))) :: S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "encryptionKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "encryptionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionMode))) :: (S1 ('MetaSel ('Just "logSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogSubscription)) :: S1 ('MetaSel ('Just "maxCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: (((S1 ('MetaSel ('Just "maxRetries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Output)))) :: (S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "recipeReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecipeReference)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateRecipeJob Source #

Arguments

:: Text	`CreateRecipeJob`
-> Text	`CreateRecipeJob`
-> 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 httpStatus :: Int The response's http status code. name :: Text The name of the job that you created.

Instances

Instances details

Generic CreateRecipeJobResponse Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob Associated Types type Rep CreateRecipeJobResponse :: Type -> Type # Methods from :: CreateRecipeJobResponse -> Rep CreateRecipeJobResponse x # to :: Rep CreateRecipeJobResponse x -> CreateRecipeJobResponse #
Read CreateRecipeJobResponse Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob Methods readsPrec :: Int -> ReadS CreateRecipeJobResponse # readList :: ReadS [CreateRecipeJobResponse] # readPrec :: ReadPrec CreateRecipeJobResponse # readListPrec :: ReadPrec [CreateRecipeJobResponse] #
Show CreateRecipeJobResponse Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob Methods showsPrec :: Int -> CreateRecipeJobResponse -> ShowS # show :: CreateRecipeJobResponse -> String # showList :: [CreateRecipeJobResponse] -> ShowS #
NFData CreateRecipeJobResponse Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob Methods rnf :: CreateRecipeJobResponse -> () #
Eq CreateRecipeJobResponse Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob Methods (==) :: CreateRecipeJobResponse -> CreateRecipeJobResponse -> Bool # (/=) :: CreateRecipeJobResponse -> CreateRecipeJobResponse -> Bool #
type Rep CreateRecipeJobResponse Source #
Instance details Defined in Amazonka.DataBrew.CreateRecipeJob type Rep CreateRecipeJobResponse = D1 ('MetaData "CreateRecipeJobResponse" "Amazonka.DataBrew.CreateRecipeJob" "amazonka-databrew-2.0-GJMXoRzRb387Yq6XNY29RM" 'False) (C1 ('MetaCons "CreateRecipeJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateRecipeJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateRecipeJobResponse'`
-> Text	`CreateRecipeJob`
-> 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.