libZSservicesZSamazonka-databrewZSamazonka-databrew
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DataBrew.DescribeJobRun

Description

Represents one run of a DataBrew job.

Synopsis

Creating a Request

data DescribeJobRun Source #

See: newDescribeJobRun smart constructor.

Constructors

DescribeJobRun' 

Fields

  • name :: Text

    The name of the job being processed during this run.

  • runId :: Text

    The unique identifier of the job run.

Instances

Instances details
Eq DescribeJobRun Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

Read DescribeJobRun Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

Show DescribeJobRun Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

Generic DescribeJobRun Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

Associated Types

type Rep DescribeJobRun :: Type -> Type #

NFData DescribeJobRun Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

Methods

rnf :: DescribeJobRun -> () #

Hashable DescribeJobRun Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

AWSRequest DescribeJobRun Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

Associated Types

type AWSResponse DescribeJobRun #

ToHeaders DescribeJobRun Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

ToPath DescribeJobRun Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

ToQuery DescribeJobRun Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

type Rep DescribeJobRun Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

type Rep DescribeJobRun = D1 ('MetaData "DescribeJobRun" "Amazonka.DataBrew.DescribeJobRun" "libZSservicesZSamazonka-databrewZSamazonka-databrew" 'False) (C1 ('MetaCons "DescribeJobRun'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "runId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeJobRun Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

newDescribeJobRun Source #

Create a value of DescribeJobRun 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:name:DescribeJobRun', describeJobRun_name - The name of the job being processed during this run.

$sel:runId:DescribeJobRun', describeJobRun_runId - The unique identifier of the job run.

Request Lenses

describeJobRun_name :: Lens' DescribeJobRun Text Source #

The name of the job being processed during this run.

describeJobRun_runId :: Lens' DescribeJobRun Text Source #

The unique identifier of the job run.

Destructuring the Response

data DescribeJobRunResponse Source #

See: newDescribeJobRunResponse smart constructor.

Constructors

DescribeJobRunResponse' 

Fields

Instances

Instances details
Eq DescribeJobRunResponse Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

Read DescribeJobRunResponse Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

Show DescribeJobRunResponse Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

Generic DescribeJobRunResponse Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

Associated Types

type Rep DescribeJobRunResponse :: Type -> Type #

NFData DescribeJobRunResponse Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

Methods

rnf :: DescribeJobRunResponse -> () #

type Rep DescribeJobRunResponse Source # 
Instance details

Defined in Amazonka.DataBrew.DescribeJobRun

type Rep DescribeJobRunResponse = D1 ('MetaData "DescribeJobRunResponse" "Amazonka.DataBrew.DescribeJobRun" "libZSservicesZSamazonka-databrewZSamazonka-databrew" 'False) (C1 ('MetaCons "DescribeJobRunResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "completedOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobRunState))) :*: (S1 ('MetaSel ('Just "dataCatalogOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataCatalogOutput))) :*: S1 ('MetaSel ('Just "startedOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "recipeReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecipeReference)) :*: S1 ('MetaSel ('Just "profileConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProfileConfiguration))) :*: (S1 ('MetaSel ('Just "databaseOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DatabaseOutput))) :*: (S1 ('MetaSel ('Just "logGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Output))))))) :*: (((S1 ('MetaSel ('Just "runId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "executionTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "logSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogSubscription)) :*: (S1 ('MetaSel ('Just "startedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "attempt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "jobSample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobSample)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newDescribeJobRunResponse Source #

Create a value of DescribeJobRunResponse 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:completedOn:DescribeJobRunResponse', describeJobRunResponse_completedOn - The date and time when the job completed processing.

$sel:state:DescribeJobRunResponse', describeJobRunResponse_state - The current state of the job run entity itself.

$sel:dataCatalogOutputs:DescribeJobRunResponse', describeJobRunResponse_dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from running the job.

$sel:startedOn:DescribeJobRunResponse', describeJobRunResponse_startedOn - The date and time when the job run began.

$sel:recipeReference:DescribeJobRunResponse', describeJobRunResponse_recipeReference - Undocumented member.

$sel:profileConfiguration:DescribeJobRunResponse', describeJobRunResponse_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.

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

$sel:logGroupName:DescribeJobRunResponse', describeJobRunResponse_logGroupName - The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.

$sel:outputs:DescribeJobRunResponse', describeJobRunResponse_outputs - One or more output artifacts from a job run.

$sel:runId:DescribeJobRun', describeJobRunResponse_runId - The unique identifier of the job run.

$sel:executionTime:DescribeJobRunResponse', describeJobRunResponse_executionTime - The amount of time, in seconds, during which the job run consumed resources.

$sel:logSubscription:DescribeJobRunResponse', describeJobRunResponse_logSubscription - The current status of Amazon CloudWatch logging for the job run.

$sel:startedBy:DescribeJobRunResponse', describeJobRunResponse_startedBy - The Amazon Resource Name (ARN) of the user who started the job run.

$sel:datasetName:DescribeJobRunResponse', describeJobRunResponse_datasetName - The name of the dataset for the job to process.

$sel:attempt:DescribeJobRunResponse', describeJobRunResponse_attempt - The number of times that DataBrew has attempted to run the job.

$sel:errorMessage:DescribeJobRunResponse', describeJobRunResponse_errorMessage - A message indicating an error (if any) that was encountered when the job ran.

$sel:jobSample:DescribeJobRunResponse', describeJobRunResponse_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:httpStatus:DescribeJobRunResponse', describeJobRunResponse_httpStatus - The response's http status code.

$sel:jobName:DescribeJobRunResponse', describeJobRunResponse_jobName - The name of the job being processed during this run.

Response Lenses

describeJobRunResponse_completedOn :: Lens' DescribeJobRunResponse (Maybe UTCTime) Source #

The date and time when the job completed processing.

describeJobRunResponse_state :: Lens' DescribeJobRunResponse (Maybe JobRunState) Source #

The current state of the job run entity itself.

describeJobRunResponse_dataCatalogOutputs :: Lens' DescribeJobRunResponse (Maybe (NonEmpty DataCatalogOutput)) Source #

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

describeJobRunResponse_startedOn :: Lens' DescribeJobRunResponse (Maybe UTCTime) Source #

The date and time when the job run began.

describeJobRunResponse_profileConfiguration :: Lens' DescribeJobRunResponse (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.

describeJobRunResponse_databaseOutputs :: Lens' DescribeJobRunResponse (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.

describeJobRunResponse_logGroupName :: Lens' DescribeJobRunResponse (Maybe Text) Source #

The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.

describeJobRunResponse_outputs :: Lens' DescribeJobRunResponse (Maybe (NonEmpty Output)) Source #

One or more output artifacts from a job run.

describeJobRunResponse_runId :: Lens' DescribeJobRunResponse (Maybe Text) Source #

The unique identifier of the job run.

describeJobRunResponse_executionTime :: Lens' DescribeJobRunResponse (Maybe Int) Source #

The amount of time, in seconds, during which the job run consumed resources.

describeJobRunResponse_logSubscription :: Lens' DescribeJobRunResponse (Maybe LogSubscription) Source #

The current status of Amazon CloudWatch logging for the job run.

describeJobRunResponse_startedBy :: Lens' DescribeJobRunResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who started the job run.

describeJobRunResponse_datasetName :: Lens' DescribeJobRunResponse (Maybe Text) Source #

The name of the dataset for the job to process.

describeJobRunResponse_attempt :: Lens' DescribeJobRunResponse (Maybe Int) Source #

The number of times that DataBrew has attempted to run the job.

describeJobRunResponse_errorMessage :: Lens' DescribeJobRunResponse (Maybe Text) Source #

A message indicating an error (if any) that was encountered when the job ran.

describeJobRunResponse_jobSample :: Lens' DescribeJobRunResponse (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.

describeJobRunResponse_jobName :: Lens' DescribeJobRunResponse Text Source #

The name of the job being processed during this run.