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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the definition of a specific DataBrew job.

Synopsis

data DescribeJob = DescribeJob' {
- name :: Text
}
newDescribeJob :: Text -> DescribeJob
describeJob_name :: Lens' DescribeJob Text
data DescribeJobResponse = DescribeJobResponse' {
- createDate :: Maybe POSIX
- createdBy :: Maybe Text
- dataCatalogOutputs :: Maybe (NonEmpty DataCatalogOutput)
- databaseOutputs :: Maybe (NonEmpty DatabaseOutput)
- datasetName :: Maybe Text
- encryptionKeyArn :: Maybe Text
- encryptionMode :: Maybe EncryptionMode
- jobSample :: Maybe JobSample
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe POSIX
- logSubscription :: Maybe LogSubscription
- maxCapacity :: Maybe Int
- maxRetries :: Maybe Natural
- outputs :: Maybe (NonEmpty Output)
- profileConfiguration :: Maybe ProfileConfiguration
- projectName :: Maybe Text
- recipeReference :: Maybe RecipeReference
- resourceArn :: Maybe Text
- roleArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- timeout :: Maybe Natural
- type' :: Maybe JobType
- validationConfigurations :: Maybe (NonEmpty ValidationConfiguration)
- httpStatus :: Int
- name :: Text
}
newDescribeJobResponse :: Int -> Text -> DescribeJobResponse
describeJobResponse_createDate :: Lens' DescribeJobResponse (Maybe UTCTime)
describeJobResponse_createdBy :: Lens' DescribeJobResponse (Maybe Text)
describeJobResponse_dataCatalogOutputs :: Lens' DescribeJobResponse (Maybe (NonEmpty DataCatalogOutput))
describeJobResponse_databaseOutputs :: Lens' DescribeJobResponse (Maybe (NonEmpty DatabaseOutput))
describeJobResponse_datasetName :: Lens' DescribeJobResponse (Maybe Text)
describeJobResponse_encryptionKeyArn :: Lens' DescribeJobResponse (Maybe Text)
describeJobResponse_encryptionMode :: Lens' DescribeJobResponse (Maybe EncryptionMode)
describeJobResponse_jobSample :: Lens' DescribeJobResponse (Maybe JobSample)
describeJobResponse_lastModifiedBy :: Lens' DescribeJobResponse (Maybe Text)
describeJobResponse_lastModifiedDate :: Lens' DescribeJobResponse (Maybe UTCTime)
describeJobResponse_logSubscription :: Lens' DescribeJobResponse (Maybe LogSubscription)
describeJobResponse_maxCapacity :: Lens' DescribeJobResponse (Maybe Int)
describeJobResponse_maxRetries :: Lens' DescribeJobResponse (Maybe Natural)
describeJobResponse_outputs :: Lens' DescribeJobResponse (Maybe (NonEmpty Output))
describeJobResponse_profileConfiguration :: Lens' DescribeJobResponse (Maybe ProfileConfiguration)
describeJobResponse_projectName :: Lens' DescribeJobResponse (Maybe Text)
describeJobResponse_recipeReference :: Lens' DescribeJobResponse (Maybe RecipeReference)
describeJobResponse_resourceArn :: Lens' DescribeJobResponse (Maybe Text)
describeJobResponse_roleArn :: Lens' DescribeJobResponse (Maybe Text)
describeJobResponse_tags :: Lens' DescribeJobResponse (Maybe (HashMap Text Text))
describeJobResponse_timeout :: Lens' DescribeJobResponse (Maybe Natural)
describeJobResponse_type :: Lens' DescribeJobResponse (Maybe JobType)
describeJobResponse_validationConfigurations :: Lens' DescribeJobResponse (Maybe (NonEmpty ValidationConfiguration))
describeJobResponse_httpStatus :: Lens' DescribeJobResponse Int
describeJobResponse_name :: Lens' DescribeJobResponse Text

Creating a Request

data DescribeJob Source #

See: newDescribeJob smart constructor.

Constructors

DescribeJob'
Fields name :: Text The name of the job to be described.

Instances

Instances details

