Amazonka.DataBrew.UpdateRecipeJob

Modifies the definition of an existing DataBrew recipe job.

Creating a Request

data UpdateRecipeJob

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.

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

• 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

ToJSON UpdateRecipeJob

Defined in Amazonka.DataBrew.UpdateRecipeJob

Methods

toJSON :: UpdateRecipeJob -> Value

toEncoding :: UpdateRecipeJob -> Encoding

toJSONList :: [UpdateRecipeJob] -> Value

toEncodingList :: [UpdateRecipeJob] -> Encoding

ToHeaders UpdateRecipeJob

Defined in Amazonka.DataBrew.UpdateRecipeJob

Methods

toHeaders :: UpdateRecipeJob -> [Header]

ToPath UpdateRecipeJob

Defined in Amazonka.DataBrew.UpdateRecipeJob

Methods

toPath :: UpdateRecipeJob -> ByteString

ToQuery UpdateRecipeJob

Defined in Amazonka.DataBrew.UpdateRecipeJob

Methods

toQuery :: UpdateRecipeJob -> QueryString

AWSRequest UpdateRecipeJob

Defined in Amazonka.DataBrew.UpdateRecipeJob

Associated Types

type AWSResponse UpdateRecipeJob

Methods

request :: (Service -> Service) -> UpdateRecipeJob -> Request UpdateRecipeJob

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateRecipeJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateRecipeJob)))

Generic UpdateRecipeJob

Defined in Amazonka.DataBrew.UpdateRecipeJob

Associated Types

type Rep UpdateRecipeJob :: Type -> Type

Methods

from :: UpdateRecipeJob -> Rep UpdateRecipeJob x

to :: Rep UpdateRecipeJob x -> UpdateRecipeJob

Read UpdateRecipeJob

Defined in Amazonka.DataBrew.UpdateRecipeJob

Methods

readsPrec :: Int -> ReadS UpdateRecipeJob

readList :: ReadS [UpdateRecipeJob]

readPrec :: ReadPrec UpdateRecipeJob

readListPrec :: ReadPrec [UpdateRecipeJob]

Show UpdateRecipeJob

Defined in Amazonka.DataBrew.UpdateRecipeJob

Methods

showsPrec :: Int -> UpdateRecipeJob -> ShowS

show :: UpdateRecipeJob -> String

showList :: [UpdateRecipeJob] -> ShowS

NFData UpdateRecipeJob

Defined in Amazonka.DataBrew.UpdateRecipeJob

Methods

rnf :: UpdateRecipeJob -> ()

Eq UpdateRecipeJob

Defined in Amazonka.DataBrew.UpdateRecipeJob

Methods

(==) :: UpdateRecipeJob -> UpdateRecipeJob -> Bool

(/=) :: UpdateRecipeJob -> UpdateRecipeJob -> Bool

Hashable UpdateRecipeJob

Defined in Amazonka.DataBrew.UpdateRecipeJob

Methods

hashWithSalt :: Int -> UpdateRecipeJob -> Int

hash :: UpdateRecipeJob -> Int

type AWSResponse UpdateRecipeJob

Defined in Amazonka.DataBrew.UpdateRecipeJob

type AWSResponse UpdateRecipeJob = UpdateRecipeJobResponse

type Rep UpdateRecipeJob

Defined in Amazonka.DataBrew.UpdateRecipeJob

type Rep UpdateRecipeJob = D1 ('MetaData "UpdateRecipeJob" "Amazonka.DataBrew.UpdateRecipeJob" "amazonka-databrew-2.0-GJMXoRzRb387Yq6XNY29RM" '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 "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 "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))))))

newUpdateRecipeJob

Arguments

:: Text

UpdateRecipeJob

-> Text

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:

UpdateRecipeJob, updateRecipeJob_dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from running the job.

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

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

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.

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.

UpdateRecipeJob, updateRecipeJob_maxCapacity - The maximum number of nodes that DataBrew can consume when the job processes data.

UpdateRecipeJob, updateRecipeJob_maxRetries - The maximum number of times to retry the job after a job run fails.

UpdateRecipeJob, updateRecipeJob_outputs - One or more artifacts that represent the output from running the job.

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.

UpdateRecipeJob, updateRecipeJob_name - The name of the job to update.

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))

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

updateRecipeJob_databaseOutputs :: Lens' UpdateRecipeJob (Maybe (NonEmpty DatabaseOutput))

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

updateRecipeJob_encryptionKeyArn :: Lens' UpdateRecipeJob (Maybe Text)

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

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

updateRecipeJob_logSubscription :: Lens' UpdateRecipeJob (Maybe LogSubscription)

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

updateRecipeJob_maxCapacity :: Lens' UpdateRecipeJob (Maybe Int)

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

updateRecipeJob_maxRetries :: Lens' UpdateRecipeJob (Maybe Natural)

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

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

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

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

updateRecipeJob_name :: Lens' UpdateRecipeJob Text

The name of the job to update.

updateRecipeJob_roleArn :: Lens' UpdateRecipeJob Text

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

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

Generic UpdateRecipeJobResponse

Defined in Amazonka.DataBrew.UpdateRecipeJob

Associated Types

type Rep UpdateRecipeJobResponse :: Type -> Type

Methods

from :: UpdateRecipeJobResponse -> Rep UpdateRecipeJobResponse x

to :: Rep UpdateRecipeJobResponse x -> UpdateRecipeJobResponse

Read UpdateRecipeJobResponse

Defined in Amazonka.DataBrew.UpdateRecipeJob

Methods

readsPrec :: Int -> ReadS UpdateRecipeJobResponse

readList :: ReadS [UpdateRecipeJobResponse]

readPrec :: ReadPrec UpdateRecipeJobResponse

readListPrec :: ReadPrec [UpdateRecipeJobResponse]

Show UpdateRecipeJobResponse

Defined in Amazonka.DataBrew.UpdateRecipeJob

Methods

showsPrec :: Int -> UpdateRecipeJobResponse -> ShowS

show :: UpdateRecipeJobResponse -> String

showList :: [UpdateRecipeJobResponse] -> ShowS

NFData UpdateRecipeJobResponse

Defined in Amazonka.DataBrew.UpdateRecipeJob

Methods

rnf :: UpdateRecipeJobResponse -> ()

Eq UpdateRecipeJobResponse

Defined in Amazonka.DataBrew.UpdateRecipeJob

Methods

(==) :: UpdateRecipeJobResponse -> UpdateRecipeJobResponse -> Bool

(/=) :: UpdateRecipeJobResponse -> UpdateRecipeJobResponse -> Bool

type Rep UpdateRecipeJobResponse

Defined in Amazonka.DataBrew.UpdateRecipeJob

type Rep UpdateRecipeJobResponse = D1 ('MetaData "UpdateRecipeJobResponse" "Amazonka.DataBrew.UpdateRecipeJob" "amazonka-databrew-2.0-GJMXoRzRb387Yq6XNY29RM" '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

Arguments

:: Int

$sel:httpStatus:UpdateRecipeJobResponse'

-> Text

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.

UpdateRecipeJob, updateRecipeJobResponse_name - The name of the job that you updated.

Response Lenses

updateRecipeJobResponse_httpStatus :: Lens' UpdateRecipeJobResponse Int

The response's http status code.

updateRecipeJobResponse_name :: Lens' UpdateRecipeJobResponse Text

The name of the job that you updated.