Skip to content

GlueClient#

Index > Glue > GlueClient

Auto-generated documentation for Glue type annotations stubs module mypy-boto3-glue.

GlueClient#

Type annotations and code completion for boto3.client("glue"). boto3 documentation

# GlueClient usage example

from boto3.session import Session
from mypy_boto3_glue.client import GlueClient

def get_glue_client() -> GlueClient:
    return Session().client("glue")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("glue").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("glue")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.AlreadyExistsException,
    client.exceptions.ClientError,
    client.exceptions.ConcurrentModificationException,
    client.exceptions.ConcurrentRunsExceededException,
    client.exceptions.ConditionCheckFailureException,
    client.exceptions.ConflictException,
    client.exceptions.CrawlerNotRunningException,
    client.exceptions.CrawlerRunningException,
    client.exceptions.CrawlerStoppingException,
    client.exceptions.EntityNotFoundException,
    client.exceptions.FederatedResourceAlreadyExistsException,
    client.exceptions.FederationSourceException,
    client.exceptions.FederationSourceRetryableException,
    client.exceptions.GlueEncryptionException,
    client.exceptions.IdempotentParameterMismatchException,
    client.exceptions.IllegalBlueprintStateException,
    client.exceptions.IllegalSessionStateException,
    client.exceptions.IllegalWorkflowStateException,
    client.exceptions.InternalServiceException,
    client.exceptions.InvalidInputException,
    client.exceptions.InvalidStateException,
    client.exceptions.MLTransformNotReadyException,
    client.exceptions.NoScheduleException,
    client.exceptions.OperationTimeoutException,
    client.exceptions.PermissionTypeMismatchException,
    client.exceptions.ResourceNotReadyException,
    client.exceptions.ResourceNumberLimitExceededException,
    client.exceptions.SchedulerNotRunningException,
    client.exceptions.SchedulerRunningException,
    client.exceptions.SchedulerTransitioningException,
    client.exceptions.ValidationException,
    client.exceptions.VersionMismatchException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_glue.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

batch_create_partition#

Creates one or more partitions in a batch operation.

Type annotations and code completion for boto3.client("glue").batch_create_partition method. boto3 documentation

# batch_create_partition method definition

def batch_create_partition(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    PartitionInputList: Sequence[PartitionInputTypeDef],  # (1)
    CatalogId: str = ...,
) -> BatchCreatePartitionResponseTypeDef:  # (2)
    ...
  1. See PartitionInputTypeDef
  2. See BatchCreatePartitionResponseTypeDef 
# batch_create_partition method usage example with argument unpacking

kwargs: BatchCreatePartitionRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
    "PartitionInputList": ...,
}

parent.batch_create_partition(**kwargs)
  1. See BatchCreatePartitionRequestRequestTypeDef

batch_delete_connection#

Deletes a list of connection definitions from the Data Catalog.

Type annotations and code completion for boto3.client("glue").batch_delete_connection method. boto3 documentation

# batch_delete_connection method definition

def batch_delete_connection(
    self,
    *,
    ConnectionNameList: Sequence[str],
    CatalogId: str = ...,
) -> BatchDeleteConnectionResponseTypeDef:  # (1)
    ...
  1. See BatchDeleteConnectionResponseTypeDef 
# batch_delete_connection method usage example with argument unpacking

kwargs: BatchDeleteConnectionRequestRequestTypeDef = {  # (1)
    "ConnectionNameList": ...,
}

parent.batch_delete_connection(**kwargs)
  1. See BatchDeleteConnectionRequestRequestTypeDef

batch_delete_partition#

Deletes one or more partitions in a batch operation.

Type annotations and code completion for boto3.client("glue").batch_delete_partition method. boto3 documentation

# batch_delete_partition method definition

def batch_delete_partition(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    PartitionsToDelete: Sequence[PartitionValueListTypeDef],  # (1)
    CatalogId: str = ...,
) -> BatchDeletePartitionResponseTypeDef:  # (2)
    ...
  1. See PartitionValueListTypeDef
  2. See BatchDeletePartitionResponseTypeDef 
# batch_delete_partition method usage example with argument unpacking

kwargs: BatchDeletePartitionRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
    "PartitionsToDelete": ...,
}

parent.batch_delete_partition(**kwargs)
  1. See BatchDeletePartitionRequestRequestTypeDef

batch_delete_table#

Deletes multiple tables at once.

Type annotations and code completion for boto3.client("glue").batch_delete_table method. boto3 documentation

# batch_delete_table method definition

def batch_delete_table(
    self,
    *,
    DatabaseName: str,
    TablesToDelete: Sequence[str],
    CatalogId: str = ...,
    TransactionId: str = ...,
) -> BatchDeleteTableResponseTypeDef:  # (1)
    ...
  1. See BatchDeleteTableResponseTypeDef 
# batch_delete_table method usage example with argument unpacking

kwargs: BatchDeleteTableRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TablesToDelete": ...,
}

parent.batch_delete_table(**kwargs)
  1. See BatchDeleteTableRequestRequestTypeDef

batch_delete_table_version#

Deletes a specified batch of versions of a table.

Type annotations and code completion for boto3.client("glue").batch_delete_table_version method. boto3 documentation

# batch_delete_table_version method definition

def batch_delete_table_version(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    VersionIds: Sequence[str],
    CatalogId: str = ...,
) -> BatchDeleteTableVersionResponseTypeDef:  # (1)
    ...
  1. See BatchDeleteTableVersionResponseTypeDef 
# batch_delete_table_version method usage example with argument unpacking

kwargs: BatchDeleteTableVersionRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
    "VersionIds": ...,
}

parent.batch_delete_table_version(**kwargs)
  1. See BatchDeleteTableVersionRequestRequestTypeDef

batch_get_blueprints#

Retrieves information about a list of blueprints.

Type annotations and code completion for boto3.client("glue").batch_get_blueprints method. boto3 documentation

# batch_get_blueprints method definition

def batch_get_blueprints(
    self,
    *,
    Names: Sequence[str],
    IncludeBlueprint: bool = ...,
    IncludeParameterSpec: bool = ...,
) -> BatchGetBlueprintsResponseTypeDef:  # (1)
    ...
  1. See BatchGetBlueprintsResponseTypeDef 
# batch_get_blueprints method usage example with argument unpacking

kwargs: BatchGetBlueprintsRequestRequestTypeDef = {  # (1)
    "Names": ...,
}

parent.batch_get_blueprints(**kwargs)
  1. See BatchGetBlueprintsRequestRequestTypeDef

batch_get_crawlers#

Returns a list of resource metadata for a given list of crawler names.

Type annotations and code completion for boto3.client("glue").batch_get_crawlers method. boto3 documentation

# batch_get_crawlers method definition

def batch_get_crawlers(
    self,
    *,
    CrawlerNames: Sequence[str],
) -> BatchGetCrawlersResponseTypeDef:  # (1)
    ...
  1. See BatchGetCrawlersResponseTypeDef 
# batch_get_crawlers method usage example with argument unpacking

kwargs: BatchGetCrawlersRequestRequestTypeDef = {  # (1)
    "CrawlerNames": ...,
}

parent.batch_get_crawlers(**kwargs)
  1. See BatchGetCrawlersRequestRequestTypeDef

batch_get_custom_entity_types#

Retrieves the details for the custom patterns specified by a list of names.

Type annotations and code completion for boto3.client("glue").batch_get_custom_entity_types method. boto3 documentation

# batch_get_custom_entity_types method definition

def batch_get_custom_entity_types(
    self,
    *,
    Names: Sequence[str],
) -> BatchGetCustomEntityTypesResponseTypeDef:  # (1)
    ...
  1. See BatchGetCustomEntityTypesResponseTypeDef 
# batch_get_custom_entity_types method usage example with argument unpacking

kwargs: BatchGetCustomEntityTypesRequestRequestTypeDef = {  # (1)
    "Names": ...,
}

parent.batch_get_custom_entity_types(**kwargs)
  1. See BatchGetCustomEntityTypesRequestRequestTypeDef

batch_get_data_quality_result#

Retrieves a list of data quality results for the specified result IDs.

Type annotations and code completion for boto3.client("glue").batch_get_data_quality_result method. boto3 documentation

# batch_get_data_quality_result method definition

def batch_get_data_quality_result(
    self,
    *,
    ResultIds: Sequence[str],
) -> BatchGetDataQualityResultResponseTypeDef:  # (1)
    ...
  1. See BatchGetDataQualityResultResponseTypeDef 
# batch_get_data_quality_result method usage example with argument unpacking

kwargs: BatchGetDataQualityResultRequestRequestTypeDef = {  # (1)
    "ResultIds": ...,
}

parent.batch_get_data_quality_result(**kwargs)
  1. See BatchGetDataQualityResultRequestRequestTypeDef

batch_get_dev_endpoints#

Returns a list of resource metadata for a given list of development endpoint names.

Type annotations and code completion for boto3.client("glue").batch_get_dev_endpoints method. boto3 documentation

# batch_get_dev_endpoints method definition

def batch_get_dev_endpoints(
    self,
    *,
    DevEndpointNames: Sequence[str],
) -> BatchGetDevEndpointsResponseTypeDef:  # (1)
    ...
  1. See BatchGetDevEndpointsResponseTypeDef 
# batch_get_dev_endpoints method usage example with argument unpacking

kwargs: BatchGetDevEndpointsRequestRequestTypeDef = {  # (1)
    "DevEndpointNames": ...,
}

parent.batch_get_dev_endpoints(**kwargs)
  1. See BatchGetDevEndpointsRequestRequestTypeDef

batch_get_jobs#

Returns a list of resource metadata for a given list of job names.

Type annotations and code completion for boto3.client("glue").batch_get_jobs method. boto3 documentation

# batch_get_jobs method definition

def batch_get_jobs(
    self,
    *,
    JobNames: Sequence[str],
) -> BatchGetJobsResponseTypeDef:  # (1)
    ...
  1. See BatchGetJobsResponseTypeDef 
# batch_get_jobs method usage example with argument unpacking

kwargs: BatchGetJobsRequestRequestTypeDef = {  # (1)
    "JobNames": ...,
}

parent.batch_get_jobs(**kwargs)
  1. See BatchGetJobsRequestRequestTypeDef

batch_get_partition#

Retrieves partitions in a batch request.

Type annotations and code completion for boto3.client("glue").batch_get_partition method. boto3 documentation

# batch_get_partition method definition

def batch_get_partition(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    PartitionsToGet: Sequence[PartitionValueListTypeDef],  # (1)
    CatalogId: str = ...,
) -> BatchGetPartitionResponseTypeDef:  # (2)
    ...
  1. See PartitionValueListTypeDef
  2. See BatchGetPartitionResponseTypeDef 
# batch_get_partition method usage example with argument unpacking

kwargs: BatchGetPartitionRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
    "PartitionsToGet": ...,
}

parent.batch_get_partition(**kwargs)
  1. See BatchGetPartitionRequestRequestTypeDef

batch_get_triggers#

