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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the definition of an existing profile job.

Synopsis

data UpdateProfileJob = UpdateProfileJob' {
- encryptionMode :: Maybe EncryptionMode
- logSubscription :: Maybe LogSubscription
- maxRetries :: Maybe Natural
- encryptionKeyArn :: Maybe Text
- maxCapacity :: Maybe Int
- configuration :: Maybe ProfileConfiguration
- timeout :: Maybe Natural
- jobSample :: Maybe JobSample
- name :: Text
- outputLocation :: S3Location
- roleArn :: Text
}
newUpdateProfileJob :: Text -> S3Location -> Text -> UpdateProfileJob
updateProfileJob_encryptionMode :: Lens' UpdateProfileJob (Maybe EncryptionMode)
updateProfileJob_logSubscription :: Lens' UpdateProfileJob (Maybe LogSubscription)
updateProfileJob_maxRetries :: Lens' UpdateProfileJob (Maybe Natural)
updateProfileJob_encryptionKeyArn :: Lens' UpdateProfileJob (Maybe Text)
updateProfileJob_maxCapacity :: Lens' UpdateProfileJob (Maybe Int)
updateProfileJob_configuration :: Lens' UpdateProfileJob (Maybe ProfileConfiguration)
updateProfileJob_timeout :: Lens' UpdateProfileJob (Maybe Natural)
updateProfileJob_jobSample :: Lens' UpdateProfileJob (Maybe JobSample)
updateProfileJob_name :: Lens' UpdateProfileJob Text
updateProfileJob_outputLocation :: Lens' UpdateProfileJob S3Location
updateProfileJob_roleArn :: Lens' UpdateProfileJob Text
data UpdateProfileJobResponse = UpdateProfileJobResponse' {
- httpStatus :: Int
- name :: Text
}
newUpdateProfileJobResponse :: Int -> Text -> UpdateProfileJobResponse
updateProfileJobResponse_httpStatus :: Lens' UpdateProfileJobResponse Int
updateProfileJobResponse_name :: Lens' UpdateProfileJobResponse Text

Creating a Request

data UpdateProfileJob Source #

See: newUpdateProfileJob smart constructor.

Constructors

UpdateProfileJob'

