DescribeJobRun
Represents one run of a DataBrew job.
Request Syntax
GET /jobs/name/jobRun/runId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Attempt": number,
"CompletedOn": number,
"DatabaseOutputs": [
{
"DatabaseOptions": {
"TableName": "string",
"TempDirectory": {
"Bucket": "string",
"BucketOwner": "string",
"Key": "string"
}
},
"DatabaseOutputMode": "string",
"GlueConnectionName": "string"
}
],
"DataCatalogOutputs": [
{
"CatalogId": "string",
"DatabaseName": "string",
"DatabaseOptions": {
"TableName": "string",
"TempDirectory": {
"Bucket": "string",
"BucketOwner": "string",
"Key": "string"
}
},
"Overwrite": boolean,
"S3Options": {
"Location": {
"Bucket": "string",
"BucketOwner": "string",
"Key": "string"
}
},
"TableName": "string"
}
],
"DatasetName": "string",
"ErrorMessage": "string",
"ExecutionTime": number,
"JobName": "string",
"JobSample": {
"Mode": "string",
"Size": number
},
"LogGroupName": "string",
"LogSubscription": "string",
"Outputs": [
{
"CompressionFormat": "string",
"Format": "string",
"FormatOptions": {
"Csv": {
"Delimiter": "string"
}
},
"Location": {
"Bucket": "string",
"BucketOwner": "string",
"Key": "string"
},
"MaxOutputFiles": number,
"Overwrite": boolean,
"PartitionColumns": [ "string" ]
}
],
"ProfileConfiguration": {
"ColumnStatisticsConfigurations": [
{
"Selectors": [
{
"Name": "string",
"Regex": "string"
}
],
"Statistics": {
"IncludedStatistics": [ "string" ],
"Overrides": [
{
"Parameters": {
"string" : "string"
},
"Statistic": "string"
}
]
}
}
],
"DatasetStatisticsConfiguration": {
"IncludedStatistics": [ "string" ],
"Overrides": [
{
"Parameters": {
"string" : "string"
},
"Statistic": "string"
}
]
},
"EntityDetectorConfiguration": {
"AllowedStatistics": [
{
"Statistics": [ "string" ]
}
],
"EntityTypes": [ "string" ]
},
"ProfileColumns": [
{
"Name": "string",
"Regex": "string"
}
]
},
"RecipeReference": {
"Name": "string",
"RecipeVersion": "string"
},
"RunId": "string",
"StartedBy": "string",
"StartedOn": number,
"State": "string",
"ValidationConfigurations": [
{
"RulesetArn": "string",
"ValidationMode": "string"
}
]
}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.
- JobName
-
The name of the job being processed during this run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 240.
- Attempt
-
The number of times that DataBrew has attempted to run the job.
Type: Integer
- CompletedOn
-
The date and time when the job completed processing.
Type: Timestamp
- DatabaseOutputs
-
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
Type: Array of DatabaseOutput objects
Array Members: Minimum number of 1 item.
- DataCatalogOutputs
-
One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
Type: Array of DataCatalogOutput objects
Array Members: Minimum number of 1 item.
- DatasetName
-
The name of the dataset for the job to process.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- ErrorMessage
-
A message indicating an error (if any) that was encountered when the job ran.
Type: String
- ExecutionTime
-
The amount of time, in seconds, during which the job run consumed resources.
Type: Integer
- 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.
Type: JobSample object
- LogGroupName
-
The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
- LogSubscription
-
The current status of Amazon CloudWatch logging for the job run.
Type: String
Valid Values:
ENABLE | DISABLE - Outputs
-
One or more output artifacts from a job run.
Type: Array of Output objects
Array Members: Minimum number of 1 item.
- 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.
Type: ProfileConfiguration object
- RecipeReference
-
Represents the name and version of a DataBrew recipe.
Type: RecipeReference object
- RunId
-
The unique identifier of the job run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- StartedBy
-
The Amazon Resource Name (ARN) of the user who started the job run.
Type: String
- StartedOn
-
The date and time when the job run began.
Type: Timestamp
- State
-
The current state of the job run entity itself.
Type: String
Valid Values:
STARTING | RUNNING | STOPPING | STOPPED | SUCCEEDED | FAILED | TIMEOUT - ValidationConfigurations
-
List of validation configurations that are applied to the profile job.
Type: Array of ValidationConfiguration objects
Array Members: Minimum number of 1 item.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFoundException
-
One or more resources can't be found.
HTTP Status Code: 404
- ValidationException
-
The input parameters for this request failed validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