Returns a list of resource metadata for a given list of trigger names.

Type annotations and code completion for boto3.client("glue").batch_get_triggers method. boto3 documentation

# batch_get_triggers method definition

def batch_get_triggers(
    self,
    *,
    TriggerNames: Sequence[str],
) -> BatchGetTriggersResponseTypeDef:  # (1)
    ...
  1. See BatchGetTriggersResponseTypeDef 
# batch_get_triggers method usage example with argument unpacking

kwargs: BatchGetTriggersRequestRequestTypeDef = {  # (1)
    "TriggerNames": ...,
}

parent.batch_get_triggers(**kwargs)
  1. See BatchGetTriggersRequestRequestTypeDef

batch_get_workflows#

Returns a list of resource metadata for a given list of workflow names.

Type annotations and code completion for boto3.client("glue").batch_get_workflows method. boto3 documentation

# batch_get_workflows method definition

def batch_get_workflows(
    self,
    *,
    Names: Sequence[str],
    IncludeGraph: bool = ...,
) -> BatchGetWorkflowsResponseTypeDef:  # (1)
    ...
  1. See BatchGetWorkflowsResponseTypeDef 
# batch_get_workflows method usage example with argument unpacking

kwargs: BatchGetWorkflowsRequestRequestTypeDef = {  # (1)
    "Names": ...,
}

parent.batch_get_workflows(**kwargs)
  1. See BatchGetWorkflowsRequestRequestTypeDef

batch_stop_job_run#

Stops one or more job runs for a specified job definition.

Type annotations and code completion for boto3.client("glue").batch_stop_job_run method. boto3 documentation

# batch_stop_job_run method definition

def batch_stop_job_run(
    self,
    *,
    JobName: str,
    JobRunIds: Sequence[str],
) -> BatchStopJobRunResponseTypeDef:  # (1)
    ...
  1. See BatchStopJobRunResponseTypeDef 
# batch_stop_job_run method usage example with argument unpacking

kwargs: BatchStopJobRunRequestRequestTypeDef = {  # (1)
    "JobName": ...,
    "JobRunIds": ...,
}

parent.batch_stop_job_run(**kwargs)
  1. See BatchStopJobRunRequestRequestTypeDef

batch_update_partition#

Updates one or more partitions in a batch operation.

Type annotations and code completion for boto3.client("glue").batch_update_partition method. boto3 documentation

# batch_update_partition method definition

def batch_update_partition(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    Entries: Sequence[BatchUpdatePartitionRequestEntryTypeDef],  # (1)
    CatalogId: str = ...,
) -> BatchUpdatePartitionResponseTypeDef:  # (2)
    ...
  1. See BatchUpdatePartitionRequestEntryTypeDef
  2. See BatchUpdatePartitionResponseTypeDef 
# batch_update_partition method usage example with argument unpacking

kwargs: BatchUpdatePartitionRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
    "Entries": ...,
}

parent.batch_update_partition(**kwargs)
  1. See BatchUpdatePartitionRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("glue").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_data_quality_rule_recommendation_run#

Cancels the specified recommendation run that was being used to generate rules.

Type annotations and code completion for boto3.client("glue").cancel_data_quality_rule_recommendation_run method. boto3 documentation

# cancel_data_quality_rule_recommendation_run method definition

def cancel_data_quality_rule_recommendation_run(
    self,
    *,
    RunId: str,
) -> Dict[str, Any]:
    ...
# cancel_data_quality_rule_recommendation_run method usage example with argument unpacking

kwargs: CancelDataQualityRuleRecommendationRunRequestRequestTypeDef = {  # (1)
    "RunId": ...,
}

parent.cancel_data_quality_rule_recommendation_run(**kwargs)
  1. See CancelDataQualityRuleRecommendationRunRequestRequestTypeDef

cancel_data_quality_ruleset_evaluation_run#

Cancels a run where a ruleset is being evaluated against a data source.

Type annotations and code completion for boto3.client("glue").cancel_data_quality_ruleset_evaluation_run method. boto3 documentation

# cancel_data_quality_ruleset_evaluation_run method definition

def cancel_data_quality_ruleset_evaluation_run(
    self,
    *,
    RunId: str,
) -> Dict[str, Any]:
    ...
# cancel_data_quality_ruleset_evaluation_run method usage example with argument unpacking

kwargs: CancelDataQualityRulesetEvaluationRunRequestRequestTypeDef = {  # (1)
    "RunId": ...,
}

parent.cancel_data_quality_ruleset_evaluation_run(**kwargs)
  1. See CancelDataQualityRulesetEvaluationRunRequestRequestTypeDef

cancel_ml_task_run#

Cancels (stops) a task run.

Type annotations and code completion for boto3.client("glue").cancel_ml_task_run method. boto3 documentation

# cancel_ml_task_run method definition

def cancel_ml_task_run(
    self,
    *,
    TransformId: str,
    TaskRunId: str,
) -> CancelMLTaskRunResponseTypeDef:  # (1)
    ...
  1. See CancelMLTaskRunResponseTypeDef 
# cancel_ml_task_run method usage example with argument unpacking

kwargs: CancelMLTaskRunRequestRequestTypeDef = {  # (1)
    "TransformId": ...,
    "TaskRunId": ...,
}

parent.cancel_ml_task_run(**kwargs)
  1. See CancelMLTaskRunRequestRequestTypeDef

cancel_statement#

Cancels the statement.

Type annotations and code completion for boto3.client("glue").cancel_statement method. boto3 documentation

# cancel_statement method definition

