CreateJob
Creates a new job definition.
Request Syntax
{
"AllocatedCapacity": number,
"CodeGenConfigurationNodes": {
"string" : {
"Aggregate": {
"Aggs": [
{
"AggFunc": "string",
"Column": [ "string" ]
}
],
"Groups": [
[ "string" ]
],
"Inputs": [ "string" ],
"Name": "string"
},
"AmazonRedshiftSource": {
"Data": {
"AccessType": "string",
"Action": "string",
"AdvancedOptions": [
{
"Key": "string",
"Value": "string"
}
],
"CatalogDatabase": {
"Description": "string",
"Label": "string",
"Value": "string"
},
"CatalogRedshiftSchema": "string",
"CatalogRedshiftTable": "string",
"CatalogTable": {
"Description": "string",
"Label": "string",
"Value": "string"
},
"Connection": {
"Description": "string",
"Label": "string",
"Value": "string"
},
"CrawlerConnection": "string",
"IamRole": {
"Description": "string",
"Label": "string",
"Value": "string"
},
"MergeAction": "string",
"MergeClause": "string",
"MergeWhenMatched": "string",
"MergeWhenNotMatched": "string",
"PostAction": "string",
"PreAction": "string",
"SampleQuery": "string",
"Schema": {
"Description": "string",
"Label": "string",
"Value": "string"
},
"SelectedColumns": [
{
"Description": "string",
"Label": "string",
"Value": "string"
}
],
"SourceType": "string",
"StagingTable": "string",
"Table": {
"Description": "string",
"Label": "string",
"Value": "string"
},
"TablePrefix": "string",
"TableSchema": [
{
"Description": "string",
"Label": "string",
"Value": "string"
}
],
"TempDir": "string",
"Upsert": boolean
},
"Name": "string"
},
"AmazonRedshiftTarget": {
"Data": {
"AccessType": "string",
"Action": "string",
"AdvancedOptions": [
{
"Key": "string",
"Value": "string"
}
],
"CatalogDatabase": {
"Description": "string",
"Label": "string",
"Value": "string"
},
"CatalogRedshiftSchema": "string",
"CatalogRedshiftTable": "string",
"CatalogTable": {
"Description": "string",
"Label": "string",
"Value": "string"
},
"Connection": {
"Description": "string",
"Label": "string",
"Value": "string"
},
"CrawlerConnection": "string",
"IamRole": {
"Description": "string",
"Label": "string",
"Value": "string"
},
"MergeAction": "string",
"MergeClause": "string",
"MergeWhenMatched": "string",
"MergeWhenNotMatched": "string",
"PostAction": "string",
"PreAction": "string",
"SampleQuery": "string",
"Schema": {
"Description": "string",
"Label": "string",
"Value": "string"
},
"SelectedColumns": [
{
"Description": "string",
"Label": "string",
"Value": "string"
}
],
"SourceType": "string",
"StagingTable": "string",
"Table": {
"Description": "string",
"Label": "string",
"Value": "string"
},
"TablePrefix": "string",
"TableSchema": [
{
"Description": "string",
"Label": "string",
"Value": "string"
}
],
"TempDir": "string",
"Upsert": boolean
},
"Inputs": [ "string" ],
"Name": "string"
},
"ApplyMapping": {
"Inputs": [ "string" ],
"Mapping": [
{
"Children": [
"Mapping"
],
"Dropped": boolean,
"FromPath": [ "string" ],
"FromType": "string",
"ToKey": "string",
"ToType": "string"
}
],
"Name": "string"
},
"AthenaConnectorSource": {
"ConnectionName": "string",
"ConnectionTable": "string",
"ConnectionType": "string",
"ConnectorName": "string",
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
],
"SchemaName": "string"
},
"CatalogDeltaSource": {
"AdditionalDeltaOptions": {
"string" : "string"
},
"Database": "string",
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
],
"Table": "string"
},
"CatalogHudiSource": {
"AdditionalHudiOptions": {
"string" : "string"
},
"Database": "string",
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
],
"Table": "string"
},
"CatalogKafkaSource": {
"Database": "string",
"DataPreviewOptions": {
"PollingTime": number,
"RecordPollingLimit": number
},
"DetectSchema": boolean,
"Name": "string",
"StreamingOptions": {
"AddRecordTimestamp": "string",
"Assign": "string",
"BootstrapServers": "string",
"Classification": "string",
"ConnectionName": "string",
"Delimiter": "string",
"EmitConsumerLagMetrics": "string",
"EndingOffsets": "string",
"IncludeHeaders": boolean,
"MaxOffsetsPerTrigger": number,
"MinPartitions": number,
"NumRetries": number,
"PollTimeoutMs": number,
"RetryIntervalMs": number,
"SecurityProtocol": "string",
"StartingOffsets": "string",
"StartingTimestamp": "string",
"SubscribePattern": "string",
"TopicName": "string"
},
"Table": "string",
"WindowSize": number
},
"CatalogKinesisSource": {
"Database": "string",
"DataPreviewOptions": {
"PollingTime": number,
"RecordPollingLimit": number
},
"DetectSchema": boolean,
"Name": "string",
"StreamingOptions": {
"AddIdleTimeBetweenReads": boolean,
"AddRecordTimestamp": "string",
"AvoidEmptyBatches": boolean,
"Classification": "string",
"Delimiter": "string",
"DescribeShardInterval": number,
"EmitConsumerLagMetrics": "string",
"EndpointUrl": "string",
"IdleTimeBetweenReadsInMs": number,
"MaxFetchRecordsPerShard": number,
"MaxFetchTimeInMs": number,
"MaxRecordPerRead": number,
"MaxRetryIntervalMs": number,
"NumRetries": number,
"RetryIntervalMs": number,
"RoleArn": "string",
"RoleSessionName": "string",
"StartingPosition": "string",
"StartingTimestamp": "string",
"StreamArn": "string",
"StreamName": "string"
},
"Table": "string",
"WindowSize": number
},
"CatalogSource": {
"Database": "string",
"Name": "string",
"Table": "string"
},
"CatalogTarget": {
"Database": "string",
"Inputs": [ "string" ],
"Name": "string",
"PartitionKeys": [
[ "string" ]
],
"Table": "string"
},
"ConnectorDataSource": {
"ConnectionType": "string",
"Data": {
"string" : "string"
},
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
]
},
"ConnectorDataTarget": {
"ConnectionType": "string",
"Data": {
"string" : "string"
},
"Inputs": [ "string" ],
"Name": "string"
},
"CustomCode": {
"ClassName": "string",
"Code": "string",
"Inputs": [ "string" ],
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
]
},
"DirectJDBCSource": {
"ConnectionName": "string",
"ConnectionType": "string",
"Database": "string",
"Name": "string",
"RedshiftTmpDir": "string",
"Table": "string"
},
"DirectKafkaSource": {
"DataPreviewOptions": {
"PollingTime": number,
"RecordPollingLimit": number
},
"DetectSchema": boolean,
"Name": "string",
"StreamingOptions": {
"AddRecordTimestamp": "string",
"Assign": "string",
"BootstrapServers": "string",
"Classification": "string",
"ConnectionName": "string",
"Delimiter": "string",
"EmitConsumerLagMetrics": "string",
"EndingOffsets": "string",
"IncludeHeaders": boolean,
"MaxOffsetsPerTrigger": number,
"MinPartitions": number,
"NumRetries": number,
"PollTimeoutMs": number,
"RetryIntervalMs": number,
"SecurityProtocol": "string",
"StartingOffsets": "string",
"StartingTimestamp": "string",
"SubscribePattern": "string",
"TopicName": "string"
},
"WindowSize": number
},
"DirectKinesisSource": {
"DataPreviewOptions": {
"PollingTime": number,
"RecordPollingLimit": number
},
"DetectSchema": boolean,
"Name": "string",
"StreamingOptions": {
"AddIdleTimeBetweenReads": boolean,
"AddRecordTimestamp": "string",
"AvoidEmptyBatches": boolean,
"Classification": "string",
"Delimiter": "string",
"DescribeShardInterval": number,
"EmitConsumerLagMetrics": "string",
"EndpointUrl": "string",
"IdleTimeBetweenReadsInMs": number,
"MaxFetchRecordsPerShard": number,
"MaxFetchTimeInMs": number,
"MaxRecordPerRead": number,
"MaxRetryIntervalMs": number,
"NumRetries": number,
"RetryIntervalMs": number,
"RoleArn": "string",
"RoleSessionName": "string",
"StartingPosition": "string",
"StartingTimestamp": "string",
"StreamArn": "string",
"StreamName": "string"
},
"WindowSize": number
},
"DropDuplicates": {
"Columns": [
[ "string" ]
],
"Inputs": [ "string" ],
"Name": "string"
},
"DropFields": {
"Inputs": [ "string" ],
"Name": "string",
"Paths": [
[ "string" ]
]
},
"DropNullFields": {
"Inputs": [ "string" ],
"Name": "string",
"NullCheckBoxList": {
"IsEmpty": boolean,
"IsNegOne": boolean,
"IsNullString": boolean
},
"NullTextList": [
{
"Datatype": {
"Id": "string",
"Label": "string"
},
"Value": "string"
}
]
},
"DynamicTransform": {
"FunctionName": "string",
"Inputs": [ "string" ],
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
],
"Parameters": [
{
"IsOptional": boolean,
"ListType": "string",
"Name": "string",
"Type": "string",
"ValidationMessage": "string",
"ValidationRule": "string",
"Value": [ "string" ]
}
],
"Path": "string",
"TransformName": "string",
"Version": "string"
},
"DynamoDBCatalogSource": {
"Database": "string",
"Name": "string",
"Table": "string"
},
"EvaluateDataQuality": {
"Inputs": [ "string" ],
"Name": "string",
"Output": "string",
"PublishingOptions": {
"CloudWatchMetricsEnabled": boolean,
"EvaluationContext": "string",
"ResultsPublishingEnabled": boolean,
"ResultsS3Prefix": "string"
},
"Ruleset": "string",
"StopJobOnFailureOptions": {
"StopJobOnFailureTiming": "string"
}
},
"EvaluateDataQualityMultiFrame": {
"AdditionalDataSources": {
"string" : "string"
},
"AdditionalOptions": {
"string" : "string"
},
"Inputs": [ "string" ],
"Name": "string",
"PublishingOptions": {
"CloudWatchMetricsEnabled": boolean,
"EvaluationContext": "string",
"ResultsPublishingEnabled": boolean,
"ResultsS3Prefix": "string"
},
"Ruleset": "string",
"StopJobOnFailureOptions": {
"StopJobOnFailureTiming": "string"
}
},
"FillMissingValues": {
"FilledPath": "string",
"ImputedPath": "string",
"Inputs": [ "string" ],
"Name": "string"
},
"Filter": {
"Filters": [
{
"Negated": boolean,
"Operation": "string",
"Values": [
{
"Type": "string",
"Value": [ "string" ]
}
]
}
],
"Inputs": [ "string" ],
"LogicalOperator": "string",
"Name": "string"
},
"GovernedCatalogSource": {
"AdditionalOptions": {
"BoundedFiles": number,
"BoundedSize": number
},
"Database": "string",
"Name": "string",
"PartitionPredicate": "string",
"Table": "string"
},
"GovernedCatalogTarget": {
"Database": "string",
"Inputs": [ "string" ],
"Name": "string",
"PartitionKeys": [
[ "string" ]
],
"SchemaChangePolicy": {
"EnableUpdateCatalog": boolean,
"UpdateBehavior": "string"
},
"Table": "string"
},
"JDBCConnectorSource": {
"AdditionalOptions": {
"DataTypeMapping": {
"string" : "string"
},
"FilterPredicate": "string",
"JobBookmarkKeys": [ "string" ],
"JobBookmarkKeysSortOrder": "string",
"LowerBound": number,
"NumPartitions": number,
"PartitionColumn": "string",
"UpperBound": number
},
"ConnectionName": "string",
"ConnectionTable": "string",
"ConnectionType": "string",
"ConnectorName": "string",
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
],
"Query": "string"
},
"JDBCConnectorTarget": {
"AdditionalOptions": {
"string" : "string"
},
"ConnectionName": "string",
"ConnectionTable": "string",
"ConnectionType": "string",
"ConnectorName": "string",
"Inputs": [ "string" ],
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
]
},
"Join": {
"Columns": [
{
"From": "string",
"Keys": [
[ "string" ]
]
}
],
"Inputs": [ "string" ],
"JoinType": "string",
"Name": "string"
},
"Merge": {
"Inputs": [ "string" ],
"Name": "string",
"PrimaryKeys": [
[ "string" ]
],
"Source": "string"
},
"MicrosoftSQLServerCatalogSource": {
"Database": "string",
"Name": "string",
"Table": "string"
},
"MicrosoftSQLServerCatalogTarget": {
"Database": "string",
"Inputs": [ "string" ],
"Name": "string",
"Table": "string"
},
"MySQLCatalogSource": {
"Database": "string",
"Name": "string",
"Table": "string"
},
"MySQLCatalogTarget": {
"Database": "string",
"Inputs": [ "string" ],
"Name": "string",
"Table": "string"
},
"OracleSQLCatalogSource": {
"Database": "string",
"Name": "string",
"Table": "string"
},
"OracleSQLCatalogTarget": {
"Database": "string",
"Inputs": [ "string" ],
"Name": "string",
"Table": "string"
},
"PIIDetection": {
"EntityTypesToDetect": [ "string" ],
"Inputs": [ "string" ],
"MaskValue": "string",
"Name": "string",
"OutputColumnName": "string",
"PiiType": "string",
"SampleFraction": number,
"ThresholdFraction": number
},
"PostgreSQLCatalogSource": {
"Database": "string",
"Name": "string",
"Table": "string"
},
"PostgreSQLCatalogTarget": {
"Database": "string",
"Inputs": [ "string" ],
"Name": "string",
"Table": "string"
},
"Recipe": {
"Inputs": [ "string" ],
"Name": "string",
"RecipeReference": {
"RecipeArn": "string",
"RecipeVersion": "string"
},
"RecipeSteps": [
{
"Action": {
"Operation": "string",
"Parameters": {
"string" : "string"
}
},
"ConditionExpressions": [
{
"Condition": "string",
"TargetColumn": "string",
"Value": "string"
}
]
}
]
},
"RedshiftSource": {
"Database": "string",
"Name": "string",
"RedshiftTmpDir": "string",
"Table": "string",
"TmpDirIAMRole": "string"
},
"RedshiftTarget": {
"Database": "string",
"Inputs": [ "string" ],
"Name": "string",
"RedshiftTmpDir": "string",
"Table": "string",
"TmpDirIAMRole": "string",
"UpsertRedshiftOptions": {
"ConnectionName": "string",
"TableLocation": "string",
"UpsertKeys": [ "string" ]
}
},
"RelationalCatalogSource": {
"Database": "string",
"Name": "string",
"Table": "string"
},
"RenameField": {
"Inputs": [ "string" ],
"Name": "string",
"SourcePath": [ "string" ],
"TargetPath": [ "string" ]
},
"S3CatalogDeltaSource": {
"AdditionalDeltaOptions": {
"string" : "string"
},
"Database": "string",
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
],
"Table": "string"
},
"S3CatalogHudiSource": {
"AdditionalHudiOptions": {
"string" : "string"
},
"Database": "string",
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
],
"Table": "string"
},
"S3CatalogSource": {
"AdditionalOptions": {
"BoundedFiles": number,
"BoundedSize": number
},
"Database": "string",
"Name": "string",
"PartitionPredicate": "string",
"Table": "string"
},
"S3CatalogTarget": {
"Database": "string",
"Inputs": [ "string" ],
"Name": "string",
"PartitionKeys": [
[ "string" ]
],
"SchemaChangePolicy": {
"EnableUpdateCatalog": boolean,
"UpdateBehavior": "string"
},
"Table": "string"
},
"S3CsvSource": {
"AdditionalOptions": {
"BoundedFiles": number,
"BoundedSize": number,
"EnableSamplePath": boolean,
"SamplePath": "string"
},
"CompressionType": "string",
"Escaper": "string",
"Exclusions": [ "string" ],
"GroupFiles": "string",
"GroupSize": "string",
"MaxBand": number,
"MaxFilesInBand": number,
"Multiline": boolean,
"Name": "string",
"OptimizePerformance": boolean,
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
],
"Paths": [ "string" ],
"QuoteChar": "string",
"Recurse": boolean,
"Separator": "string",
"SkipFirst": boolean,
"WithHeader": boolean,
"WriteHeader": boolean
},
"S3DeltaCatalogTarget": {
"AdditionalOptions": {
"string" : "string"
},
"Database": "string",
"Inputs": [ "string" ],
"Name": "string",
"PartitionKeys": [
[ "string" ]
],
"SchemaChangePolicy": {
"EnableUpdateCatalog": boolean,
"UpdateBehavior": "string"
},
"Table": "string"
},
"S3DeltaDirectTarget": {
"AdditionalOptions": {
"string" : "string"
},
"Compression": "string",
"Format": "string",
"Inputs": [ "string" ],
"Name": "string",
"PartitionKeys": [
[ "string" ]
],
"Path": "string",
"SchemaChangePolicy": {
"Database": "string",
"EnableUpdateCatalog": boolean,
"Table": "string",
"UpdateBehavior": "string"
}
},
"S3DeltaSource": {
"AdditionalDeltaOptions": {
"string" : "string"
},
"AdditionalOptions": {
"BoundedFiles": number,
"BoundedSize": number,
"EnableSamplePath": boolean,
"SamplePath": "string"
},
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
],
"Paths": [ "string" ]
},
"S3DirectTarget": {
"Compression": "string",
"Format": "string",
"Inputs": [ "string" ],
"Name": "string",
"PartitionKeys": [
[ "string" ]
],
"Path": "string",
"SchemaChangePolicy": {
"Database": "string",
"EnableUpdateCatalog": boolean,
"Table": "string",
"UpdateBehavior": "string"
}
},
"S3GlueParquetTarget": {
"Compression": "string",
"Inputs": [ "string" ],
"Name": "string",
"PartitionKeys": [
[ "string" ]
],
"Path": "string",
"SchemaChangePolicy": {
"Database": "string",
"EnableUpdateCatalog": boolean,
"Table": "string",
"UpdateBehavior": "string"
}
},
"S3HudiCatalogTarget": {
"AdditionalOptions": {
"string" : "string"
},
"Database": "string",
"Inputs": [ "string" ],
"Name": "string",
"PartitionKeys": [
[ "string" ]
],
"SchemaChangePolicy": {
"EnableUpdateCatalog": boolean,
"UpdateBehavior": "string"
},
"Table": "string"
},
"S3HudiDirectTarget": {
"AdditionalOptions": {
"string" : "string"
},
"Compression": "string",
"Format": "string",
"Inputs": [ "string" ],
"Name": "string",
"PartitionKeys": [
[ "string" ]
],
"Path": "string",
"SchemaChangePolicy": {
"Database": "string",
"EnableUpdateCatalog": boolean,
"Table": "string",
"UpdateBehavior": "string"
}
},
"S3HudiSource": {
"AdditionalHudiOptions": {
"string" : "string"
},
"AdditionalOptions": {
"BoundedFiles": number,
"BoundedSize": number,
"EnableSamplePath": boolean,
"SamplePath": "string"
},
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
],
"Paths": [ "string" ]
},
"S3JsonSource": {
"AdditionalOptions": {
"BoundedFiles": number,
"BoundedSize": number,
"EnableSamplePath": boolean,
"SamplePath": "string"
},
"CompressionType": "string",
"Exclusions": [ "string" ],
"GroupFiles": "string",
"GroupSize": "string",
"JsonPath": "string",
"MaxBand": number,
"MaxFilesInBand": number,
"Multiline": boolean,
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
],
"Paths": [ "string" ],
"Recurse": boolean
},
"S3ParquetSource": {
"AdditionalOptions": {
"BoundedFiles": number,
"BoundedSize": number,
"EnableSamplePath": boolean,
"SamplePath": "string"
},
"CompressionType": "string",
"Exclusions": [ "string" ],
"GroupFiles": "string",
"GroupSize": "string",
"MaxBand": number,
"MaxFilesInBand": number,
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
],
"Paths": [ "string" ],
"Recurse": boolean
},
"SelectFields": {
"Inputs": [ "string" ],
"Name": "string",
"Paths": [
[ "string" ]
]
},
"SelectFromCollection": {
"Index": number,
"Inputs": [ "string" ],
"Name": "string"
},
"SnowflakeSource": {
"Data": {
"Action": "string",
"AdditionalOptions": {
"string" : "string"
},
"AutoPushdown": boolean,
"Connection": {
"Description": "string",
"Label": "string",
"Value": "string"
},
"Database": "string",
"IamRole": {
"Description": "string",
"Label": "string",
"Value": "string"
},
"MergeAction": "string",
"MergeClause": "string",
"MergeWhenMatched": "string",
"MergeWhenNotMatched": "string",
"PostAction": "string",
"PreAction": "string",
"SampleQuery": "string",
"Schema": "string",
"SelectedColumns": [
{
"Description": "string",
"Label": "string",
"Value": "string"
}
],
"SourceType": "string",
"StagingTable": "string",
"Table": "string",
"TableSchema": [
{
"Description": "string",
"Label": "string",
"Value": "string"
}
],
"TempDir": "string",
"Upsert": boolean
},
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
]
},
"SnowflakeTarget": {
"Data": {
"Action": "string",
"AdditionalOptions": {
"string" : "string"
},
"AutoPushdown": boolean,
"Connection": {
"Description": "string",
"Label": "string",
"Value": "string"
},
"Database": "string",
"IamRole": {
"Description": "string",
"Label": "string",
"Value": "string"
},
"MergeAction": "string",
"MergeClause": "string",
"MergeWhenMatched": "string",
"MergeWhenNotMatched": "string",
"PostAction": "string",
"PreAction": "string",
"SampleQuery": "string",
"Schema": "string",
"SelectedColumns": [
{
"Description": "string",
"Label": "string",
"Value": "string"
}
],
"SourceType": "string",
"StagingTable": "string",
"Table": "string",
"TableSchema": [
{
"Description": "string",
"Label": "string",
"Value": "string"
}
],
"TempDir": "string",
"Upsert": boolean
},
"Inputs": [ "string" ],
"Name": "string"
},
"SparkConnectorSource": {
"AdditionalOptions": {
"string" : "string"
},
"ConnectionName": "string",
"ConnectionType": "string",
"ConnectorName": "string",
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
]
},
"SparkConnectorTarget": {
"AdditionalOptions": {
"string" : "string"
},
"ConnectionName": "string",
"ConnectionType": "string",
"ConnectorName": "string",
"Inputs": [ "string" ],
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
]
},
"SparkSQL": {
"Inputs": [ "string" ],
"Name": "string",
"OutputSchemas": [
{
"Columns": [
{
"Name": "string",
"Type": "string"
}
]
}
],
"SqlAliases": [
{
"Alias": "string",
"From": "string"
}
],
"SqlQuery": "string"
},
"Spigot": {
"Inputs": [ "string" ],
"Name": "string",
"Path": "string",
"Prob": number,
"Topk": number
},
"SplitFields": {
"Inputs": [ "string" ],
"Name": "string",
"Paths": [
[ "string" ]
]
},
"Union": {
"Inputs": [ "string" ],
"Name": "string",
"UnionType": "string"
}
}
},
"Command": {
"Name": "string",
"PythonVersion": "string",
"Runtime": "string",
"ScriptLocation": "string"
},
"Connections": {
"Connections": [ "string" ]
},
"DefaultArguments": {
"string" : "string"
},
"Description": "string",
"ExecutionClass": "string",
"ExecutionProperty": {
"MaxConcurrentRuns": number
},
"GlueVersion": "string",
"JobMode": "string",
"JobRunQueuingEnabled": boolean,
"LogUri": "string",
"MaintenanceWindow": "string",
"MaxCapacity": number,
"MaxRetries": number,
"Name": "string",
"NonOverridableArguments": {
"string" : "string"
},
"NotificationProperty": {
"NotifyDelayAfter": number
},
"NumberOfWorkers": number,
"Role": "string",
"SecurityConfiguration": "string",
"SourceControlDetails": {
"AuthStrategy": "string",
"AuthToken": "string",
"Branch": "string",
"Folder": "string",
"LastCommitId": "string",
"Owner": "string",
"Provider": "string",
"Repository": "string"
},
"Tags": {
"string" : "string"
},
"Timeout": number,
"WorkerType": "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.
- AllocatedCapacity
-
This parameter is deprecated. Use
MaxCapacityinstead.The number of AWS Glue data processing units (DPUs) to allocate to this Job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page
. Type: Integer
Required: No
- CodeGenConfigurationNodes
-
The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
Type: String to CodeGenConfigurationNode object map
Key Pattern:
[A-Za-z0-9_-]*Required: No
- Command
-
The
JobCommandthat runs this job.Type: JobCommand object
Required: Yes
- Connections
-
The connections used for this job.
Type: ConnectionsList object
Required: No
- DefaultArguments
-
The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a AWS Glue Connection, AWS Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by AWS Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
Type: String to string map
Required: No
- Description
-
Description of the job being defined.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: No
- ExecutionClass
-
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with AWS Glue version 3.0 and above and command type
glueetlwill be allowed to setExecutionClasstoFLEX. The flexible execution class is available for Spark jobs.Type: String
Length Constraints: Maximum length of 16.
Valid Values:
FLEX | STANDARDRequired: No
- ExecutionProperty
-
An
ExecutionPropertyspecifying the maximum number of concurrent runs allowed for this job.Type: ExecutionProperty object
Required: No
- GlueVersion
-
In Spark jobs,
GlueVersiondetermines the versions of Apache Spark and Python that AWS Glue available in a job. The Python version indicates the version supported for jobs of type Spark.Ray jobs should set
GlueVersionto4.0or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntimeparameter of the Job command.For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^(\w+\.)+\w+$Required: No
- JobMode
-
A mode that describes how a job was created. Valid values are:
-
SCRIPT- The job was created using the AWS Glue Studio script editor. -
VISUAL- The job was created using the AWS Glue Studio visual editor. -
NOTEBOOK- The job was created using an interactive sessions notebook.
When the
JobModefield is missing or null,SCRIPTis assigned as the default value.Type: String
Valid Values:
SCRIPT | VISUAL | NOTEBOOKRequired: No
-
- JobRunQueuingEnabled
-
Specifies whether job run queuing is enabled for the job runs for this job.
A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing.
If this field does not match the value set in the job run, then the value from the job run field will be used.
Type: Boolean
Required: No
- LogUri
-
This field is reserved for future use.
Type: String
Required: No
- MaintenanceWindow
-
This field specifies a day of the week and hour for a maintenance window for streaming jobs. AWS Glue periodically performs maintenance activities. During these maintenance windows, AWS Glue will need to restart your streaming jobs.
AWS Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
Type: String
Pattern:
^(Sun|Mon|Tue|Wed|Thu|Fri|Sat):([01]?[0-9]|2[0-3])$Required: No
- MaxCapacity
-
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page
. For Glue version 2.0+ jobs, you cannot specify a
Maximum capacity. Instead, you should specify aWorker typeand theNumber of workers.Do not set
MaxCapacityif usingWorkerTypeandNumberOfWorkers.The value that can be allocated for
MaxCapacitydepends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:-
When you specify a Python shell job (
JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. -
When you specify an Apache Spark ETL job (
JobCommand.Name="glueetl") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
Type: Double
Required: No
-
- MaxRetries
-
The maximum number of times to retry this job if it fails.
Type: Integer
Required: No
- Name
-
The name you assign to this job definition. It must be unique in your account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: Yes
- NonOverridableArguments
-
Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
Type: String to string map
Required: No
- NotificationProperty
-
Specifies configuration properties of a job notification.
Type: NotificationProperty object
Required: No
- NumberOfWorkers
-
The number of workers of a defined
workerTypethat are allocated when a job runs.Type: Integer
Required: No
- Role
-
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
Type: String
Required: Yes
- SecurityConfiguration
-
The name of the
SecurityConfigurationstructure to be used with this job.Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: No
- SourceControlDetails
-
The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
Type: SourceControlDetails object
Required: No
- Tags
-
The tags to use with this job. You may use tags to limit access to the job. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- Timeout
-
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters
TIMEOUTstatus. The default is 2,880 minutes (48 hours) for batch jobs.Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- WorkerType
-
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1Xworker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2Xworker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4Xworker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for AWS Glue version 3.0 or later Spark ETL jobs in the following AWS Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8Xworker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for AWS Glue version 3.0 or later Spark ETL jobs, in the same AWS Regions as supported for theG.4Xworker type. -
For the
G.025Xworker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for AWS Glue version 3.0 or later streaming jobs. -
For the
Z.2Xworker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
Type: String
Valid Values:
Standard | G.1X | G.2X | G.025X | G.4X | G.8X | Z.2XRequired: No
-
Response Syntax
{
"Name": "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.
- Name
-
The unique name that was provided for this job definition.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AlreadyExistsException
-
A resource to be created or added already exists.
HTTP Status Code: 400
- ConcurrentModificationException
-
Two processes are trying to modify a resource simultaneously.
HTTP Status Code: 400
- IdempotentParameterMismatchException
-
The same unique identifier was associated with two different records.
HTTP Status Code: 400
- InternalServiceException
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
- OperationTimeoutException
-
The operation timed out.
HTTP Status Code: 400
- ResourceNumberLimitExceededException
-
A resource numerical limit was exceeded.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
