Glue

Implementation details for API glue

Coverage Overview

Glue is supported by LocalStack only in the pro image.

AvailabilityTesting*
OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
BatchCreatePartition✔️pro
BatchDeleteConnection
BatchDeletePartition✔️pro
BatchDeleteTable✔️pro
BatchDeleteTableVersion
BatchGetBlueprints
BatchGetCrawlers
BatchGetCustomEntityTypes
BatchGetDataQualityResult
BatchGetDevEndpoints
BatchGetJobs
BatchGetPartition✔️pro
BatchGetTableOptimizer
BatchGetTriggers
BatchGetWorkflows
BatchPutDataQualityStatisticAnnotation
BatchStopJobRun
BatchUpdatePartition✔️pro
CancelDataQualityRuleRecommendationRun
CancelDataQualityRulesetEvaluationRun
CancelMLTaskRun
CancelStatement
CheckSchemaVersionValidity✔️pro
CreateBlueprint
CreateClassifier✔️pro✔️✔️✔️✔️✔️Show Tests
CreateConnection✔️pro✔️✔️✔️✔️✔️Show Tests
CreateCrawler✔️pro✔️✔️
CreateCustomEntityType
CreateDataQualityRuleset
CreateDatabase✔️pro✔️✔️✔️✔️✔️Show Tests
CreateDevEndpoint
CreateJob✔️pro✔️✔️✔️✔️✔️Show Tests
CreateMLTransform
CreatePartition✔️pro✔️✔️
CreatePartitionIndex✔️pro✔️✔️
CreateRegistry✔️pro✔️✔️✔️✔️✔️Show Tests
CreateSchema✔️pro✔️✔️✔️✔️✔️Show Tests
CreateScript
CreateSecurityConfiguration✔️pro✔️✔️
CreateSession
CreateTable✔️pro✔️✔️✔️✔️✔️Show Tests
CreateTableOptimizer
CreateTrigger✔️pro✔️✔️✔️✔️✔️Show Tests
CreateUsageProfile
CreateUserDefinedFunction
CreateWorkflow✔️pro✔️✔️✔️✔️✔️Show Tests
DeleteBlueprint
DeleteClassifier✔️pro✔️✔️✔️✔️✔️Show Tests
DeleteColumnStatisticsForPartition
DeleteColumnStatisticsForTable
DeleteConnection✔️pro✔️✔️✔️✔️✔️Show Tests
DeleteCrawler✔️pro✔️✔️
DeleteCustomEntityType
DeleteDataQualityRuleset
DeleteDatabase✔️pro✔️✔️✔️✔️✔️Show Tests
DeleteDevEndpoint
DeleteJob✔️pro✔️✔️✔️✔️✔️Show Tests
DeleteMLTransform
DeletePartition✔️pro✔️✔️
DeletePartitionIndex✔️pro✔️✔️
DeleteRegistry✔️pro✔️✔️✔️✔️✔️Show Tests
DeleteResourcePolicy✔️pro✔️✔️
DeleteSchema✔️pro✔️✔️✔️✔️✔️Show Tests
DeleteSchemaVersions✔️pro✔️✔️✔️Show Tests
DeleteSecurityConfiguration✔️pro✔️✔️
DeleteSession
DeleteTable✔️pro✔️✔️✔️✔️✔️Show Tests
DeleteTableOptimizer
DeleteTableVersion
DeleteTrigger✔️pro✔️✔️✔️✔️✔️Show Tests
DeleteUsageProfile
DeleteUserDefinedFunction
DeleteWorkflow✔️pro✔️✔️✔️✔️✔️Show Tests
GetBlueprint
GetBlueprintRun
GetBlueprintRuns
GetCatalogImportStatus✔️pro
GetClassifier✔️pro✔️✔️✔️✔️✔️Show Tests
GetClassifiers✔️pro
GetColumnStatisticsForPartition
GetColumnStatisticsForTable
GetColumnStatisticsTaskRun
GetColumnStatisticsTaskRuns
GetConnection✔️pro✔️✔️✔️✔️✔️Show Tests
GetConnections✔️pro
GetCrawler✔️pro✔️✔️
GetCrawlerMetrics
GetCrawlers✔️pro
GetCustomEntityType
GetDataCatalogEncryptionSettings
GetDataQualityModel
GetDataQualityModelResult
GetDataQualityResult
GetDataQualityRuleRecommendationRun
GetDataQualityRuleset
GetDataQualityRulesetEvaluationRun
GetDatabase✔️pro✔️✔️✔️✔️✔️Show Tests
GetDatabases✔️pro✔️✔️
GetDataflowGraph
GetDevEndpoint
GetDevEndpoints
GetJob✔️pro✔️✔️✔️✔️✔️Show Tests
GetJobBookmark
GetJobRun✔️pro✔️
GetJobRuns✔️pro
GetJobs✔️pro✔️
GetMLTaskRun
GetMLTaskRuns
GetMLTransform
GetMLTransforms
GetMapping
GetPartition✔️pro✔️✔️
GetPartitionIndexes✔️pro✔️✔️
GetPartitions✔️pro
GetPlan
GetRegistry✔️pro✔️✔️✔️✔️✔️Show Tests
GetResourcePolicies
GetResourcePolicy✔️pro✔️✔️
GetSchema✔️pro✔️✔️✔️✔️✔️Show Tests
GetSchemaByDefinition✔️pro
GetSchemaVersion✔️pro✔️✔️✔️✔️✔️Show Tests
GetSchemaVersionsDiff✔️pro
GetSecurityConfiguration✔️pro✔️✔️
GetSecurityConfigurations✔️pro
GetSession
GetStatement
GetTable✔️pro✔️✔️✔️✔️✔️Show Tests
GetTableOptimizer
GetTableVersion✔️pro
GetTableVersions✔️pro
GetTables✔️pro✔️✔️
GetTags✔️pro✔️✔️
GetTrigger✔️pro✔️✔️✔️✔️✔️Show Tests
GetTriggers✔️pro✔️
GetUnfilteredPartitionMetadata
GetUnfilteredPartitionsMetadata
GetUnfilteredTableMetadata
GetUsageProfile
GetUserDefinedFunction
GetUserDefinedFunctions
GetWorkflow✔️pro✔️✔️✔️✔️✔️Show Tests
GetWorkflowRun
GetWorkflowRunProperties
GetWorkflowRuns
ImportCatalogToGlue✔️pro
ListBlueprints
ListColumnStatisticsTaskRuns
ListCrawlers✔️pro✔️
ListCrawls✔️pro
ListCustomEntityTypes
ListDataQualityResults
ListDataQualityRuleRecommendationRuns
ListDataQualityRulesetEvaluationRuns
ListDataQualityRulesets
ListDataQualityStatisticAnnotations
ListDataQualityStatistics
ListDevEndpoints
ListJobs✔️pro✔️
ListMLTransforms
ListRegistries✔️pro✔️✔️
ListSchemaVersions✔️pro
ListSchemas✔️pro
ListSessions
ListStatements
ListTableOptimizerRuns
ListTriggers
ListUsageProfiles
ListWorkflows✔️pro✔️✔️
PutDataCatalogEncryptionSettings
PutDataQualityProfileAnnotation
PutResourcePolicy✔️pro✔️✔️
PutSchemaVersionMetadata✔️pro✔️✔️✔️Show Tests
PutWorkflowRunProperties
QuerySchemaVersionMetadata✔️pro✔️✔️✔️Show Tests
RegisterSchemaVersion✔️pro✔️✔️✔️✔️✔️Show Tests
RemoveSchemaVersionMetadata✔️pro✔️✔️✔️Show Tests
ResetJobBookmark
ResumeWorkflowRun
RunStatement
SearchTables
StartBlueprintRun
StartColumnStatisticsTaskRun
StartCrawler✔️pro
StartCrawlerSchedule
StartDataQualityRuleRecommendationRun
StartDataQualityRulesetEvaluationRun
StartExportLabelsTaskRun
StartImportLabelsTaskRun
StartJobRun✔️pro✔️
StartMLEvaluationTaskRun
StartMLLabelingSetGenerationTaskRun
StartTrigger✔️pro✔️✔️
StartWorkflowRun
StopColumnStatisticsTaskRun
StopCrawler✔️pro
StopCrawlerSchedule
StopSession
StopTrigger✔️pro✔️✔️
StopWorkflowRun
TagResource✔️pro✔️✔️
TestConnection
UntagResource✔️pro✔️✔️
UpdateBlueprint
UpdateClassifier✔️pro✔️✔️
UpdateColumnStatisticsForPartition
UpdateColumnStatisticsForTable
UpdateConnection✔️pro✔️✔️
UpdateCrawler✔️pro✔️✔️
UpdateCrawlerSchedule
UpdateDataQualityRuleset
UpdateDatabase✔️pro✔️✔️
UpdateDevEndpoint
UpdateJob✔️pro✔️✔️
UpdateJobFromSourceControl
UpdateMLTransform
UpdatePartition✔️pro✔️✔️
UpdateRegistry✔️pro✔️✔️
UpdateSchema✔️pro✔️✔️
UpdateSourceControlFromJob
UpdateTable✔️pro✔️✔️
UpdateTableOptimizer
UpdateTrigger✔️pro✔️✔️
UpdateUsageProfile
UpdateUserDefinedFunction
UpdateWorkflow✔️pro✔️✔️