def cancel_statement(
    self,
    *,
    SessionId: str,
    Id: int,
    RequestOrigin: str = ...,
) -> Dict[str, Any]:
    ...
# cancel_statement method usage example with argument unpacking

kwargs: CancelStatementRequestRequestTypeDef = {  # (1)
    "SessionId": ...,
    "Id": ...,
}

parent.cancel_statement(**kwargs)
  1. See CancelStatementRequestRequestTypeDef

check_schema_version_validity#

Validates the supplied schema.

Type annotations and code completion for boto3.client("glue").check_schema_version_validity method. boto3 documentation

# check_schema_version_validity method definition

def check_schema_version_validity(
    self,
    *,
    DataFormat: DataFormatType,  # (1)
    SchemaDefinition: str,
) -> CheckSchemaVersionValidityResponseTypeDef:  # (2)
    ...
  1. See DataFormatType
  2. See CheckSchemaVersionValidityResponseTypeDef 
# check_schema_version_validity method usage example with argument unpacking

kwargs: CheckSchemaVersionValidityInputRequestTypeDef = {  # (1)
    "DataFormat": ...,
    "SchemaDefinition": ...,
}

parent.check_schema_version_validity(**kwargs)
  1. See CheckSchemaVersionValidityInputRequestTypeDef

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("glue").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_blueprint#

Registers a blueprint with Glue.

Type annotations and code completion for boto3.client("glue").create_blueprint method. boto3 documentation

# create_blueprint method definition

def create_blueprint(
    self,
    *,
    Name: str,
    BlueprintLocation: str,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateBlueprintResponseTypeDef:  # (1)
    ...
  1. See CreateBlueprintResponseTypeDef 
# create_blueprint method usage example with argument unpacking

kwargs: CreateBlueprintRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "BlueprintLocation": ...,
}

parent.create_blueprint(**kwargs)
  1. See CreateBlueprintRequestRequestTypeDef

create_classifier#

Creates a classifier in the user's account.

Type annotations and code completion for boto3.client("glue").create_classifier method. boto3 documentation

# create_classifier method definition

def create_classifier(
    self,
    *,
    GrokClassifier: CreateGrokClassifierRequestTypeDef = ...,  # (1)
    XMLClassifier: CreateXMLClassifierRequestTypeDef = ...,  # (2)
    JsonClassifier: CreateJsonClassifierRequestTypeDef = ...,  # (3)
    CsvClassifier: CreateCsvClassifierRequestTypeDef = ...,  # (4)
) -> Dict[str, Any]:
    ...
  1. See CreateGrokClassifierRequestTypeDef
  2. See CreateXMLClassifierRequestTypeDef
  3. See CreateJsonClassifierRequestTypeDef
  4. See CreateCsvClassifierRequestTypeDef 
# create_classifier method usage example with argument unpacking

kwargs: CreateClassifierRequestRequestTypeDef = {  # (1)
    "GrokClassifier": ...,
}

parent.create_classifier(**kwargs)
  1. See CreateClassifierRequestRequestTypeDef

create_connection#

Creates a connection definition in the Data Catalog.

Type annotations and code completion for boto3.client("glue").create_connection method. boto3 documentation

# create_connection method definition

def create_connection(
    self,
    *,
    ConnectionInput: ConnectionInputTypeDef,  # (1)
    CatalogId: str = ...,
    Tags: Mapping[str, str] = ...,
) -> Dict[str, Any]:
    ...
  1. See ConnectionInputTypeDef 
# create_connection method usage example with argument unpacking

kwargs: CreateConnectionRequestRequestTypeDef = {  # (1)
    "ConnectionInput": ...,
}

parent.create_connection(**kwargs)
  1. See CreateConnectionRequestRequestTypeDef

create_crawler#

Creates a new crawler with specified targets, role, configuration, and optional schedule.

Type annotations and code completion for boto3.client("glue").create_crawler method. boto3 documentation

# create_crawler method definition

def create_crawler(
    self,
    *,
    Name: str,
    Role: str,
    Targets: CrawlerTargetsTypeDef,  # (1)
    DatabaseName: str = ...,
    Description: str = ...,
    Schedule: str = ...,
    Classifiers: Sequence[str] = ...,
    TablePrefix: str = ...,
    SchemaChangePolicy: SchemaChangePolicyTypeDef = ...,  # (2)
    RecrawlPolicy: RecrawlPolicyTypeDef = ...,  # (3)
    LineageConfiguration: LineageConfigurationTypeDef = ...,  # (4)
    LakeFormationConfiguration: LakeFormationConfigurationTypeDef = ...,  # (5)
    Configuration: str = ...,
    CrawlerSecurityConfiguration: str = ...,
    Tags: Mapping[str, str] = ...,
) -> Dict[str, Any]:
    ...
  1. See CrawlerTargetsTypeDef
  2. See SchemaChangePolicyTypeDef
  3. See RecrawlPolicyTypeDef
  4. See LineageConfigurationTypeDef
  5. See LakeFormationConfigurationTypeDef 
# create_crawler method usage example with argument unpacking

kwargs: CreateCrawlerRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Role": ...,
    "Targets": ...,
}

parent.create_crawler(**kwargs)
  1. See CreateCrawlerRequestRequestTypeDef

create_custom_entity_type#

Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.

Type annotations and code completion for boto3.client("glue").create_custom_entity_type method. boto3 documentation

# create_custom_entity_type method definition

def create_custom_entity_type(
    self,
    *,
    Name: str,
    RegexString: str,
    ContextWords: Sequence[str] = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateCustomEntityTypeResponseTypeDef:  # (1)
    ...
  1. See CreateCustomEntityTypeResponseTypeDef 
# create_custom_entity_type method usage example with argument unpacking

kwargs: CreateCustomEntityTypeRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "RegexString": ...,
}

