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)
...
# batch_create_partition method usage example with argument unpacking
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
# batch_delete_connection method definition
def batch_delete_connection(
self,
*,
ConnectionNameList: Sequence[str],
CatalogId: str = ...,
) -> BatchDeleteConnectionResponseTypeDef: # (1)
...
# batch_delete_connection method usage example with argument unpacking
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
# batch_delete_partition method definition
def batch_delete_partition(
self,
*,
DatabaseName: str,
TableName: str,
PartitionsToDelete: Sequence[PartitionValueListTypeDef], # (1)
CatalogId: str = ...,
) -> BatchDeletePartitionResponseTypeDef: # (2)
...
# batch_delete_partition method usage example with argument unpacking
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
# batch_delete_table method definition
def batch_delete_table(
self,
*,
DatabaseName: str,
TablesToDelete: Sequence[str],
CatalogId: str = ...,
TransactionId: str = ...,
) -> BatchDeleteTableResponseTypeDef: # (1)
...
# batch_delete_table method usage example with argument unpacking
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
# batch_delete_table_version method definition
def batch_delete_table_version(
self,
*,
DatabaseName: str,
TableName: str,
VersionIds: Sequence[str],
CatalogId: str = ...,
) -> BatchDeleteTableVersionResponseTypeDef: # (1)
...
# batch_delete_table_version method usage example with argument unpacking
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
# batch_get_blueprints method definition
def batch_get_blueprints(
self,
*,
Names: Sequence[str],
IncludeBlueprint: bool = ...,
IncludeParameterSpec: bool = ...,
) -> BatchGetBlueprintsResponseTypeDef: # (1)
...
# batch_get_blueprints method usage example with argument unpacking
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
# batch_get_crawlers method definition
def batch_get_crawlers(
self,
*,
CrawlerNames: Sequence[str],
) -> BatchGetCrawlersResponseTypeDef: # (1)
...
# batch_get_crawlers method usage example with argument unpacking
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
# batch_get_custom_entity_types method definition
def batch_get_custom_entity_types(
self,
*,
Names: Sequence[str],
) -> BatchGetCustomEntityTypesResponseTypeDef: # (1)
...
# batch_get_custom_entity_types method usage example with argument unpacking
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
# batch_get_data_quality_result method definition
def batch_get_data_quality_result(
self,
*,
ResultIds: Sequence[str],
) -> BatchGetDataQualityResultResponseTypeDef: # (1)
...
# batch_get_data_quality_result method usage example with argument unpacking
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
# batch_get_dev_endpoints method definition
def batch_get_dev_endpoints(
self,
*,
DevEndpointNames: Sequence[str],
) -> BatchGetDevEndpointsResponseTypeDef: # (1)
...
# batch_get_dev_endpoints method usage example with argument unpacking
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
# batch_get_jobs method definition
def batch_get_jobs(
self,
*,
JobNames: Sequence[str],
) -> BatchGetJobsResponseTypeDef: # (1)
...
# batch_get_jobs method usage example with argument unpacking
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
# batch_get_partition method definition
def batch_get_partition(
self,
*,
DatabaseName: str,
TableName: str,
PartitionsToGet: Sequence[PartitionValueListTypeDef], # (1)
CatalogId: str = ...,
) -> BatchGetPartitionResponseTypeDef: # (2)
...
# batch_get_partition method usage example with argument unpacking
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
# batch_get_triggers method definition
def batch_get_triggers(
self,
*,
TriggerNames: Sequence[str],
) -> BatchGetTriggersResponseTypeDef: # (1)
...
# batch_get_triggers method usage example with argument unpacking
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
# batch_get_workflows method definition
def batch_get_workflows(
self,
*,
Names: Sequence[str],
IncludeGraph: bool = ...,
) -> BatchGetWorkflowsResponseTypeDef: # (1)
...
# batch_get_workflows method usage example with argument unpacking
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
# batch_stop_job_run method definition
def batch_stop_job_run(
self,
*,
JobName: str,
JobRunIds: Sequence[str],
) -> BatchStopJobRunResponseTypeDef: # (1)
...
# batch_stop_job_run method usage example with argument unpacking
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
# batch_update_partition method definition
def batch_update_partition(
self,
*,
DatabaseName: str,
TableName: str,
Entries: Sequence[BatchUpdatePartitionRequestEntryTypeDef], # (1)
CatalogId: str = ...,
) -> BatchUpdatePartitionResponseTypeDef: # (2)
...
# batch_update_partition method usage example with argument unpacking
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
# 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)
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.