ToHeaders DescribeJob Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob Methods toHeaders :: DescribeJob -> [Header] #
ToPath DescribeJob Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob Methods toPath :: DescribeJob -> ByteString #
ToQuery DescribeJob Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob Methods toQuery :: DescribeJob -> QueryString #
AWSRequest DescribeJob Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob Associated Types type AWSResponse DescribeJob # Methods request :: (Service -> Service) -> DescribeJob -> Request DescribeJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeJob))) #
Generic DescribeJob Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob Associated Types type Rep DescribeJob :: Type -> Type # Methods from :: DescribeJob -> Rep DescribeJob x # to :: Rep DescribeJob x -> DescribeJob #
Read DescribeJob Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob Methods readsPrec :: Int -> ReadS DescribeJob # readList :: ReadS [DescribeJob] # readPrec :: ReadPrec DescribeJob # readListPrec :: ReadPrec [DescribeJob] #
Show DescribeJob Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob Methods showsPrec :: Int -> DescribeJob -> ShowS # show :: DescribeJob -> String # showList :: [DescribeJob] -> ShowS #
NFData DescribeJob Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob Methods rnf :: DescribeJob -> () #
Eq DescribeJob Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob Methods (==) :: DescribeJob -> DescribeJob -> Bool # (/=) :: DescribeJob -> DescribeJob -> Bool #
Hashable DescribeJob Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob Methods hashWithSalt :: Int -> DescribeJob -> Int # hash :: DescribeJob -> Int #
type AWSResponse DescribeJob Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob type AWSResponse DescribeJob = DescribeJobResponse
type Rep DescribeJob Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob type Rep DescribeJob = D1 ('MetaData "DescribeJob" "Amazonka.DataBrew.DescribeJob" "amazonka-databrew-2.0-GJMXoRzRb387Yq6XNY29RM" 'False) (C1 ('MetaCons "DescribeJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeJob Source #

Arguments

:: Text	`DescribeJob`
-> DescribeJob

Create a value of DescribeJob 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:

DescribeJob, describeJob_name - The name of the job to be described.

Request Lenses

describeJob_name :: Lens' DescribeJob Text Source #

The name of the job to be described.

Destructuring the Response

data DescribeJobResponse Source #

See: newDescribeJobResponse smart constructor.

Constructors

DescribeJobResponse'

Fields

createDate :: Maybe POSIX
The date and time that the job was created.
createdBy :: Maybe Text
The identifier (user name) of the user associated with the creation of the job.
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.
datasetName :: Maybe Text
The dataset that the job acts upon.
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.
jobSample :: Maybe JobSample
Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.
lastModifiedBy :: Maybe Text
The identifier (user name) of the user who last modified the job.
lastModifiedDate :: Maybe POSIX
The date and time that the job was last modified.
logSubscription :: Maybe LogSubscription
Indicates whether Amazon CloudWatch logging is enabled for this job.
maxCapacity :: Maybe Int
The maximum number of compute 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.
profileConfiguration :: 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.
projectName :: Maybe Text
The DataBrew project associated with this job.
recipeReference :: Maybe RecipeReference
resourceArn :: Maybe Text
The Amazon Resource Name (ARN) of the job.
roleArn :: Maybe Text
The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
tags :: Maybe (HashMap Text Text)
Metadata tags associated with 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.
type' :: Maybe JobType
The job type, which must be one of the following:
- PROFILE - The job analyzes the dataset to determine its size, data types, data distribution, and more.
- RECIPE - The job applies one or more transformations to a dataset.
validationConfigurations :: Maybe (NonEmpty ValidationConfiguration)
List of validation configurations that are applied to the profile job.
httpStatus :: Int
The response's http status code.
name :: Text
The name of the job.

Instances

Instances details

Generic DescribeJobResponse Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob Associated Types type Rep DescribeJobResponse :: Type -> Type # Methods from :: DescribeJobResponse -> Rep DescribeJobResponse x # to :: Rep DescribeJobResponse x -> DescribeJobResponse #
Read DescribeJobResponse Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob Methods readsPrec :: Int -> ReadS DescribeJobResponse # readList :: ReadS [DescribeJobResponse] # readPrec :: ReadPrec DescribeJobResponse # readListPrec :: ReadPrec [DescribeJobResponse] #
Show DescribeJobResponse Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob Methods showsPrec :: Int -> DescribeJobResponse -> ShowS # show :: DescribeJobResponse -> String # showList :: [DescribeJobResponse] -> ShowS #
NFData DescribeJobResponse Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob Methods rnf :: DescribeJobResponse -> () #
Eq DescribeJobResponse Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob Methods (==) :: DescribeJobResponse -> DescribeJobResponse -> Bool # (/=) :: DescribeJobResponse -> DescribeJobResponse -> Bool #
type Rep DescribeJobResponse Source #
Instance details Defined in Amazonka.DataBrew.DescribeJob type Rep DescribeJobResponse = D1 ('MetaData "DescribeJobResponse" "Amazonka.DataBrew.DescribeJob" "amazonka-databrew-2.0-GJMXoRzRb387Yq6XNY29RM" 'False) (C1 ('MetaCons "DescribeJobResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "createDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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 "jobSample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobSample)) :: S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (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 "profileConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProfileConfiguration)))) :: (S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "recipeReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecipeReference)) :: S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (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 "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobType)) :: S1 ('MetaSel ('Just "validationConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ValidationConfiguration)))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newDescribeJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeJobResponse'`
-> Text	`DescribeJob`
-> DescribeJobResponse

Create a value of DescribeJobResponse 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:

DescribeJobResponse, describeJobResponse_createDate - The date and time that the job was created.

DescribeJobResponse, describeJobResponse_createdBy - The identifier (user name) of the user associated with the creation of the job.

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

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

DescribeJobResponse, describeJobResponse_datasetName - The dataset that the job acts upon.

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

DescribeJobResponse, describeJobResponse_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.

DescribeJobResponse, describeJobResponse_jobSample - Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.

DescribeJobResponse, describeJobResponse_lastModifiedBy - The identifier (user name) of the user who last modified the job.

DescribeJobResponse, describeJobResponse_lastModifiedDate - The date and time that the job was last modified.

DescribeJobResponse, describeJobResponse_logSubscription - Indicates whether Amazon CloudWatch logging is enabled for this job.

DescribeJobResponse, describeJobResponse_maxCapacity - The maximum number of compute nodes that DataBrew can consume when the job processes data.

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

DescribeJobResponse, describeJobResponse_outputs - One or more artifacts that represent the output from running the job.

$sel:profileConfiguration:DescribeJobResponse', describeJobResponse_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.

DescribeJobResponse, describeJobResponse_projectName - The DataBrew project associated with this job.

DescribeJobResponse, describeJobResponse_recipeReference - Undocumented member.

DescribeJobResponse, describeJobResponse_resourceArn - The Amazon Resource Name (ARN) of the job.

DescribeJobResponse, describeJobResponse_roleArn - The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

DescribeJobResponse, describeJobResponse_tags - Metadata tags associated with this job.

DescribeJobResponse, describeJobResponse_timeout - The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

DescribeJobResponse, describeJobResponse_type - The job type, which must be one of the following:

PROFILE - The job analyzes the dataset to determine its size, data types, data distribution, and more.
RECIPE - The job applies one or more transformations to a dataset.

DescribeJobResponse, describeJobResponse_validationConfigurations - List of validation configurations that are applied to the profile job.

$sel:httpStatus:DescribeJobResponse', describeJobResponse_httpStatus - The response's http status code.

DescribeJob, describeJobResponse_name - The name of the job.

Response Lenses

describeJobResponse_createDate :: Lens' DescribeJobResponse (Maybe UTCTime) Source #

The date and time that the job was created.

describeJobResponse_createdBy :: Lens' DescribeJobResponse (Maybe Text) Source #

The identifier (user name) of the user associated with the creation of the job.

describeJobResponse_dataCatalogOutputs :: Lens' DescribeJobResponse (Maybe (NonEmpty DataCatalogOutput)) Source #

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

describeJobResponse_databaseOutputs :: Lens' DescribeJobResponse (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.

describeJobResponse_datasetName :: Lens' DescribeJobResponse (Maybe Text) Source #

The dataset that the job acts upon.

describeJobResponse_encryptionKeyArn :: Lens' DescribeJobResponse (Maybe Text) Source #

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

describeJobResponse_encryptionMode :: Lens' DescribeJobResponse (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.

describeJobResponse_jobSample :: Lens' DescribeJobResponse (Maybe JobSample) Source #

Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.

describeJobResponse_lastModifiedBy :: Lens' DescribeJobResponse (Maybe Text) Source #

The identifier (user name) of the user who last modified the job.

describeJobResponse_lastModifiedDate :: Lens' DescribeJobResponse (Maybe UTCTime) Source #

The date and time that the job was last modified.

describeJobResponse_logSubscription :: Lens' DescribeJobResponse (Maybe LogSubscription) Source #

Indicates whether Amazon CloudWatch logging is enabled for this job.

describeJobResponse_maxCapacity :: Lens' DescribeJobResponse (Maybe Int) Source #

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

describeJobResponse_maxRetries :: Lens' DescribeJobResponse (Maybe Natural) Source #

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

describeJobResponse_outputs :: Lens' DescribeJobResponse (Maybe (NonEmpty Output)) Source #

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

describeJobResponse_profileConfiguration :: Lens' DescribeJobResponse (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.

describeJobResponse_projectName :: Lens' DescribeJobResponse (Maybe Text) Source #

The DataBrew project associated with this job.

describeJobResponse_recipeReference :: Lens' DescribeJobResponse (Maybe RecipeReference) Source #

Undocumented member.

describeJobResponse_resourceArn :: Lens' DescribeJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the job.

describeJobResponse_roleArn :: Lens' DescribeJobResponse (Maybe Text) Source #

The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

describeJobResponse_tags :: Lens' DescribeJobResponse (Maybe (HashMap Text Text)) Source #

Metadata tags associated with this job.

describeJobResponse_timeout :: Lens' DescribeJobResponse (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.

describeJobResponse_type :: Lens' DescribeJobResponse (Maybe JobType) Source #

The job type, which must be one of the following:

PROFILE - The job analyzes the dataset to determine its size, data types, data distribution, and more.
RECIPE - The job applies one or more transformations to a dataset.

describeJobResponse_validationConfigurations :: Lens' DescribeJobResponse (Maybe (NonEmpty ValidationConfiguration)) Source #

List of validation configurations that are applied to the profile job.

describeJobResponse_httpStatus :: Lens' DescribeJobResponse Int Source #

The response's http status code.

describeJobResponse_name :: Lens' DescribeJobResponse Text Source #

The name of the job.