parent.create_custom_entity_type(**kwargs)
  1. See CreateCustomEntityTypeRequestRequestTypeDef

create_data_quality_ruleset#

Creates a data quality ruleset with DQDL rules applied to a specified Glue table.

Type annotations and code completion for boto3.client("glue").create_data_quality_ruleset method. boto3 documentation

# create_data_quality_ruleset method definition

def create_data_quality_ruleset(
    self,
    *,
    Name: str,
    Ruleset: str,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
    TargetTable: DataQualityTargetTableTypeDef = ...,  # (1)
    ClientToken: str = ...,
) -> CreateDataQualityRulesetResponseTypeDef:  # (2)
    ...
  1. See DataQualityTargetTableTypeDef
  2. See CreateDataQualityRulesetResponseTypeDef 
# create_data_quality_ruleset method usage example with argument unpacking

kwargs: CreateDataQualityRulesetRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Ruleset": ...,
}

parent.create_data_quality_ruleset(**kwargs)
  1. See CreateDataQualityRulesetRequestRequestTypeDef

create_database#

Creates a new database in a Data Catalog.

Type annotations and code completion for boto3.client("glue").create_database method. boto3 documentation

# create_database method definition

def create_database(
    self,
    *,
    DatabaseInput: DatabaseInputTypeDef,  # (1)
    CatalogId: str = ...,
    Tags: Mapping[str, str] = ...,
) -> Dict[str, Any]:
    ...
  1. See DatabaseInputTypeDef 
# create_database method usage example with argument unpacking

kwargs: CreateDatabaseRequestRequestTypeDef = {  # (1)
    "DatabaseInput": ...,
}

parent.create_database(**kwargs)
  1. See CreateDatabaseRequestRequestTypeDef

create_dev_endpoint#

Creates a new development endpoint.

Type annotations and code completion for boto3.client("glue").create_dev_endpoint method. boto3 documentation

# create_dev_endpoint method definition

def create_dev_endpoint(
    self,
    *,
    EndpointName: str,
    RoleArn: str,
    SecurityGroupIds: Sequence[str] = ...,
    SubnetId: str = ...,
    PublicKey: str = ...,
    PublicKeys: Sequence[str] = ...,
    NumberOfNodes: int = ...,
    WorkerType: WorkerTypeType = ...,  # (1)
    GlueVersion: str = ...,
    NumberOfWorkers: int = ...,
    ExtraPythonLibsS3Path: str = ...,
    ExtraJarsS3Path: str = ...,
    SecurityConfiguration: str = ...,
    Tags: Mapping[str, str] = ...,
    Arguments: Mapping[str, str] = ...,
) -> CreateDevEndpointResponseTypeDef:  # (2)
    ...
  1. See WorkerTypeType
  2. See CreateDevEndpointResponseTypeDef 
# create_dev_endpoint method usage example with argument unpacking

kwargs: CreateDevEndpointRequestRequestTypeDef = {  # (1)
    "EndpointName": ...,
    "RoleArn": ...,
}

parent.create_dev_endpoint(**kwargs)
  1. See CreateDevEndpointRequestRequestTypeDef

create_job#

Creates a new job definition.

Type annotations and code completion for boto3.client("glue").create_job method. boto3 documentation

# create_job method definition

def create_job(
    self,
    *,
    Name: str,
    Role: str,
    Command: JobCommandTypeDef,  # (1)
    Description: str = ...,
    LogUri: str = ...,
    ExecutionProperty: ExecutionPropertyTypeDef = ...,  # (2)
    DefaultArguments: Mapping[str, str] = ...,
    NonOverridableArguments: Mapping[str, str] = ...,
    Connections: ConnectionsListTypeDef = ...,  # (3)
    MaxRetries: int = ...,
    AllocatedCapacity: int = ...,
    Timeout: int = ...,
    MaxCapacity: float = ...,
    SecurityConfiguration: str = ...,
    Tags: Mapping[str, str] = ...,
    NotificationProperty: NotificationPropertyTypeDef = ...,  # (4)
    GlueVersion: str = ...,
    NumberOfWorkers: int = ...,
    WorkerType: WorkerTypeType = ...,  # (5)
    CodeGenConfigurationNodes: Mapping[str, CodeGenConfigurationNodeTypeDef] = ...,  # (6)
    ExecutionClass: ExecutionClassType = ...,  # (7)
    SourceControlDetails: SourceControlDetailsTypeDef = ...,  # (8)
) -> CreateJobResponseTypeDef:  # (9)
    ...
  1. See JobCommandTypeDef
  2. See ExecutionPropertyTypeDef
  3. See ConnectionsListTypeDef
  4. See NotificationPropertyTypeDef
  5. See WorkerTypeType
  6. See CodeGenConfigurationNodeTypeDef
  7. See ExecutionClassType
  8. See SourceControlDetailsTypeDef
  9. See CreateJobResponseTypeDef 
# create_job method usage example with argument unpacking

kwargs: CreateJobRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Role": ...,
    "Command": ...,
}

parent.create_job(**kwargs)
  1. See CreateJobRequestRequestTypeDef

create_ml_transform#

Creates an Glue machine learning transform.

Type annotations and code completion for boto3.client("glue").create_ml_transform method. boto3 documentation

# create_ml_transform method definition

