GetJob - AWS Glue

GetJob

Retrieves an existing job definition.

Request Syntax

{ "JobName": "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.

JobName

The name of the job definition to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Response Syntax

{ "Job": { "AllocatedCapacity": number, "CodeGenConfigurationNodes": { "string" : { "Aggregate": { "Aggs": [ { "AggFunc": "string", "Column": [ "string" ] } ], "Groups": [ [ "string" ] ], "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" }, "CatalogKafkaSource": { "Database": "string", "DataPreviewOptions": { "PollingTime": number, "RecordPollingLimit": number }, "DetectSchema": boolean, "Name": "string", "StreamingOptions": { "Assign": "string", "BootstrapServers": "string", "Classification": "string", "ConnectionName": "string", "Delimiter": "string", "EndingOffsets": "string", "MaxOffsetsPerTrigger": number, "MinPartitions": number, "NumRetries": number, "PollTimeoutMs": number, "RetryIntervalMs": number, "SecurityProtocol": "string", "StartingOffsets": "string", "SubscribePattern": "string", "TopicName": "string" }, "Table": "string", "WindowSize": number }, "CatalogKinesisSource": { "Database": "string", "DataPreviewOptions": { "PollingTime": number, "RecordPollingLimit": number }, "DetectSchema": boolean, "Name": "string", "StreamingOptions": { "AddIdleTimeBetweenReads": boolean, "AvoidEmptyBatches": boolean, "Classification": "string", "Delimiter": "string", "DescribeShardInterval": number, "EndpointUrl": "string", "IdleTimeBetweenReadsInMs": number, "MaxFetchRecordsPerShard": number, "MaxFetchTimeInMs": number, "MaxRecordPerRead": number, "MaxRetryIntervalMs": number, "NumRetries": number, "RetryIntervalMs": number, "RoleArn": "string", "RoleSessionName": "string", "StartingPosition": "string", "StreamArn": "string", "StreamName": "string" }, "Table": "string", "WindowSize": number }, "CatalogSource": { "Database": "string", "Name": "string", "Table": "string" }, "CatalogTarget": { "Database": "string", "Inputs": [ "string" ], "Name": "string", "Table": "string" }, "CustomCode": { "ClassName": "string", "Code": "string", "Inputs": [ "string" ], "Name": "string", "OutputSchemas": [ { "Columns": [ { "Name": "string", "Type": "string" } ] } ] }, "DirectKafkaSource": { "DataPreviewOptions": { "PollingTime": number, "RecordPollingLimit": number }, "DetectSchema": boolean, "Name": "string", "StreamingOptions": { "Assign": "string", "BootstrapServers": "string", "Classification": "string", "ConnectionName": "string", "Delimiter": "string", "EndingOffsets": "string", "MaxOffsetsPerTrigger": number, "MinPartitions": number, "NumRetries": number, "PollTimeoutMs": number, "RetryIntervalMs": number, "SecurityProtocol": "string", "StartingOffsets": "string", "SubscribePattern": "string", "TopicName": "string" }, "WindowSize": number }, "DirectKinesisSource": { "DataPreviewOptions": { "PollingTime": number, "RecordPollingLimit": number }, "DetectSchema": boolean, "Name": "string", "StreamingOptions": { "AddIdleTimeBetweenReads": boolean, "AvoidEmptyBatches": boolean, "Classification": "string", "Delimiter": "string", "DescribeShardInterval": number, "EndpointUrl": "string", "IdleTimeBetweenReadsInMs": number, "MaxFetchRecordsPerShard": number, "MaxFetchTimeInMs": number, "MaxRecordPerRead": number, "MaxRetryIntervalMs": number, "NumRetries": number, "RetryIntervalMs": number, "RoleArn": "string", "RoleSessionName": "string", "StartingPosition": "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" } ] }, "DynamoDBCatalogSource": { "Database": "string", "Name": "string", "Table": "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" }, "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" ] }, "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 }, "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" } }, "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" }, "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", "ScriptLocation": "string" }, "Connections": { "Connections": [ "string" ] }, "CreatedOn": number, "DefaultArguments": { "string" : "string" }, "Description": "string", "ExecutionClass": "string", "ExecutionProperty": { "MaxConcurrentRuns": number }, "GlueVersion": "string", "LastModifiedOn": number, "LogUri": "string", "MaxCapacity": number, "MaxRetries": number, "Name": "string", "NonOverridableArguments": { "string" : "string" }, "NotificationProperty": { "NotifyDelayAfter": number }, "NumberOfWorkers": number, "Role": "string", "SecurityConfiguration": "string", "Timeout": number, "WorkerType": "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.

Job

The requested job definition.

Type: Job object

Errors

For information about the errors that are common to all actions, see Common Errors.

EntityNotFoundException

A specified entity does not exist

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: