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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new job to analyze a dataset and create its data profile.

Synopsis

data CreateProfileJob = CreateProfileJob' {
- encryptionMode :: Maybe EncryptionMode
- logSubscription :: Maybe LogSubscription
- maxRetries :: Maybe Natural
- encryptionKeyArn :: Maybe Text
- maxCapacity :: Maybe Int
- configuration :: Maybe ProfileConfiguration
- timeout :: Maybe Natural
- tags :: Maybe (HashMap Text Text)
- jobSample :: Maybe JobSample
- datasetName :: Text
- name :: Text
- outputLocation :: S3Location
- roleArn :: Text
}
newCreateProfileJob :: Text -> Text -> S3Location -> Text -> CreateProfileJob
createProfileJob_encryptionMode :: Lens' CreateProfileJob (Maybe EncryptionMode)
createProfileJob_logSubscription :: Lens' CreateProfileJob (Maybe LogSubscription)
createProfileJob_maxRetries :: Lens' CreateProfileJob (Maybe Natural)
createProfileJob_encryptionKeyArn :: Lens' CreateProfileJob (Maybe Text)
createProfileJob_maxCapacity :: Lens' CreateProfileJob (Maybe Int)
createProfileJob_configuration :: Lens' CreateProfileJob (Maybe ProfileConfiguration)
createProfileJob_timeout :: Lens' CreateProfileJob (Maybe Natural)
createProfileJob_tags :: Lens' CreateProfileJob (Maybe (HashMap Text Text))
createProfileJob_jobSample :: Lens' CreateProfileJob (Maybe JobSample)
createProfileJob_datasetName :: Lens' CreateProfileJob Text
createProfileJob_name :: Lens' CreateProfileJob Text
createProfileJob_outputLocation :: Lens' CreateProfileJob S3Location
createProfileJob_roleArn :: Lens' CreateProfileJob Text
data CreateProfileJobResponse = CreateProfileJobResponse' {
- httpStatus :: Int
- name :: Text
}
newCreateProfileJobResponse :: Int -> Text -> CreateProfileJobResponse
createProfileJobResponse_httpStatus :: Lens' CreateProfileJobResponse Int
createProfileJobResponse_name :: Lens' CreateProfileJobResponse Text

Creating a Request

data CreateProfileJob Source #

See: newCreateProfileJob smart constructor.

Constructors

CreateProfileJob'

Fields