def create_ml_transform(
    self,
    *,
    Name: str,
    InputRecordTables: Sequence[GlueTableTypeDef],  # (1)
    Parameters: TransformParametersTypeDef,  # (2)
    Role: str,
    Description: str = ...,
    GlueVersion: str = ...,
    MaxCapacity: float = ...,
    WorkerType: WorkerTypeType = ...,  # (3)
    NumberOfWorkers: int = ...,
    Timeout: int = ...,
    MaxRetries: int = ...,
    Tags: Mapping[str, str] = ...,
    TransformEncryption: TransformEncryptionTypeDef = ...,  # (4)
) -> CreateMLTransformResponseTypeDef:  # (5)
    ...
  1. See GlueTableTypeDef
  2. See TransformParametersTypeDef
  3. See WorkerTypeType
  4. See TransformEncryptionTypeDef
  5. See CreateMLTransformResponseTypeDef 
# create_ml_transform method usage example with argument unpacking

kwargs: CreateMLTransformRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "InputRecordTables": ...,
    "Parameters": ...,
    "Role": ...,
}

parent.create_ml_transform(**kwargs)
  1. See CreateMLTransformRequestRequestTypeDef

create_partition#

Creates a new partition.

Type annotations and code completion for boto3.client("glue").create_partition method. boto3 documentation

# create_partition method definition

def create_partition(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    PartitionInput: PartitionInputTypeDef,  # (1)
    CatalogId: str = ...,
) -> Dict[str, Any]:
    ...
  1. See PartitionInputTypeDef 
# create_partition method usage example with argument unpacking

kwargs: CreatePartitionRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
    "PartitionInput": ...,
}

parent.create_partition(**kwargs)
  1. See CreatePartitionRequestRequestTypeDef

create_partition_index#

Creates a specified partition index in an existing table.

Type annotations and code completion for boto3.client("glue").create_partition_index method. boto3 documentation

# create_partition_index method definition

def create_partition_index(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    PartitionIndex: PartitionIndexTypeDef,  # (1)
    CatalogId: str = ...,
) -> Dict[str, Any]:
    ...
  1. See PartitionIndexTypeDef 
# create_partition_index method usage example with argument unpacking

kwargs: CreatePartitionIndexRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
    "PartitionIndex": ...,
}

parent.create_partition_index(**kwargs)
  1. See CreatePartitionIndexRequestRequestTypeDef

create_registry#

Creates a new registry which may be used to hold a collection of schemas.

Type annotations and code completion for boto3.client("glue").create_registry method. boto3 documentation

# create_registry method definition

def create_registry(
    self,
    *,
    RegistryName: str,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateRegistryResponseTypeDef:  # (1)
    ...
  1. See CreateRegistryResponseTypeDef 
# create_registry method usage example with argument unpacking

kwargs: CreateRegistryInputRequestTypeDef = {  # (1)
    "RegistryName": ...,
}

parent.create_registry(**kwargs)
  1. See CreateRegistryInputRequestTypeDef

create_schema#

Creates a new schema set and registers the schema definition.

Type annotations and code completion for boto3.client("glue").create_schema method. boto3 documentation

# create_schema method definition

def create_schema(
    self,
    *,
    SchemaName: str,
    DataFormat: DataFormatType,  # (1)
    RegistryId: RegistryIdTypeDef = ...,  # (2)
    Compatibility: CompatibilityType = ...,  # (3)
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
    SchemaDefinition: str = ...,
) -> CreateSchemaResponseTypeDef:  # (4)
    ...
  1. See DataFormatType
  2. See RegistryIdTypeDef
  3. See CompatibilityType
  4. See CreateSchemaResponseTypeDef 
# create_schema method usage example with argument unpacking

kwargs: CreateSchemaInputRequestTypeDef = {  # (1)
    "SchemaName": ...,
    "DataFormat": ...,
}

parent.create_schema(**kwargs)
  1. See CreateSchemaInputRequestTypeDef

create_script#

Transforms a directed acyclic graph (DAG) into code.

Type annotations and code completion for boto3.client("glue").create_script method. boto3 documentation

# create_script method definition

def create_script(
    self,
    *,
    DagNodes: Sequence[CodeGenNodeTypeDef] = ...,  # (1)
    DagEdges: Sequence[CodeGenEdgeTypeDef] = ...,  # (2)
    Language: LanguageType = ...,  # (3)
) -> CreateScriptResponseTypeDef:  # (4)
    ...
  1. See CodeGenNodeTypeDef
  2. See CodeGenEdgeTypeDef
  3. See LanguageType
  4. See CreateScriptResponseTypeDef 
# create_script method usage example with argument unpacking

kwargs: CreateScriptRequestRequestTypeDef = {  # (1)
    "DagNodes": ...,
}

parent.create_script(**kwargs)
  1. See CreateScriptRequestRequestTypeDef

create_security_configuration#

Creates a new security configuration.

Type annotations and code completion for boto3.client("glue").create_security_configuration method. boto3 documentation

# create_security_configuration method definition

def create_security_configuration(
    self,
    *,
    Name: str,
    EncryptionConfiguration: EncryptionConfigurationTypeDef,  # (1)
) -> CreateSecurityConfigurationResponseTypeDef:  # (2)
    ...
  1. See EncryptionConfigurationTypeDef
  2. See CreateSecurityConfigurationResponseTypeDef 
# create_security_configuration method usage example with argument unpacking

kwargs: CreateSecurityConfigurationRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "EncryptionConfiguration": ...,
}

parent.create_security_configuration(**kwargs)
  1. See CreateSecurityConfigurationRequestRequestTypeDef

create_session#

Creates a new session.

Type annotations and code completion for boto3.client("glue").create_session method. boto3 documentation

