DescribeDataQualityJobDefinition
Gets the details of a data quality monitoring job definition.
Request Syntax
{
"JobDefinitionName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- JobDefinitionName
-
The name of the data quality monitoring job definition to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$Required: Yes
Response Syntax
{
"CreationTime": number,
"DataQualityAppSpecification": {
"ContainerArguments": [ "string" ],
"ContainerEntrypoint": [ "string" ],
"Environment": {
"string" : "string"
},
"ImageUri": "string",
"PostAnalyticsProcessorSourceUri": "string",
"RecordPreprocessorSourceUri": "string"
},
"DataQualityBaselineConfig": {
"BaseliningJobName": "string",
"ConstraintsResource": {
"S3Uri": "string"
},
"StatisticsResource": {
"S3Uri": "string"
}
},
"DataQualityJobInput": {
"BatchTransformInput": {
"DataCapturedDestinationS3Uri": "string",
"DatasetFormat": {
"Csv": {
"Header": boolean
},
"Json": {
"Line": boolean
},
"Parquet": {
}
},
"EndTimeOffset": "string",
"ExcludeFeaturesAttribute": "string",
"FeaturesAttribute": "string",
"InferenceAttribute": "string",
"LocalPath": "string",
"ProbabilityAttribute": "string",
"ProbabilityThresholdAttribute": number,
"S3DataDistributionType": "string",
"S3InputMode": "string",
"StartTimeOffset": "string"
},
"EndpointInput": {
"EndpointName": "string",
"EndTimeOffset": "string",
"ExcludeFeaturesAttribute": "string",
"FeaturesAttribute": "string",
"InferenceAttribute": "string",
"LocalPath": "string",
"ProbabilityAttribute": "string",
"ProbabilityThresholdAttribute": number,
"S3DataDistributionType": "string",
"S3InputMode": "string",
"StartTimeOffset": "string"
}
},
"DataQualityJobOutputConfig": {
"KmsKeyId": "string",
"MonitoringOutputs": [
{
"S3Output": {
"LocalPath": "string",
"S3UploadMode": "string",
"S3Uri": "string"
}
}
]
},
"JobDefinitionArn": "string",
"JobDefinitionName": "string",
"JobResources": {
"ClusterConfig": {
"InstanceCount": number,
"InstanceType": "string",
"VolumeKmsKeyId": "string",
"VolumeSizeInGB": number
}
},
"NetworkConfig": {
"EnableInterContainerTrafficEncryption": boolean,
"EnableNetworkIsolation": boolean,
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"Subnets": [ "string" ]
}
},
"RoleArn": "string",
"StoppingCondition": {
"MaxRuntimeInSeconds": number
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CreationTime
-
The time that the data quality monitoring job definition was created.
Type: Timestamp
- DataQualityAppSpecification
-
Information about the container that runs the data quality monitoring job.
Type: DataQualityAppSpecification object
- DataQualityBaselineConfig
-
The constraints and baselines for the data quality monitoring job definition.
Type: DataQualityBaselineConfig object
- DataQualityJobInput
-
The list of inputs for the data quality monitoring job. Currently endpoints are supported.
Type: DataQualityJobInput object
- DataQualityJobOutputConfig
-
The output configuration for monitoring jobs.
Type: MonitoringOutputConfig object
- JobDefinitionArn
-
The Amazon Resource Name (ARN) of the data quality monitoring job definition.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
.* - JobDefinitionName
-
The name of the data quality monitoring job definition.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$ - JobResources
-
Identifies the resources to deploy for a monitoring job.
Type: MonitoringResources object
- NetworkConfig
-
The networking configuration for the data quality monitoring job.
Type: MonitoringNetworkConfig object
- RoleArn
-
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ - StoppingCondition
-
A time limit for how long the monitoring job is allowed to run before stopping.
Type: MonitoringStoppingCondition object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
