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
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.
client = boto3.client("glue")
try:
do_something(client)
except (
client.AccessDeniedException,
client.AlreadyExistsException,
client.ClientError,
client.ConcurrentModificationException,
client.ConcurrentRunsExceededException,
client.ConditionCheckFailureException,
client.ConflictException,
client.CrawlerNotRunningException,
client.CrawlerRunningException,
client.CrawlerStoppingException,
client.EntityNotFoundException,
client.GlueEncryptionException,
client.IdempotentParameterMismatchException,
client.IllegalBlueprintStateException,
client.IllegalSessionStateException,
client.IllegalWorkflowStateException,
client.InternalServiceException,
client.InvalidInputException,
client.InvalidStateException,
client.MLTransformNotReadyException,
client.NoScheduleException,
client.OperationTimeoutException,
client.PermissionTypeMismatchException,
client.ResourceNotReadyException,
client.ResourceNumberLimitExceededException,
client.SchedulerNotRunningException,
client.SchedulerRunningException,
client.SchedulerTransitioningException,
client.ValidationException,
client.VersionMismatchException,
) as e:
print(e)
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
def batch_create_partition(
self,
*,
DatabaseName: str,
TableName: str,
PartitionInputList: Sequence[PartitionInputTypeDef], # (1)
CatalogId: str = ...,
) -> BatchCreatePartitionResponseTypeDef: # (2)
...
kwargs: BatchCreatePartitionRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
"PartitionInputList": ...,
}
parent.batch_create_partition(**kwargs)
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
def batch_delete_connection(
self,
*,
ConnectionNameList: Sequence[str],
CatalogId: str = ...,
) -> BatchDeleteConnectionResponseTypeDef: # (1)
...
kwargs: BatchDeleteConnectionRequestRequestTypeDef = { # (1)
"ConnectionNameList": ...,
}
parent.batch_delete_connection(**kwargs)
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
def batch_delete_partition(
self,
*,
DatabaseName: str,
TableName: str,
PartitionsToDelete: Sequence[PartitionValueListTypeDef], # (1)
CatalogId: str = ...,
) -> BatchDeletePartitionResponseTypeDef: # (2)
...
kwargs: BatchDeletePartitionRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
"PartitionsToDelete": ...,
}
parent.batch_delete_partition(**kwargs)
batch_delete_table
Deletes multiple tables at once.
Type annotations and code completion for boto3.client("glue").batch_delete_table
method.
boto3 documentation
def batch_delete_table(
self,
*,
DatabaseName: str,
TablesToDelete: Sequence[str],
CatalogId: str = ...,
TransactionId: str = ...,
) -> BatchDeleteTableResponseTypeDef: # (1)
...
kwargs: BatchDeleteTableRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TablesToDelete": ...,
}
parent.batch_delete_table(**kwargs)
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
def batch_delete_table_version(
self,
*,
DatabaseName: str,
TableName: str,
VersionIds: Sequence[str],
CatalogId: str = ...,
) -> BatchDeleteTableVersionResponseTypeDef: # (1)
...
kwargs: BatchDeleteTableVersionRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
"VersionIds": ...,
}
parent.batch_delete_table_version(**kwargs)
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
def batch_get_blueprints(
self,
*,
Names: Sequence[str],
IncludeBlueprint: bool = ...,
IncludeParameterSpec: bool = ...,
) -> BatchGetBlueprintsResponseTypeDef: # (1)
...
kwargs: BatchGetBlueprintsRequestRequestTypeDef = { # (1)
"Names": ...,
}
parent.batch_get_blueprints(**kwargs)
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
def batch_get_crawlers(
self,
*,
CrawlerNames: Sequence[str],
) -> BatchGetCrawlersResponseTypeDef: # (1)
...
kwargs: BatchGetCrawlersRequestRequestTypeDef = { # (1)
"CrawlerNames": ...,
}
parent.batch_get_crawlers(**kwargs)
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
def batch_get_custom_entity_types(
self,
*,
Names: Sequence[str],
) -> BatchGetCustomEntityTypesResponseTypeDef: # (1)
...
kwargs: BatchGetCustomEntityTypesRequestRequestTypeDef = { # (1)
"Names": ...,
}
parent.batch_get_custom_entity_types(**kwargs)
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
def batch_get_data_quality_result(
self,
*,
ResultIds: Sequence[str],
) -> BatchGetDataQualityResultResponseTypeDef: # (1)
...
kwargs: BatchGetDataQualityResultRequestRequestTypeDef = { # (1)
"ResultIds": ...,
}
parent.batch_get_data_quality_result(**kwargs)
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
def batch_get_dev_endpoints(
self,
*,
DevEndpointNames: Sequence[str],
) -> BatchGetDevEndpointsResponseTypeDef: # (1)
...
kwargs: BatchGetDevEndpointsRequestRequestTypeDef = { # (1)
"DevEndpointNames": ...,
}
parent.batch_get_dev_endpoints(**kwargs)
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
def batch_get_jobs(
self,
*,
JobNames: Sequence[str],
) -> BatchGetJobsResponseTypeDef: # (1)
...
kwargs: BatchGetJobsRequestRequestTypeDef = { # (1)
"JobNames": ...,
}
parent.batch_get_jobs(**kwargs)
batch_get_partition
Retrieves partitions in a batch request.
Type annotations and code completion for boto3.client("glue").batch_get_partition
method.
boto3 documentation
def batch_get_partition(
self,
*,
DatabaseName: str,
TableName: str,
PartitionsToGet: Sequence[PartitionValueListTypeDef], # (1)
CatalogId: str = ...,
) -> BatchGetPartitionResponseTypeDef: # (2)
...
kwargs: BatchGetPartitionRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
"PartitionsToGet": ...,
}
parent.batch_get_partition(**kwargs)
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
def batch_get_triggers(
self,
*,
TriggerNames: Sequence[str],
) -> BatchGetTriggersResponseTypeDef: # (1)
...
kwargs: BatchGetTriggersRequestRequestTypeDef = { # (1)
"TriggerNames": ...,
}
parent.batch_get_triggers(**kwargs)
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
def batch_get_workflows(
self,
*,
Names: Sequence[str],
IncludeGraph: bool = ...,
) -> BatchGetWorkflowsResponseTypeDef: # (1)
...
kwargs: BatchGetWorkflowsRequestRequestTypeDef = { # (1)
"Names": ...,
}
parent.batch_get_workflows(**kwargs)
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
def batch_stop_job_run(
self,
*,
JobName: str,
JobRunIds: Sequence[str],
) -> BatchStopJobRunResponseTypeDef: # (1)
...
kwargs: BatchStopJobRunRequestRequestTypeDef = { # (1)
"JobName": ...,
"JobRunIds": ...,
}
parent.batch_stop_job_run(**kwargs)
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
def batch_update_partition(
self,
*,
DatabaseName: str,
TableName: str,
Entries: Sequence[BatchUpdatePartitionRequestEntryTypeDef], # (1)
CatalogId: str = ...,
) -> BatchUpdatePartitionResponseTypeDef: # (2)
...
kwargs: BatchUpdatePartitionRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
"Entries": ...,
}
parent.batch_update_partition(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("glue").can_paginate
method.
boto3 documentation
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
def cancel_data_quality_rule_recommendation_run(
self,
*,
RunId: str,
) -> Dict[str, Any]:
...
kwargs: CancelDataQualityRuleRecommendationRunRequestRequestTypeDef = { # (1)
"RunId": ...,
}
parent.cancel_data_quality_rule_recommendation_run(**kwargs)
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
def cancel_data_quality_ruleset_evaluation_run(
self,
*,
RunId: str,
) -> Dict[str, Any]:
...
kwargs: CancelDataQualityRulesetEvaluationRunRequestRequestTypeDef = { # (1)
"RunId": ...,
}
parent.cancel_data_quality_ruleset_evaluation_run(**kwargs)
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
def cancel_ml_task_run(
self,
*,
TransformId: str,
TaskRunId: str,
) -> CancelMLTaskRunResponseTypeDef: # (1)
...
kwargs: CancelMLTaskRunRequestRequestTypeDef = { # (1)
"TransformId": ...,
"TaskRunId": ...,
}
parent.cancel_ml_task_run(**kwargs)
cancel_statement
Cancels the statement.
Type annotations and code completion for boto3.client("glue").cancel_statement
method.
boto3 documentation
def cancel_statement(
self,
*,
SessionId: str,
Id: int,
RequestOrigin: str = ...,
) -> Dict[str, Any]:
...
kwargs: CancelStatementRequestRequestTypeDef = { # (1)
"SessionId": ...,
"Id": ...,
}
parent.cancel_statement(**kwargs)
check_schema_version_validity
Validates the supplied schema.
Type annotations and code completion for boto3.client("glue").check_schema_version_validity
method.
boto3 documentation
def check_schema_version_validity(
self,
*,
DataFormat: DataFormatType, # (1)
SchemaDefinition: str,
) -> CheckSchemaVersionValidityResponseTypeDef: # (2)
...
kwargs: CheckSchemaVersionValidityInputRequestTypeDef = { # (1)
"DataFormat": ...,
"SchemaDefinition": ...,
}
parent.check_schema_version_validity(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("glue").close
method.
boto3 documentation
create_blueprint
Registers a blueprint with Glue.
Type annotations and code completion for boto3.client("glue").create_blueprint
method.
boto3 documentation
def create_blueprint(
self,
*,
Name: str,
BlueprintLocation: str,
Description: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateBlueprintResponseTypeDef: # (1)
...
kwargs: CreateBlueprintRequestRequestTypeDef = { # (1)
"Name": ...,
"BlueprintLocation": ...,
}
parent.create_blueprint(**kwargs)
create_classifier
Creates a classifier in the user's account.
Type annotations and code completion for boto3.client("glue").create_classifier
method.
boto3 documentation
def create_classifier(
self,
*,
GrokClassifier: CreateGrokClassifierRequestTypeDef = ..., # (1)
XMLClassifier: CreateXMLClassifierRequestTypeDef = ..., # (2)
JsonClassifier: CreateJsonClassifierRequestTypeDef = ..., # (3)
CsvClassifier: CreateCsvClassifierRequestTypeDef = ..., # (4)
) -> Dict[str, Any]:
...
- See CreateGrokClassifierRequestTypeDef
- See CreateXMLClassifierRequestTypeDef
- See CreateJsonClassifierRequestTypeDef
- See CreateCsvClassifierRequestTypeDef
kwargs: CreateClassifierRequestRequestTypeDef = { # (1)
"GrokClassifier": ...,
}
parent.create_classifier(**kwargs)
create_connection
Creates a connection definition in the Data Catalog.
Type annotations and code completion for boto3.client("glue").create_connection
method.
boto3 documentation
def create_connection(
self,
*,
ConnectionInput: ConnectionInputTypeDef, # (1)
CatalogId: str = ...,
Tags: Mapping[str, str] = ...,
) -> Dict[str, Any]:
...
kwargs: CreateConnectionRequestRequestTypeDef = { # (1)
"ConnectionInput": ...,
}
parent.create_connection(**kwargs)
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
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]:
...
- See CrawlerTargetsTypeDef
- See SchemaChangePolicyTypeDef
- See RecrawlPolicyTypeDef
- See LineageConfigurationTypeDef
- See LakeFormationConfigurationTypeDef
kwargs: CreateCrawlerRequestRequestTypeDef = { # (1)
"Name": ...,
"Role": ...,
"Targets": ...,
}
parent.create_crawler(**kwargs)
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
def create_custom_entity_type(
self,
*,
Name: str,
RegexString: str,
ContextWords: Sequence[str] = ...,
) -> CreateCustomEntityTypeResponseTypeDef: # (1)
...
kwargs: CreateCustomEntityTypeRequestRequestTypeDef = { # (1)
"Name": ...,
"RegexString": ...,
}
parent.create_custom_entity_type(**kwargs)
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
def create_data_quality_ruleset(
self,
*,
Name: str,
Ruleset: str,
Description: str = ...,
Tags: Mapping[str, str] = ...,
TargetTable: DataQualityTargetTableTypeDef = ..., # (1)
ClientToken: str = ...,
) -> CreateDataQualityRulesetResponseTypeDef: # (2)
...
kwargs: CreateDataQualityRulesetRequestRequestTypeDef = { # (1)
"Name": ...,
"Ruleset": ...,
}
parent.create_data_quality_ruleset(**kwargs)
create_database
Creates a new database in a Data Catalog.
Type annotations and code completion for boto3.client("glue").create_database
method.
boto3 documentation
def create_database(
self,
*,
DatabaseInput: DatabaseInputTypeDef, # (1)
CatalogId: str = ...,
Tags: Mapping[str, str] = ...,
) -> Dict[str, Any]:
...
kwargs: CreateDatabaseRequestRequestTypeDef = { # (1)
"DatabaseInput": ...,
}
parent.create_database(**kwargs)
create_dev_endpoint
Creates a new development endpoint.
Type annotations and code completion for boto3.client("glue").create_dev_endpoint
method.
boto3 documentation
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)
...
kwargs: CreateDevEndpointRequestRequestTypeDef = { # (1)
"EndpointName": ...,
"RoleArn": ...,
}
parent.create_dev_endpoint(**kwargs)
create_job
Creates a new job definition.
Type annotations and code completion for boto3.client("glue").create_job
method.
boto3 documentation
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)
...
- See JobCommandTypeDef
- See ExecutionPropertyTypeDef
- See ConnectionsListTypeDef
- See NotificationPropertyTypeDef
- See WorkerTypeType
- See CodeGenConfigurationNodeTypeDef
- See ExecutionClassType
- See SourceControlDetailsTypeDef
- See CreateJobResponseTypeDef
kwargs: CreateJobRequestRequestTypeDef = { # (1)
"Name": ...,
"Role": ...,
"Command": ...,
}
parent.create_job(**kwargs)
create_ml_transform
Creates an Glue machine learning transform.
Type annotations and code completion for boto3.client("glue").create_ml_transform
method.
boto3 documentation
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)
...
- See GlueTableTypeDef
- See TransformParametersTypeDef
- See WorkerTypeType
- See TransformEncryptionTypeDef
- See CreateMLTransformResponseTypeDef
kwargs: CreateMLTransformRequestRequestTypeDef = { # (1)
"Name": ...,
"InputRecordTables": ...,
"Parameters": ...,
"Role": ...,
}
parent.create_ml_transform(**kwargs)
create_partition
Creates a new partition.
Type annotations and code completion for boto3.client("glue").create_partition
method.
boto3 documentation
def create_partition(
self,
*,
DatabaseName: str,
TableName: str,
PartitionInput: PartitionInputTypeDef, # (1)
CatalogId: str = ...,
) -> Dict[str, Any]:
...
kwargs: CreatePartitionRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
"PartitionInput": ...,
}
parent.create_partition(**kwargs)
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
def create_partition_index(
self,
*,
DatabaseName: str,
TableName: str,
PartitionIndex: PartitionIndexTypeDef, # (1)
CatalogId: str = ...,
) -> Dict[str, Any]:
...
kwargs: CreatePartitionIndexRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
"PartitionIndex": ...,
}
parent.create_partition_index(**kwargs)
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
def create_registry(
self,
*,
RegistryName: str,
Description: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateRegistryResponseTypeDef: # (1)
...
kwargs: CreateRegistryInputRequestTypeDef = { # (1)
"RegistryName": ...,
}
parent.create_registry(**kwargs)
create_schema
Creates a new schema set and registers the schema definition.
Type annotations and code completion for boto3.client("glue").create_schema
method.