# create_session method definition

def create_session(
    self,
    *,
    Id: str,
    Role: str,
    Command: SessionCommandTypeDef,  # (1)
    Description: str = ...,
    Timeout: int = ...,
    IdleTimeout: int = ...,
    DefaultArguments: Mapping[str, str] = ...,
    Connections: ConnectionsListTypeDef = ...,  # (2)
    MaxCapacity: float = ...,
    NumberOfWorkers: int = ...,
    WorkerType: WorkerTypeType = ...,  # (3)
    SecurityConfiguration: str = ...,
    GlueVersion: str = ...,
    Tags: Mapping[str, str] = ...,
    RequestOrigin: str = ...,
) -> CreateSessionResponseTypeDef:  # (4)
    ...
  1. See SessionCommandTypeDef
  2. See ConnectionsListTypeDef
  3. See WorkerTypeType
  4. See CreateSessionResponseTypeDef 
# create_session method usage example with argument unpacking

kwargs: CreateSessionRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "Role": ...,
    "Command": ...,
}

parent.create_session(**kwargs)
  1. See CreateSessionRequestRequestTypeDef

create_table#

Creates a new table definition in the Data Catalog.

Type annotations and code completion for boto3.client("glue").create_table method. boto3 documentation

# create_table method definition

def create_table(
    self,
    *,
    DatabaseName: str,
    TableInput: TableInputTypeDef,  # (1)
    CatalogId: str = ...,
    PartitionIndexes: Sequence[PartitionIndexTypeDef] = ...,  # (2)
    TransactionId: str = ...,
) -> Dict[str, Any]:
    ...
  1. See TableInputTypeDef
  2. See PartitionIndexTypeDef 
# create_table method usage example with argument unpacking

kwargs: CreateTableRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableInput": ...,
}

parent.create_table(**kwargs)
  1. See CreateTableRequestRequestTypeDef

create_trigger#

Creates a new trigger.

Type annotations and code completion for boto3.client("glue").create_trigger method. boto3 documentation

# create_trigger method definition

def create_trigger(
    self,
    *,
    Name: str,
    Type: TriggerTypeType,  # (1)
    Actions: Sequence[ActionTypeDef],  # (2)
    WorkflowName: str = ...,
    Schedule: str = ...,
    Predicate: PredicateTypeDef = ...,  # (3)
    Description: str = ...,
    StartOnCreation: bool = ...,
    Tags: Mapping[str, str] = ...,
    EventBatchingCondition: EventBatchingConditionTypeDef = ...,  # (4)
) -> CreateTriggerResponseTypeDef:  # (5)
    ...
  1. See TriggerTypeType
  2. See ActionTypeDef
  3. See PredicateTypeDef
  4. See EventBatchingConditionTypeDef
  5. See CreateTriggerResponseTypeDef 
# create_trigger method usage example with argument unpacking

kwargs: CreateTriggerRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Type": ...,
    "Actions": ...,
}

parent.create_trigger(**kwargs)
  1. See CreateTriggerRequestRequestTypeDef

create_user_defined_function#

Creates a new function definition in the Data Catalog.

Type annotations and code completion for boto3.client("glue").create_user_defined_function method. boto3 documentation

# create_user_defined_function method definition

def create_user_defined_function(
    self,
    *,
    DatabaseName: str,
    FunctionInput: UserDefinedFunctionInputTypeDef,  # (1)
    CatalogId: str = ...,
) -> Dict[str, Any]:
    ...
  1. See UserDefinedFunctionInputTypeDef 
# create_user_defined_function method usage example with argument unpacking

kwargs: CreateUserDefinedFunctionRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "FunctionInput": ...,
}

parent.create_user_defined_function(**kwargs)
  1. See CreateUserDefinedFunctionRequestRequestTypeDef

create_workflow#

Creates a new workflow.

Type annotations and code completion for boto3.client("glue").create_workflow method. boto3 documentation

# create_workflow method definition

def create_workflow(
    self,
    *,
    Name: str,
    Description: str = ...,
    DefaultRunProperties: Mapping[str, str] = ...,
    Tags: Mapping[str, str] = ...,
    MaxConcurrentRuns: int = ...,
) -> CreateWorkflowResponseTypeDef:  # (1)
    ...
  1. See CreateWorkflowResponseTypeDef 
# create_workflow method usage example with argument unpacking

kwargs: CreateWorkflowRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_workflow(**kwargs)
  1. See CreateWorkflowRequestRequestTypeDef

delete_blueprint#

Deletes an existing blueprint.

Type annotations and code completion for boto3.client("glue").delete_blueprint method. boto3 documentation

# delete_blueprint method definition

def delete_blueprint(
    self,
    *,
    Name: str,
) -> DeleteBlueprintResponseTypeDef:  # (1)
    ...
  1. See DeleteBlueprintResponseTypeDef 
# delete_blueprint method usage example with argument unpacking

kwargs: DeleteBlueprintRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_blueprint(**kwargs)
  1. See DeleteBlueprintRequestRequestTypeDef

delete_classifier#

Removes a classifier from the Data Catalog.

Type annotations and code completion for boto3.client("glue").delete_classifier method. boto3 documentation

# delete_classifier method definition

