Package software.amazon.awscdk.services.glue.alpha

Interface IJob

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IGrantable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IJob.Jsii$Default

All Known Implementing Classes:

IJob.Jsii$Proxy, Job

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)",
           date="2024-01-13T02:49:34.235Z")
@Stability(Experimental)
public interface IJob
extends software.amazon.jsii.JsiiSerializable, IResource, IGrantable

(experimental) Interface representing a created or an imported Job.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IJob.Jsii$Default	Internal default implementation for IJob.
static final class	IJob.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	getJobArn()	(experimental) The ARN of the job.
String	getJobName()	(experimental) The name of the job.
Metric	metric(String metricName, MetricType type)	(experimental) Create a CloudWatch metric.
Metric	metric(String metricName, MetricType type, MetricOptions props)	(experimental) Create a CloudWatch metric.
Metric	metricFailure()	(experimental) Create a CloudWatch Metric indicating job failure.
Metric	metricFailure(MetricOptions props)	(experimental) Create a CloudWatch Metric indicating job failure.
Metric	metricSuccess()	(experimental) Create a CloudWatch Metric indicating job success.
Metric	metricSuccess(MetricOptions props)	(experimental) Create a CloudWatch Metric indicating job success.
Metric	metricTimeout()	(experimental) Create a CloudWatch Metric indicating job timeout.
Metric	metricTimeout(MetricOptions props)	(experimental) Create a CloudWatch Metric indicating job timeout.
Rule	onEvent(String id)	(experimental) Defines a CloudWatch event rule triggered when something happens with this job.
Rule	onEvent(String id, OnEventOptions options)	(experimental) Defines a CloudWatch event rule triggered when something happens with this job.
Rule	onFailure(String id)	(experimental) Defines a CloudWatch event rule triggered when this job moves to the FAILED state.
Rule	onFailure(String id, OnEventOptions options)	(experimental) Defines a CloudWatch event rule triggered when this job moves to the FAILED state.
Rule	onStateChange(String id, JobState jobState)	(experimental) Defines a CloudWatch event rule triggered when this job moves to the input jobState.
Rule	onStateChange(String id, JobState jobState, OnEventOptions options)	(experimental) Defines a CloudWatch event rule triggered when this job moves to the input jobState.
Rule	onSuccess(String id)	(experimental) Defines a CloudWatch event rule triggered when this job moves to the SUCCEEDED state.
Rule	onSuccess(String id, OnEventOptions options)	(experimental) Defines a CloudWatch event rule triggered when this job moves to the SUCCEEDED state.
Rule	onTimeout(String id)	(experimental) Defines a CloudWatch event rule triggered when this job moves to the TIMEOUT state.
Rule	onTimeout(String id, OnEventOptions options)	(experimental) Defines a CloudWatch event rule triggered when this job moves to the TIMEOUT state.

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.services.iam.IGrantable

getGrantPrincipal

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getJobArn

@Stability(Experimental)
@NotNull
String getJobArn()

(experimental) The ARN of the job.

getJobName

@Stability(Experimental)
@NotNull
String getJobName()

(experimental) The name of the job.

metric

@Stability(Experimental)
@NotNull
Metric metric(@NotNull
 String metricName,
 @NotNull
 MetricType type,
 @Nullable
 MetricOptions props)

(experimental) Create a CloudWatch metric.

Parameters:

metricName - name of the metric typically prefixed with glue.driver., glue.<executorId>. or glue.ALL.. This parameter is required.

type - the metric type. This parameter is required.

props - metric options.

See Also:

• https://docs.aws.amazon.com/glue/latest/dg/monitoring-awsglue-with-cloudwatch-metrics.html

metric

@Stability(Experimental)
@NotNull
Metric metric(@NotNull
 String metricName,
 @NotNull
 MetricType type)

(experimental) Create a CloudWatch metric.

Parameters:

metricName - name of the metric typically prefixed with glue.driver., glue.<executorId>. or glue.ALL.. This parameter is required.

type - the metric type. This parameter is required.

See Also:

• https://docs.aws.amazon.com/glue/latest/dg/monitoring-awsglue-with-cloudwatch-metrics.html

metricFailure

@Stability(Experimental)
@NotNull
Metric metricFailure(@Nullable
 MetricOptions props)

(experimental) Create a CloudWatch Metric indicating job failure.

Parameters:

props -

metricFailure

@Stability(Experimental)
@NotNull
Metric metricFailure()

(experimental) Create a CloudWatch Metric indicating job failure.

metricSuccess

@Stability(Experimental)
@NotNull
Metric metricSuccess(@Nullable
 MetricOptions props)

(experimental) Create a CloudWatch Metric indicating job success.

Parameters:

props -

metricSuccess

@Stability(Experimental)
@NotNull
Metric metricSuccess()

(experimental) Create a CloudWatch Metric indicating job success.

metricTimeout

@Stability(Experimental)
@NotNull
Metric metricTimeout(@Nullable
 MetricOptions props)

(experimental) Create a CloudWatch Metric indicating job timeout.

Parameters:

props -

metricTimeout

@Stability(Experimental)
@NotNull
Metric metricTimeout()

(experimental) Create a CloudWatch Metric indicating job timeout.

onEvent

@Stability(Experimental)
@NotNull
Rule onEvent(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Defines a CloudWatch event rule triggered when something happens with this job.

Parameters:

id - This parameter is required.

options -

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onEvent

@Stability(Experimental)
@NotNull
Rule onEvent(@NotNull
 String id)

(experimental) Defines a CloudWatch event rule triggered when something happens with this job.

Parameters:

id - This parameter is required.

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onFailure

@Stability(Experimental)
@NotNull
Rule onFailure(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Defines a CloudWatch event rule triggered when this job moves to the FAILED state.

Parameters:

id - This parameter is required.

options -

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onFailure

@Stability(Experimental)
@NotNull
Rule onFailure(@NotNull
 String id)

(experimental) Defines a CloudWatch event rule triggered when this job moves to the FAILED state.

Parameters:

id - This parameter is required.

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onStateChange

@Stability(Experimental)
@NotNull
Rule onStateChange(@NotNull
 String id,
 @NotNull
 JobState jobState,
 @Nullable
 OnEventOptions options)

(experimental) Defines a CloudWatch event rule triggered when this job moves to the input jobState.

Parameters:

id - This parameter is required.

jobState - This parameter is required.

options -

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onStateChange

@Stability(Experimental)
@NotNull
Rule onStateChange(@NotNull
 String id,
 @NotNull
 JobState jobState)

(experimental) Defines a CloudWatch event rule triggered when this job moves to the input jobState.

Parameters:

id - This parameter is required.

jobState - This parameter is required.

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onSuccess

@Stability(Experimental)
@NotNull
Rule onSuccess(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Defines a CloudWatch event rule triggered when this job moves to the SUCCEEDED state.

Parameters:

id - This parameter is required.

options -

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onSuccess

@Stability(Experimental)
@NotNull
Rule onSuccess(@NotNull
 String id)

(experimental) Defines a CloudWatch event rule triggered when this job moves to the SUCCEEDED state.

Parameters:

id - This parameter is required.

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onTimeout

@Stability(Experimental)
@NotNull
Rule onTimeout(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Defines a CloudWatch event rule triggered when this job moves to the TIMEOUT state.

Parameters:

id - This parameter is required.

options -

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onTimeout

@Stability(Experimental)
@NotNull
Rule onTimeout(@NotNull
 String id)

(experimental) Defines a CloudWatch event rule triggered when this job moves to the TIMEOUT state.

Parameters:

id - This parameter is required.

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types