Terminology

  • Internal Test Suite: tested by LocalStack's internal integration test suite
  • External Test Suite: covered by an external integration test suite, that runs against LocalStack
  • Terraform Validated: operation tested with Terraform
  • AWS Validated: the integration test that includes this operation call was validated against AWS
  • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

Testing Details

This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

How to read the test details?

For each operation we put up a list of the related integration test cases.
Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

  • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
  • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
    • test name
    • status code returned (which is the expected one for the test case)
    • information about validation:
      • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
      • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


CreateClassifier

Parameters: GrokClassifier
  • LocalStack Pro
    • test_classifier LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_classifier HTTP Status Code: 200 AWS validated Snapshot Tested

CreateConnection

Parameters: CatalogId, ConnectionInput
  • LocalStack Pro
    • test_connection LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_connection HTTP Status Code: 200 AWS validated Snapshot Tested

CreateDatabase

Parameters: CatalogId, DatabaseInput
  • LocalStack Pro
    • test_database LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_database HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_table LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_table HTTP Status Code: 200 AWS validated Snapshot Tested

CreateJob

Parameters: Command, Name, Role
  • LocalStack Pro
    • test_job LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_job HTTP Status Code: 200 AWS validated Snapshot Tested

CreateRegistry

Parameters: Description, RegistryName, Tags
  • LocalStack Pro
    • test_registry LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_registry HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version_metadata LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version_metadata HTTP Status Code: 200 AWS validated Snapshot Tested