Fields

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.
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 compute nodes that DataBrew can use when the job processes data.
configuration :: Maybe ProfileConfiguration
Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.
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.
jobSample :: Maybe JobSample
Sample configuration for Profile Jobs only. Determines the number of rows on which the Profile job will be executed. If a JobSample value is not provided for profile jobs, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.
name :: Text
The name of the job to be updated.
outputLocation :: S3Location
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 UpdateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateProfileJob Methods (==) :: UpdateProfileJob -> UpdateProfileJob -> Bool # (/=) :: UpdateProfileJob -> UpdateProfileJob -> Bool #
Read UpdateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateProfileJob Methods readsPrec :: Int -> ReadS UpdateProfileJob # readList :: ReadS [UpdateProfileJob] # readPrec :: ReadPrec UpdateProfileJob # readListPrec :: ReadPrec [UpdateProfileJob] #
Show UpdateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateProfileJob Methods showsPrec :: Int -> UpdateProfileJob -> ShowS # show :: UpdateProfileJob -> String # showList :: [UpdateProfileJob] -> ShowS #
Generic UpdateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateProfileJob Associated Types type Rep UpdateProfileJob :: Type -> Type # Methods from :: UpdateProfileJob -> Rep UpdateProfileJob x # to :: Rep UpdateProfileJob x -> UpdateProfileJob #
NFData UpdateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateProfileJob Methods rnf :: UpdateProfileJob -> () #
Hashable UpdateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateProfileJob Methods hashWithSalt :: Int -> UpdateProfileJob -> Int # hash :: UpdateProfileJob -> Int #
ToJSON UpdateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateProfileJob Methods toJSON :: UpdateProfileJob -> Value # toEncoding :: UpdateProfileJob -> Encoding # toJSONList :: [UpdateProfileJob] -> Value # toEncodingList :: [UpdateProfileJob] -> Encoding #
AWSRequest UpdateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateProfileJob Associated Types type AWSResponse UpdateProfileJob # Methods request :: UpdateProfileJob -> Request UpdateProfileJob # response :: MonadResource m => Logger -> Service -> Proxy UpdateProfileJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateProfileJob))) #
ToHeaders UpdateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateProfileJob Methods toHeaders :: UpdateProfileJob -> [Header] #
ToPath UpdateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateProfileJob Methods toPath :: UpdateProfileJob -> ByteString #
ToQuery UpdateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateProfileJob Methods toQuery :: UpdateProfileJob -> QueryString #
type Rep UpdateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateProfileJob type Rep UpdateProfileJob = D1 ('MetaData "UpdateProfileJob" "Amazonka.DataBrew.UpdateProfileJob" "libZSservicesZSamazonka-databrewZSamazonka-databrew" 'False) (C1 ('MetaCons "UpdateProfileJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "encryptionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionMode)) :: 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 "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProfileConfiguration)) :: (S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "jobSample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobSample)))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "outputLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3Location) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse UpdateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.UpdateProfileJob type AWSResponse UpdateProfileJob = UpdateProfileJobResponse

newUpdateProfileJob Source #

Arguments

:: Text	`$sel:name:UpdateProfileJob'`
-> S3Location	`$sel:outputLocation:UpdateProfileJob'`
-> Text	`$sel:roleArn:UpdateProfileJob'`
-> UpdateProfileJob

Create a value of UpdateProfileJob 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:encryptionMode:UpdateProfileJob', updateProfileJob_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:logSubscription:UpdateProfileJob', updateProfileJob_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:UpdateProfileJob', updateProfileJob_maxRetries - The maximum number of times to retry the job after a job run fails.

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

$sel:maxCapacity:UpdateProfileJob', updateProfileJob_maxCapacity - The maximum number of compute nodes that DataBrew can use when the job processes data.

$sel:configuration:UpdateProfileJob', updateProfileJob_configuration - Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

$sel:timeout:UpdateProfileJob', updateProfileJob_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:jobSample:UpdateProfileJob', updateProfileJob_jobSample - Sample configuration for Profile Jobs only. Determines the number of rows on which the Profile job will be executed. If a JobSample value is not provided for profile jobs, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

$sel:name:UpdateProfileJob', updateProfileJob_name - The name of the job to be updated.

$sel:outputLocation:UpdateProfileJob', updateProfileJob_outputLocation - Undocumented member.

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

Request Lenses

updateProfileJob_encryptionMode :: Lens' UpdateProfileJob (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.

updateProfileJob_logSubscription :: Lens' UpdateProfileJob (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.

updateProfileJob_maxRetries :: Lens' UpdateProfileJob (Maybe Natural) Source #

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

updateProfileJob_encryptionKeyArn :: Lens' UpdateProfileJob (Maybe Text) Source #

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

updateProfileJob_maxCapacity :: Lens' UpdateProfileJob (Maybe Int) Source #

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

updateProfileJob_configuration :: Lens' UpdateProfileJob (Maybe ProfileConfiguration) Source #

Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

updateProfileJob_timeout :: Lens' UpdateProfileJob (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.

updateProfileJob_jobSample :: Lens' UpdateProfileJob (Maybe JobSample) Source #

Sample configuration for Profile Jobs only. Determines the number of rows on which the Profile job will be executed. If a JobSample value is not provided for profile jobs, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

updateProfileJob_name :: Lens' UpdateProfileJob Text Source #

The name of the job to be updated.

updateProfileJob_outputLocation :: Lens' UpdateProfileJob S3Location Source #

Undocumented member.

updateProfileJob_roleArn :: Lens' UpdateProfileJob 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 UpdateProfileJobResponse Source #

See: newUpdateProfileJobResponse smart constructor.

Constructors

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

Instances

Instances details

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

newUpdateProfileJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateProfileJobResponse'`
-> Text	`$sel:name:UpdateProfileJob'`
-> UpdateProfileJobResponse

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

$sel:name:UpdateProfileJob', updateProfileJobResponse_name - The name of the job that was updated.

Response Lenses

updateProfileJobResponse_httpStatus :: Lens' UpdateProfileJobResponse Int Source #

The response's http status code.

updateProfileJobResponse_name :: Lens' UpdateProfileJobResponse Text Source #

The name of the job that was updated.