def delete_classifier(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
# delete_classifier method usage example with argument unpacking

kwargs: DeleteClassifierRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_classifier(**kwargs)
  1. See DeleteClassifierRequestRequestTypeDef

delete_column_statistics_for_partition#

Delete the partition column statistics of a column.

Type annotations and code completion for boto3.client("glue").delete_column_statistics_for_partition method. boto3 documentation

# delete_column_statistics_for_partition method definition

def delete_column_statistics_for_partition(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    PartitionValues: Sequence[str],
    ColumnName: str,
    CatalogId: str = ...,
) -> Dict[str, Any]:
    ...
# delete_column_statistics_for_partition method usage example with argument unpacking

kwargs: DeleteColumnStatisticsForPartitionRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
    "PartitionValues": ...,
    "ColumnName": ...,
}

parent.delete_column_statistics_for_partition(**kwargs)
  1. See DeleteColumnStatisticsForPartitionRequestRequestTypeDef

delete_column_statistics_for_table#

Retrieves table statistics of columns.

Type annotations and code completion for boto3.client("glue").delete_column_statistics_for_table method. boto3 documentation

# delete_column_statistics_for_table method definition

def delete_column_statistics_for_table(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    ColumnName: str,
    CatalogId: str = ...,
) -> Dict[str, Any]:
    ...
# delete_column_statistics_for_table method usage example with argument unpacking

kwargs: DeleteColumnStatisticsForTableRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
    "ColumnName": ...,
}

parent.delete_column_statistics_for_table(**kwargs)
  1. See DeleteColumnStatisticsForTableRequestRequestTypeDef

delete_connection#

Deletes a connection from the Data Catalog.

Type annotations and code completion for boto3.client("glue").delete_connection method. boto3 documentation

# delete_connection method definition

def delete_connection(
    self,
    *,
    ConnectionName: str,
    CatalogId: str = ...,
) -> Dict[str, Any]:
    ...
# delete_connection method usage example with argument unpacking

kwargs: DeleteConnectionRequestRequestTypeDef = {  # (1)
    "ConnectionName": ...,
}

parent.delete_connection(**kwargs)
  1. See DeleteConnectionRequestRequestTypeDef

delete_crawler#

Removes a specified crawler from the Glue Data Catalog, unless the crawler state is RUNNING.

Type annotations and code completion for boto3.client("glue").delete_crawler method. boto3 documentation

# delete_crawler method definition

def delete_crawler(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
# delete_crawler method usage example with argument unpacking

kwargs: DeleteCrawlerRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_crawler(**kwargs)
  1. See DeleteCrawlerRequestRequestTypeDef

delete_custom_entity_type#

Deletes a custom pattern by specifying its name.

Type annotations and code completion for boto3.client("glue").delete_custom_entity_type method. boto3 documentation

# delete_custom_entity_type method definition

def delete_custom_entity_type(
    self,
    *,
    Name: str,
) -> DeleteCustomEntityTypeResponseTypeDef:  # (1)
    ...
  1. See DeleteCustomEntityTypeResponseTypeDef 
# delete_custom_entity_type method usage example with argument unpacking

kwargs: DeleteCustomEntityTypeRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_custom_entity_type(**kwargs)
  1. See DeleteCustomEntityTypeRequestRequestTypeDef

delete_data_quality_ruleset#

Deletes a data quality ruleset.

Type annotations and code completion for boto3.client("glue").delete_data_quality_ruleset method. boto3 documentation

# delete_data_quality_ruleset method definition

def delete_data_quality_ruleset(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
# delete_data_quality_ruleset method usage example with argument unpacking

kwargs: DeleteDataQualityRulesetRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_data_quality_ruleset(**kwargs)
  1. See DeleteDataQualityRulesetRequestRequestTypeDef

delete_database#

Removes a specified database from a Data Catalog.

Type annotations and code completion for boto3.client("glue").delete_database method. boto3 documentation

# delete_database method definition

def delete_database(
    self,
    *,
    Name: str,
    CatalogId: str = ...,
) -> Dict[str, Any]:
    ...
# delete_database method usage example with argument unpacking

kwargs: DeleteDatabaseRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_database(**kwargs)
  1. See DeleteDatabaseRequestRequestTypeDef

delete_dev_endpoint#

Deletes a specified development endpoint.

Type annotations and code completion for boto3.client("glue").delete_dev_endpoint method. boto3 documentation

# delete_dev_endpoint method definition

def delete_dev_endpoint(
    self,
    *,
    EndpointName: str,
) -> Dict[str, Any]:
    ...
# delete_dev_endpoint method usage example with argument unpacking

kwargs: DeleteDevEndpointRequestRequestTypeDef = {  # (1)
    "EndpointName": ...,
}

parent.delete_dev_endpoint(**kwargs)
  1. See DeleteDevEndpointRequestRequestTypeDef

delete_job#

Deletes a specified job definition.

Type annotations and code completion for boto3.client("glue").delete_job method. boto3 documentation

# delete_job method definition

def delete_job(
    self,
    *,
    JobName: str,
) -> DeleteJobResponseTypeDef:  # (1)
    ...
  1. See DeleteJobResponseTypeDef 
# delete_job method usage example with argument unpacking

kwargs: DeleteJobRequestRequestTypeDef = {  # (1)
    "JobName": ...,
}

parent.delete_job(**kwargs)
  1. See DeleteJobRequestRequestTypeDef

delete_ml_transform#

Deletes an Glue machine learning transform.

Type annotations and code completion for boto3.client("glue").delete_ml_transform method. boto3 documentation

# delete_ml_transform method definition

def delete_ml_transform(
    self,
    *,
    TransformId: str,
) -> DeleteMLTransformResponseTypeDef:  # (1)
    ...
  1. See DeleteMLTransformResponseTypeDef 
# delete_ml_transform method usage example with argument unpacking

kwargs: DeleteMLTransformRequestRequestTypeDef = {  # (1)
    "TransformId": ...,
}