encryptionMode :: Maybe EncryptionMode
The encryption mode for the job, which can be one of the following:
- SSE-KMS - SSE-KMS - Server-side encryption with KMS-managed keys.
- 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 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.
tags :: Maybe (HashMap Text Text)
Metadata tags to apply to this job.
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, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.
datasetName :: Text
The name of the dataset that this job is to act upon.
name :: Text
The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
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 CreateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.CreateProfileJob Methods (==) :: CreateProfileJob -> CreateProfileJob -> Bool # (/=) :: CreateProfileJob -> CreateProfileJob -> Bool #
Read CreateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.CreateProfileJob Methods readsPrec :: Int -> ReadS CreateProfileJob # readList :: ReadS [CreateProfileJob] # readPrec :: ReadPrec CreateProfileJob # readListPrec :: ReadPrec [CreateProfileJob] #
Show CreateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.CreateProfileJob Methods showsPrec :: Int -> CreateProfileJob -> ShowS # show :: CreateProfileJob -> String # showList :: [CreateProfileJob] -> ShowS #
Generic CreateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.CreateProfileJob Associated Types type Rep CreateProfileJob :: Type -> Type # Methods from :: CreateProfileJob -> Rep CreateProfileJob x # to :: Rep CreateProfileJob x -> CreateProfileJob #
NFData CreateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.CreateProfileJob Methods rnf :: CreateProfileJob -> () #
Hashable CreateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.CreateProfileJob Methods hashWithSalt :: Int -> CreateProfileJob -> Int # hash :: CreateProfileJob -> Int #
ToJSON CreateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.CreateProfileJob Methods toJSON :: CreateProfileJob -> Value # toEncoding :: CreateProfileJob -> Encoding # toJSONList :: [CreateProfileJob] -> Value # toEncodingList :: [CreateProfileJob] -> Encoding #
AWSRequest CreateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.CreateProfileJob Associated Types type AWSResponse CreateProfileJob # Methods request :: CreateProfileJob -> Request CreateProfileJob # response :: MonadResource m => Logger -> Service -> Proxy CreateProfileJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateProfileJob))) #
ToHeaders CreateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.CreateProfileJob Methods toHeaders :: CreateProfileJob -> [Header] #
ToPath CreateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.CreateProfileJob Methods toPath :: CreateProfileJob -> ByteString #
ToQuery CreateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.CreateProfileJob Methods toQuery :: CreateProfileJob -> QueryString #
type Rep CreateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.CreateProfileJob type Rep CreateProfileJob = D1 ('MetaData "CreateProfileJob" "Amazonka.DataBrew.CreateProfileJob" "libZSservicesZSamazonka-databrewZSamazonka-databrew" 'False) (C1 ('MetaCons "CreateProfileJob'" '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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "jobSample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobSample)))) :: ((S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: 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 CreateProfileJob Source #
Instance details Defined in Amazonka.DataBrew.CreateProfileJob type AWSResponse CreateProfileJob = CreateProfileJobResponse

newCreateProfileJob Source #

Arguments

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

Create a value of CreateProfileJob 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:CreateProfileJob', createProfileJob_encryptionMode - The encryption mode for the job, which can be one of the following:

SSE-KMS - SSE-KMS - Server-side encryption with KMS-managed keys.
SSE-S3 - Server-side encryption with keys managed by Amazon S3.

$sel:logSubscription:CreateProfileJob', createProfileJob_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:CreateProfileJob', createProfileJob_maxRetries - The maximum number of times to retry the job after a job run fails.

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

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

$sel:configuration:CreateProfileJob', createProfileJob_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:CreateProfileJob', createProfileJob_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:tags:CreateProfileJob', createProfileJob_tags - Metadata tags to apply to this job.

$sel:jobSample:CreateProfileJob', createProfileJob_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, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

$sel:datasetName:CreateProfileJob', createProfileJob_datasetName - The name of the dataset that this job is to act upon.

$sel:name:CreateProfileJob', createProfileJob_name - The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

$sel:outputLocation:CreateProfileJob', createProfileJob_outputLocation - Undocumented member.

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

Request Lenses

createProfileJob_encryptionMode :: Lens' CreateProfileJob (Maybe EncryptionMode) Source #

The encryption mode for the job, which can be one of the following:

SSE-KMS - SSE-KMS - Server-side encryption with KMS-managed keys.
SSE-S3 - Server-side encryption with keys managed by Amazon S3.

createProfileJob_logSubscription :: Lens' CreateProfileJob (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.

createProfileJob_maxRetries :: Lens' CreateProfileJob (Maybe Natural) Source #

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

createProfileJob_encryptionKeyArn :: Lens' CreateProfileJob (Maybe Text) Source #

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

createProfileJob_maxCapacity :: Lens' CreateProfileJob (Maybe Int) Source #

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

createProfileJob_configuration :: Lens' CreateProfileJob (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.

createProfileJob_timeout :: Lens' CreateProfileJob (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.

createProfileJob_tags :: Lens' CreateProfileJob (Maybe (HashMap Text Text)) Source #

Metadata tags to apply to this job.

createProfileJob_jobSample :: Lens' CreateProfileJob (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, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

createProfileJob_datasetName :: Lens' CreateProfileJob Text Source #

The name of the dataset that this job is to act upon.

createProfileJob_name :: Lens' CreateProfileJob Text Source #

The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

createProfileJob_outputLocation :: Lens' CreateProfileJob S3Location Source #

Undocumented member.

createProfileJob_roleArn :: Lens' CreateProfileJob 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 CreateProfileJobResponse Source #

See: newCreateProfileJobResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateProfileJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateProfileJobResponse'`
-> Text	`$sel:name:CreateProfileJob'`
-> CreateProfileJobResponse

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

$sel:name:CreateProfileJob', createProfileJobResponse_name - The name of the job that was created.

Response Lenses

createProfileJobResponse_httpStatus :: Lens' CreateProfileJobResponse Int Source #

The response's http status code.

createProfileJobResponse_name :: Lens' CreateProfileJobResponse Text Source #

The name of the job that was created.