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.UpdateRecipeJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the definition of an existing DataBrew recipe job.

Synopsis

data UpdateRecipeJob = UpdateRecipeJob' {
- dataCatalogOutputs :: Maybe (NonEmpty DataCatalogOutput)
- databaseOutputs :: Maybe (NonEmpty DatabaseOutput)
- encryptionMode :: Maybe EncryptionMode
- outputs :: Maybe (NonEmpty Output)
- logSubscription :: Maybe LogSubscription
- maxRetries :: Maybe Natural
- encryptionKeyArn :: Maybe Text
- maxCapacity :: Maybe Int
- timeout :: Maybe Natural
- name :: Text
- roleArn :: Text
}
newUpdateRecipeJob :: Text -> Text -> UpdateRecipeJob
updateRecipeJob_dataCatalogOutputs :: Lens' UpdateRecipeJob (Maybe (NonEmpty DataCatalogOutput))
updateRecipeJob_databaseOutputs :: Lens' UpdateRecipeJob (Maybe (NonEmpty DatabaseOutput))
updateRecipeJob_encryptionMode :: Lens' UpdateRecipeJob (Maybe EncryptionMode)
updateRecipeJob_outputs :: Lens' UpdateRecipeJob (Maybe (NonEmpty Output))
updateRecipeJob_logSubscription :: Lens' UpdateRecipeJob (Maybe LogSubscription)
updateRecipeJob_maxRetries :: Lens' UpdateRecipeJob (Maybe Natural)
updateRecipeJob_encryptionKeyArn :: Lens' UpdateRecipeJob (Maybe Text)
updateRecipeJob_maxCapacity :: Lens' UpdateRecipeJob (Maybe Int)
updateRecipeJob_timeout :: Lens' UpdateRecipeJob (Maybe Natural)
updateRecipeJob_name :: Lens' UpdateRecipeJob Text
updateRecipeJob_roleArn :: Lens' UpdateRecipeJob Text
data UpdateRecipeJobResponse = UpdateRecipeJobResponse' {
- httpStatus :: Int
- name :: Text
}
newUpdateRecipeJobResponse :: Int -> Text -> UpdateRecipeJobResponse
updateRecipeJobResponse_httpStatus :: Lens' UpdateRecipeJobResponse Int
updateRecipeJobResponse_name :: Lens' UpdateRecipeJobResponse Text

Creating a Request

data UpdateRecipeJob Source #

See: newUpdateRecipeJob smart constructor.

Constructors

UpdateRecipeJob'

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 into.
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 the output from running the job.
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.
maxRetries :: Maybe Natural
The maximum number of times to retry the job after a job run fails.
encryptionKeyArn :: Maybe Text
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
maxCapacity :: Maybe Int
The maximum number of nodes that DataBrew can consume when the job processes data.
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
The name of the job to update.
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