CreateSchema

Parameters: Compatibility, DataFormat, Description, RegistryId, SchemaDefinition, SchemaName, Tags
  • LocalStack Pro
    • test_schema LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version_metadata LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version_metadata HTTP Status Code: 200 AWS validated Snapshot Tested

CreateTable

Parameters: CatalogId, DatabaseName, TableInput
  • LocalStack Pro
    • test_table LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_table HTTP Status Code: 200 AWS validated Snapshot Tested

CreateTrigger

Parameters: Actions, Name, Type
  • LocalStack Pro
    • test_trigger LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_trigger HTTP Status Code: 200 AWS validated Snapshot Tested

CreateWorkflow

Parameters: Name
  • LocalStack Pro
    • test_workflow LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_workflow HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteClassifier

Parameters: Name
  • LocalStack Pro
    • test_classifier LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_classifier HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteConnection

Parameters: CatalogId, ConnectionName
  • LocalStack Pro
    • test_connection LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_connection HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteDatabase

Parameters: Name
  • LocalStack Pro
    • test_database LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_database HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_table LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_table HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteJob

Parameters: JobName
  • LocalStack Pro
    • test_job LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_job HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteRegistry

Parameters: RegistryId
  • LocalStack Pro
    • test_registry LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_registry HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version_metadata LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version_metadata HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteSchema

Parameters: SchemaId
  • LocalStack Pro
    • test_schema LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version_metadata LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version_metadata HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteSchemaVersions

Parameters: SchemaId, Versions
  • LocalStack Pro
    • test_schema LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version_metadata LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version_metadata HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteTable

Parameters: DatabaseName, Name
  • LocalStack Pro
    • test_table LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_table HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteTrigger

Parameters: Name
  • LocalStack Pro
    • test_trigger LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_trigger HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteWorkflow

Parameters: Name
  • LocalStack Pro
    • test_workflow LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_workflow HTTP Status Code: 200 AWS validated Snapshot Tested

GetClassifier

Parameters: Name
  • LocalStack Pro
    • test_classifier LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_classifier HTTP Status Code: 200 AWS validated Snapshot Tested

GetConnection

Parameters: Name
  • LocalStack Pro
    • test_connection LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_connection HTTP Status Code: 200 AWS validated Snapshot Tested

GetDatabase

Parameters: Name
  • LocalStack Pro
    • test_database LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_database HTTP Status Code: 200 AWS validated Snapshot Tested

GetJob

Parameters: JobName
  • LocalStack Pro
    • test_job LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_job HTTP Status Code: 200 AWS validated Snapshot Tested

GetRegistry

Parameters: RegistryId
  • LocalStack Pro
    • test_registry LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_registry HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_registry LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_registry HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version_metadata LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version_metadata HTTP Status Code: 200 AWS validated Snapshot Tested

GetSchema

Parameters: SchemaId
  • LocalStack Pro
    • test_schema LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version_metadata LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version_metadata HTTP Status Code: 200 AWS validated Snapshot Tested

GetSchemaVersion

Parameters: SchemaVersionId
  • LocalStack Pro
    • test_schema LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version_metadata LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version_metadata HTTP Status Code: 200 AWS validated Snapshot Tested

GetTable

Parameters: CatalogId, DatabaseName, Name
  • LocalStack Pro
    • test_table LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_table HTTP Status Code: 200 AWS validated Snapshot Tested

GetTrigger

Parameters: Name
  • LocalStack Pro
    • test_trigger LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_trigger HTTP Status Code: 200 AWS validated Snapshot Tested

GetWorkflow

Parameters: Name
  • LocalStack Pro
    • test_workflow LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_workflow HTTP Status Code: 200 AWS validated Snapshot Tested

PutSchemaVersionMetadata

Parameters: MetadataKeyValue, SchemaVersionId
  • LocalStack Pro
    • test_schema LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version_metadata LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version_metadata HTTP Status Code: 200 AWS validated Snapshot Tested

QuerySchemaVersionMetadata

Parameters: SchemaVersionId
  • LocalStack Pro
    • test_schema_version_metadata LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version_metadata HTTP Status Code: 200 AWS validated Snapshot Tested

RegisterSchemaVersion

Parameters: SchemaDefinition, SchemaId
  • LocalStack Pro
    • test_schema LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version_metadata LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version_metadata HTTP Status Code: 200 AWS validated Snapshot Tested

RemoveSchemaVersionMetadata

Parameters: MetadataKeyValue, SchemaVersionId
  • LocalStack Pro
    • test_schema LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_schema_version_metadata LocalStack Pro: tests/aws/services/cloudformation/resources/test_glue.py::test_schema_version_metadata HTTP Status Code: 200 AWS validated Snapshot Tested

Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)