Eq UpdateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateRecipeJob Methods (==) :: UpdateRecipeJob -> UpdateRecipeJob -> Bool # (/=) :: UpdateRecipeJob -> UpdateRecipeJob -> Bool #
Read UpdateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateRecipeJob Methods readsPrec :: Int -> ReadS UpdateRecipeJob # readList :: ReadS [UpdateRecipeJob] # readPrec :: ReadPrec UpdateRecipeJob # readListPrec :: ReadPrec [UpdateRecipeJob] #
Show UpdateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateRecipeJob Methods showsPrec :: Int -> UpdateRecipeJob -> ShowS # show :: UpdateRecipeJob -> String # showList :: [UpdateRecipeJob] -> ShowS #
Generic UpdateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateRecipeJob Associated Types type Rep UpdateRecipeJob :: Type -> Type # Methods from :: UpdateRecipeJob -> Rep UpdateRecipeJob x # to :: Rep UpdateRecipeJob x -> UpdateRecipeJob #
NFData UpdateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateRecipeJob Methods rnf :: UpdateRecipeJob -> () #
Hashable UpdateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateRecipeJob Methods hashWithSalt :: Int -> UpdateRecipeJob -> Int # hash :: UpdateRecipeJob -> Int #
ToJSON UpdateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateRecipeJob Methods toJSON :: UpdateRecipeJob -> Value # toEncoding :: UpdateRecipeJob -> Encoding # toJSONList :: [UpdateRecipeJob] -> Value # toEncodingList :: [UpdateRecipeJob] -> Encoding #
AWSRequest UpdateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateRecipeJob Associated Types type AWSResponse UpdateRecipeJob # Methods request :: UpdateRecipeJob -> Request UpdateRecipeJob # response :: MonadResource m => Logger -> Service -> Proxy UpdateRecipeJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateRecipeJob))) #
ToHeaders UpdateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateRecipeJob Methods toHeaders :: UpdateRecipeJob -> [Header] #
ToPath UpdateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateRecipeJob Methods toPath :: UpdateRecipeJob -> ByteString #
ToQuery UpdateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateRecipeJob Methods toQuery :: UpdateRecipeJob -> QueryString #
type Rep UpdateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateRecipeJob type Rep UpdateRecipeJob = D1 ('MetaData "UpdateRecipeJob" "Amazonka.DataBrew.UpdateRecipeJob" "libZSservicesZSamazonka-databrewZSamazonka-databrew" 'False) (C1 ('MetaCons "UpdateRecipeJob'" '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 "encryptionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionMode)) :: (S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Output))) :: S1 ('MetaSel ('Just "logSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogSubscription))))) :: ((S1 ('MetaSel ('Just "maxRetries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "encryptionKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: (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))))))
type AWSResponse UpdateRecipeJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateRecipeJob type AWSResponse UpdateRecipeJob = UpdateRecipeJobResponse

newUpdateRecipeJob Source #

Arguments

:: Text	`$sel:name:UpdateRecipeJob'`
-> Text	`$sel:roleArn:UpdateRecipeJob'`
-> UpdateRecipeJob

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

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

$sel:encryptionMode:UpdateRecipeJob', updateRecipeJob_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:UpdateRecipeJob', updateRecipeJob_outputs - One or more artifacts that represent the output from running the job.

$sel:logSubscription:UpdateRecipeJob', updateRecipeJob_logSubscription - Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

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

$sel:encryptionKeyArn:UpdateRecipeJob', updateRecipeJob_encryptionKeyArn - The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

$sel:maxCapacity:UpdateRecipeJob', updateRecipeJob_maxCapacity - The maximum number of nodes that DataBrew can consume when the job processes data.

$sel:timeout:UpdateRecipeJob', updateRecipeJob_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:name:UpdateRecipeJob', updateRecipeJob_name - The name of the job to update.

$sel:roleArn:UpdateRecipeJob', updateRecipeJob_roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

Request Lenses

updateRecipeJob_dataCatalogOutputs :: Lens' UpdateRecipeJob (Maybe (NonEmpty DataCatalogOutput)) Source #

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

updateRecipeJob_databaseOutputs :: Lens' UpdateRecipeJob (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.

updateRecipeJob_encryptionMode :: Lens' UpdateRecipeJob (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.

updateRecipeJob_outputs :: Lens' UpdateRecipeJob (Maybe (NonEmpty Output)) Source #

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

updateRecipeJob_logSubscription :: Lens' UpdateRecipeJob (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.

updateRecipeJob_maxRetries :: Lens' UpdateRecipeJob (Maybe Natural) Source #

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

updateRecipeJob_encryptionKeyArn :: Lens' UpdateRecipeJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

updateRecipeJob_maxCapacity :: Lens' UpdateRecipeJob (Maybe Int) Source #

The maximum number of nodes that DataBrew can consume when the job processes data.

updateRecipeJob_timeout :: Lens' UpdateRecipeJob (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.

updateRecipeJob_name :: Lens' UpdateRecipeJob Text Source #

The name of the job to update.

updateRecipeJob_roleArn :: Lens' UpdateRecipeJob 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 UpdateRecipeJobResponse Source #

See: newUpdateRecipeJobResponse smart constructor.

Constructors

UpdateRecipeJobResponse'
Fields httpStatus :: Int The response's http status code. name :: Text The name of the job that you updated.

Instances

Instances details

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

newUpdateRecipeJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateRecipeJobResponse'`
-> Text	`$sel:name:UpdateRecipeJob'`
-> UpdateRecipeJobResponse

Create a value of UpdateRecipeJobResponse 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:UpdateRecipeJobResponse', updateRecipeJobResponse_httpStatus - The response's http status code.

$sel:name:UpdateRecipeJob', updateRecipeJobResponse_name - The name of the job that you updated.

Response Lenses

updateRecipeJobResponse_httpStatus :: Lens' UpdateRecipeJobResponse Int Source #

The response's http status code.

updateRecipeJobResponse_name :: Lens' UpdateRecipeJobResponse Text Source #

The name of the job that you updated.