Table of Contents
A low-level client representing AWS Glue
Defines the public endpoint for the Glue service.
import boto3
client = boto3.client('glue')
These are the available methods:
Creates one or more partitions in a batch operation.
See also: AWS API Documentation
Request Syntax
response = client.batch_create_partition(
CatalogId='string',
DatabaseName='string',
TableName='string',
PartitionInputList=[
{
'Values': [
'string',
],
'LastAccessTime': datetime(2015, 1, 1),
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'Parameters': {
'string': 'string'
},
'LastAnalyzedTime': datetime(2015, 1, 1)
},
]
)
[REQUIRED]
The name of the metadata database in which the partition is to be created.
[REQUIRED]
The name of the metadata table in which the partition is to be created.
[REQUIRED]
A list of PartitionInput structures that define the partitions to be created.
The structure used to create and update a partition.
The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.
The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.
The last time at which the partition was accessed.
Provides information about the physical location where the partition is stored.
A list of the Columns in the table.
A column in a Table .
The name of the Column .
The data type of the Column .
A free-form text comment.
These key-value pairs define properties associated with the column.
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
True if the data in the table is compressed, or False if not.
Must be specified if the table contains any dimension columns.
The serialization/deserialization (SerDe) information.
Name of the SerDe.
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
These key-value pairs define initialization parameters for the SerDe.
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
A list specifying the sort order of each bucket in the table.
Specifies the sort order of a sorted column.
The name of the column.
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
The user-supplied properties in key-value form.
The information about values that appear frequently in a column (skewed values).
A list of names of columns that contain skewed values.
A list of values that appear so frequently as to be considered skewed.
A mapping of skewed values to the columns that contain them.
True if the table data is stored in subdirectories, or False if not.
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
The version number of the schema.
These key-value pairs define partition parameters.
The last time at which column statistics were computed for this partition.
dict
Response Syntax
{
'Errors': [
{
'PartitionValues': [
'string',
],
'ErrorDetail': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
Errors (list) --
The errors encountered when trying to create the requested partitions.
(dict) --
Contains information about a partition error.
PartitionValues (list) --
The values that define the partition.
ErrorDetail (dict) --
The details about the partition error.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Exceptions
Deletes a list of connection definitions from the Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.batch_delete_connection(
CatalogId='string',
ConnectionNameList=[
'string',
]
)
[REQUIRED]
A list of names of the connections to delete.
dict
Response Syntax
{
'Succeeded': [
'string',
],
'Errors': {
'string': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
}
}
Response Structure
(dict) --
Succeeded (list) --
A list of names of the connection definitions that were successfully deleted.
Errors (dict) --
A map of the names of connections that were not successfully deleted to error details.
(string) --
(dict) --
Contains details about an error.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Exceptions
Deletes one or more partitions in a batch operation.
See also: AWS API Documentation
Request Syntax
response = client.batch_delete_partition(
CatalogId='string',
DatabaseName='string',
TableName='string',
PartitionsToDelete=[
{
'Values': [
'string',
]
},
]
)
[REQUIRED]
The name of the catalog database in which the table in question resides.
[REQUIRED]
The name of the table that contains the partitions to be deleted.
[REQUIRED]
A list of PartitionInput structures that define the partitions to be deleted.
Contains a list of values defining partitions.
The list of values.
dict
Response Syntax
{
'Errors': [
{
'PartitionValues': [
'string',
],
'ErrorDetail': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
Errors (list) --
The errors encountered when trying to delete the requested partitions.
(dict) --
Contains information about a partition error.
PartitionValues (list) --
The values that define the partition.
ErrorDetail (dict) --
The details about the partition error.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Exceptions
Deletes multiple tables at once.
Note
After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling BatchDeleteTable , use DeleteTableVersion or BatchDeleteTableVersion , and DeletePartition or BatchDeletePartition , to delete any resources that belong to the table.
See also: AWS API Documentation
Request Syntax
response = client.batch_delete_table(
CatalogId='string',
DatabaseName='string',
TablesToDelete=[
'string',
]
)
[REQUIRED]
The name of the catalog database in which the tables to delete reside. For Hive compatibility, this name is entirely lowercase.
[REQUIRED]
A list of the table to delete.
dict
Response Syntax
{
'Errors': [
{
'TableName': 'string',
'ErrorDetail': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
Errors (list) --
A list of errors encountered in attempting to delete the specified tables.
(dict) --
An error record for table operations.
TableName (string) --
The name of the table. For Hive compatibility, this must be entirely lowercase.
ErrorDetail (dict) --
The details about the error.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Exceptions
Deletes a specified batch of versions of a table.
See also: AWS API Documentation
Request Syntax
response = client.batch_delete_table_version(
CatalogId='string',
DatabaseName='string',
TableName='string',
VersionIds=[
'string',
]
)
[REQUIRED]
The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
[REQUIRED]
The name of the table. For Hive compatibility, this name is entirely lowercase.
[REQUIRED]
A list of the IDs of versions to be deleted. A VersionId is a string representation of an integer. Each version is incremented by 1.
dict
Response Syntax
{
'Errors': [
{
'TableName': 'string',
'VersionId': 'string',
'ErrorDetail': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
Errors (list) --
A list of errors encountered while trying to delete the specified table versions.
(dict) --
An error record for table-version operations.
TableName (string) --
The name of the table in question.
VersionId (string) --
The ID value of the version in question. A VersionID is a string representation of an integer. Each version is incremented by 1.
ErrorDetail (dict) --
The details about the error.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Exceptions
Retrieves information about a list of blueprints.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_blueprints(
Names=[
'string',
],
IncludeBlueprint=True|False,
IncludeParameterSpec=True|False
)
[REQUIRED]
A list of blueprint names.
dict
Response Syntax
{
'Blueprints': [
{
'Name': 'string',
'Description': 'string',
'CreatedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'ParameterSpec': 'string',
'BlueprintLocation': 'string',
'BlueprintServiceLocation': 'string',
'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'FAILED',
'ErrorMessage': 'string',
'LastActiveDefinition': {
'Description': 'string',
'LastModifiedOn': datetime(2015, 1, 1),
'ParameterSpec': 'string',
'BlueprintLocation': 'string',
'BlueprintServiceLocation': 'string'
}
},
],
'MissingBlueprints': [
'string',
]
}
Response Structure
(dict) --
Blueprints (list) --
Returns a list of blueprint as a Blueprints object.
(dict) --
The details of a blueprint.
Name (string) --
The name of the blueprint.
Description (string) --
The description of the blueprint.
CreatedOn (datetime) --
The date and time the blueprint was registered.
LastModifiedOn (datetime) --
The date and time the blueprint was last modified.
ParameterSpec (string) --
A JSON string that indicates the list of parameter specifications for the blueprint.
BlueprintLocation (string) --
Specifies the path in Amazon S3 where the blueprint is published.
BlueprintServiceLocation (string) --
Specifies a path in Amazon S3 where the blueprint is copied when you call CreateBlueprint/UpdateBlueprint to register the blueprint in Glue.
Status (string) --
The status of the blueprint registration.
ErrorMessage (string) --
An error message.
LastActiveDefinition (dict) --
When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.
Description (string) --
The description of the blueprint.
LastModifiedOn (datetime) --
The date and time the blueprint was last modified.
ParameterSpec (string) --
A JSON string specifying the parameters for the blueprint.
BlueprintLocation (string) --
Specifies a path in Amazon S3 where the blueprint is published by the Glue developer.
BlueprintServiceLocation (string) --
Specifies a path in Amazon S3 where the blueprint is copied when you create or update the blueprint.
MissingBlueprints (list) --
Returns a list of BlueprintNames that were not found.
Exceptions
Returns a list of resource metadata for a given list of crawler names. After calling the ListCrawlers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_crawlers(
CrawlerNames=[
'string',
]
)
[REQUIRED]
A list of crawler names, which might be the names returned from the ListCrawlers operation.
{
'Crawlers': [
{
'Name': 'string',
'Role': 'string',
'Targets': {
'S3Targets': [
{
'Path': 'string',
'Exclusions': [
'string',
],
'ConnectionName': 'string',
'SampleSize': 123,
'EventQueueArn': 'string',
'DlqEventQueueArn': 'string'
},
],
'JdbcTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'Exclusions': [
'string',
]
},
],
'MongoDBTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'ScanAll': True|False
},
],
'DynamoDBTargets': [
{
'Path': 'string',
'scanAll': True|False,
'scanRate': 123.0
},
],
'CatalogTargets': [
{
'DatabaseName': 'string',
'Tables': [
'string',
]
},
]
},
'DatabaseName': 'string',
'Description': 'string',
'Classifiers': [
'string',
],
'RecrawlPolicy': {
'RecrawlBehavior': 'CRAWL_EVERYTHING'|'CRAWL_NEW_FOLDERS_ONLY'|'CRAWL_EVENT_MODE'
},
'SchemaChangePolicy': {
'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
},
'LineageConfiguration': {
'CrawlerLineageSettings': 'ENABLE'|'DISABLE'
},
'State': 'READY'|'RUNNING'|'STOPPING',
'TablePrefix': 'string',
'Schedule': {
'ScheduleExpression': 'string',
'State': 'SCHEDULED'|'NOT_SCHEDULED'|'TRANSITIONING'
},
'CrawlElapsedTime': 123,
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'LastCrawl': {
'Status': 'SUCCEEDED'|'CANCELLED'|'FAILED',
'ErrorMessage': 'string',
'LogGroup': 'string',
'LogStream': 'string',
'MessagePrefix': 'string',
'StartTime': datetime(2015, 1, 1)
},
'Version': 123,
'Configuration': 'string',
'CrawlerSecurityConfiguration': 'string'
},
],
'CrawlersNotFound': [
'string',
]
}
Response Structure
A list of crawler definitions.
Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source in the Glue Data Catalog.
The name of the crawler.
The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
A collection of targets to crawl.
Specifies Amazon Simple Storage Service (Amazon S3) targets.
Specifies a data store in Amazon Simple Storage Service (Amazon S3).
The path to the Amazon S3 target.
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .
The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs .
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue .
Specifies JDBC targets.
Specifies a JDBC data store to crawl.
The name of the connection to use to connect to the JDBC target.
The path of the JDBC target.
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .
Specifies Amazon DocumentDB or MongoDB targets.
Specifies an Amazon DocumentDB or MongoDB data store to crawl.
The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
The path of the Amazon DocumentDB or MongoDB target (database/collection).
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .
Specifies Amazon DynamoDB targets.
Specifies an Amazon DynamoDB table to crawl.
The name of the DynamoDB table to crawl.
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .
The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
Specifies Glue Data Catalog targets.
Specifies an Glue Data Catalog target.
The name of the database to be synchronized.
A list of the tables to be synchronized.
The name of the database in which the crawler's output is stored.
A description of the crawler.
A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.
A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
The policy that specifies update and delete behaviors for the crawler.
The update behavior when the crawler finds a changed schema.
The deletion behavior when the crawler finds a deleted object.
A configuration that specifies whether data lineage is enabled for the crawler.
Specifies whether data lineage is enabled for the crawler. Valid values are:
Indicates whether the crawler is running, or whether a run is pending.
The prefix added to the names of tables that are created.
For scheduled crawlers, the schedule when the crawler runs.
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
The state of the schedule.
If the crawler is running, contains the total time elapsed since the last crawl began.
The time that the crawler was created.
The time that the crawler was last updated.
The status of the last crawl, and potentially error information if an error occurred.
Status of the last crawl.
If an error occurred, the error information about the last crawl.
The log group for the last crawl.
The log stream for the last crawl.
The prefix for a message about this crawl.
The time at which the crawl started.
The version of the crawler.
Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Include and Exclude Patterns .
The name of the SecurityConfiguration structure to be used by this crawler.
A list of names of crawlers that were not found.
Exceptions
Returns a list of resource metadata for a given list of development endpoint names. After calling the ListDevEndpoints operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_dev_endpoints(
DevEndpointNames=[
'string',
]
)
[REQUIRED]
The list of DevEndpoint names, which might be the names returned from the ListDevEndpoint operation.
{
'DevEndpoints': [
{
'EndpointName': 'string',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string',
'YarnEndpointAddress': 'string',
'PrivateAddress': 'string',
'ZeppelinRemoteSparkInterpreterPort': 123,
'PublicAddress': 'string',
'Status': 'string',
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'GlueVersion': 'string',
'NumberOfWorkers': 123,
'NumberOfNodes': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'ExtraPythonLibsS3Path': 'string',
'ExtraJarsS3Path': 'string',
'FailureReason': 'string',
'LastUpdateStatus': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastModifiedTimestamp': datetime(2015, 1, 1),
'PublicKey': 'string',
'PublicKeys': [
'string',
],
'SecurityConfiguration': 'string',
'Arguments': {
'string': 'string'
}
},
],
'DevEndpointsNotFound': [
'string',
]
}
Response Structure
A list of DevEndpoint definitions.
A development endpoint where a developer can remotely debug extract, transform, and load (ETL) scripts.
The name of the DevEndpoint .
The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint .
A list of security group identifiers used in this DevEndpoint .
The subnet ID for this DevEndpoint .
The YARN endpoint address used by this DevEndpoint .
A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your VPC.
The Apache Zeppelin port for the remote Apache Spark interpreter.
The public IP address used by this DevEndpoint . The PublicAddress field is present only when you create a non-virtual private cloud (VPC) DevEndpoint .
The current status of this DevEndpoint .
The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
The number of workers of a defined workerType that are allocated to the development endpoint.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint .
The AWS Availability Zone where this DevEndpoint is located.
The ID of the virtual private cloud (VPC) used by this DevEndpoint .
The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint . Multiple values must be complete paths separated by a comma.
Note
You can only use pure Python libraries with a DevEndpoint . Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.
The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint .
Note
You can only use pure Java/Scala libraries with a DevEndpoint .
The reason for a current failure in this DevEndpoint .
The status of the last update.
The point in time at which this DevEndpoint was created.
The point in time at which this DevEndpoint was last modified.
The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.
A list of public keys to be used by the DevEndpoints for authentication. Using this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.
Note
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint API operation with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
The name of the SecurityConfiguration structure to be used with this DevEndpoint .
A map of arguments used to configure the DevEndpoint .
Valid arguments are:
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
A list of DevEndpoints not found.
Exceptions
Returns a list of resource metadata for a given list of job names. After calling the ListJobs operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_jobs(
JobNames=[
'string',
]
)
[REQUIRED]
A list of job names, which might be the names returned from the ListJobs operation.
{
'Jobs': [
{
'Name': 'string',
'Description': 'string',
'LogUri': 'string',
'Role': 'string',
'CreatedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'ExecutionProperty': {
'MaxConcurrentRuns': 123
},
'Command': {
'Name': 'string',
'ScriptLocation': 'string',
'PythonVersion': 'string'
},
'DefaultArguments': {
'string': 'string'
},
'NonOverridableArguments': {
'string': 'string'
},
'Connections': {
'Connections': [
'string',
]
},
'MaxRetries': 123,
'AllocatedCapacity': 123,
'Timeout': 123,
'MaxCapacity': 123.0,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'NumberOfWorkers': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'GlueVersion': 'string'
},
],
'JobsNotFound': [
'string',
]
}
Response Structure
A list of job definitions.
Specifies a job definition.
The name you assign to this job definition.
A description of the job.
This field is reserved for future use.
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
The time and date that this job definition was created.
The last point in time when this job definition was modified.
An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.
The JobCommand that runs this job.
The name of the job command. For an Apache Spark ETL job, this must be glueetl . For a Python shell job, it must be pythonshell . For an Apache Spark streaming ETL job, this must be gluestreaming .
Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.
The Python version being used to run a Python shell job. Allowed values are 2 or 3.
The default arguments for this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
Non-overridable arguments for this job, specified as name-value pairs.
The connections used for this job.
A list of connections used by the job.
The maximum number of times to retry this job after a JobRun fails.
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Do not set Max Capacity if using WorkerType and NumberOfWorkers .
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity . Instead, you should specify a Worker type and the Number of workers .
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
The name of the SecurityConfiguration structure to be used with this job.
Specifies configuration properties of a job notification.
After a job run starts, the number of minutes to wait before sending a job run delay notification.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
A list of names of jobs not found.
Exceptions
Retrieves partitions in a batch request.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_partition(
CatalogId='string',
DatabaseName='string',
TableName='string',
PartitionsToGet=[
{
'Values': [
'string',
]
},
]
)
[REQUIRED]
The name of the catalog database where the partitions reside.
[REQUIRED]
The name of the partitions' table.
[REQUIRED]
A list of partition values identifying the partitions to retrieve.
Contains a list of values defining partitions.
The list of values.
dict
Response Syntax
{
'Partitions': [
{
'Values': [
'string',
],
'DatabaseName': 'string',
'TableName': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'Parameters': {
'string': 'string'
},
'LastAnalyzedTime': datetime(2015, 1, 1),
'CatalogId': 'string'
},
],
'UnprocessedKeys': [
{
'Values': [
'string',
]
},
]
}
Response Structure
(dict) --
Partitions (list) --
A list of the requested partitions.
(dict) --
Represents a slice of table data.
Values (list) --
The values of the partition.
DatabaseName (string) --
The name of the catalog database in which to create the partition.
TableName (string) --
The name of the database table in which to create the partition.
CreationTime (datetime) --
The time at which the partition was created.
LastAccessTime (datetime) --
The last time at which the partition was accessed.
StorageDescriptor (dict) --
Provides information about the physical location where the partition is stored.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
Parameters (dict) --
The user-supplied properties in key-value form.
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
Parameters (dict) --
These key-value pairs define partition parameters.
LastAnalyzedTime (datetime) --
The last time at which column statistics were computed for this partition.
CatalogId (string) --
The ID of the Data Catalog in which the partition resides.
UnprocessedKeys (list) --
A list of the partition values in the request for which partitions were not returned.
(dict) --
Contains a list of values defining partitions.
Values (list) --
The list of values.
Exceptions
Returns a list of resource metadata for a given list of trigger names. After calling the ListTriggers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_triggers(
TriggerNames=[
'string',
]
)
[REQUIRED]
A list of trigger names, which may be the names returned from the ListTriggers operation.
{
'Triggers': [
{
'Name': 'string',
'WorkflowName': 'string',
'Id': 'string',
'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND'|'EVENT',
'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
'Description': 'string',
'Schedule': 'string',
'Actions': [
{
'JobName': 'string',
'Arguments': {
'string': 'string'
},
'Timeout': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'CrawlerName': 'string'
},
],
'Predicate': {
'Logical': 'AND'|'ANY',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'CrawlerName': 'string',
'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'
},
]
},
'EventBatchingCondition': {
'BatchSize': 123,
'BatchWindow': 123
}
},
],
'TriggersNotFound': [
'string',
]
}
Response Structure
A list of trigger definitions.
Information about a specific trigger.
The name of the trigger.
The name of the workflow associated with the trigger.
Reserved for future use.
The type of trigger that this is.
The current state of the trigger.
A description of this trigger.
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
The actions initiated by this trigger.
Defines an action to be initiated by a trigger.
The name of a job to be run.
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
The name of the SecurityConfiguration structure to be used with this action.
Specifies configuration properties of a job run notification.
After a job run starts, the number of minutes to wait before sending a job run delay notification.
The name of the crawler to be used with this action.
The predicate of this trigger, which defines when it will fire.
An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
A list of the conditions that determine when the trigger will fire.
Defines a condition under which a trigger fires.
A logical operator.
The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .
The name of the crawler to which this condition applies.
The state of the crawler to which this condition applies.
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
A list of names of triggers not found.
Exceptions
Returns a list of resource metadata for a given list of workflow names. After calling the ListWorkflows operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_workflows(
Names=[
'string',
],
IncludeGraph=True|False
)
[REQUIRED]
A list of workflow names, which may be the names returned from the ListWorkflows operation.
dict
Response Syntax
{
'Workflows': [
{
'Name': 'string',
'Description': 'string',
'DefaultRunProperties': {
'string': 'string'
},
'CreatedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'LastRun': {
'Name': 'string',
'WorkflowRunId': 'string',
'PreviousRunId': 'string',
'WorkflowRunProperties': {
'string': 'string'
},
'StartedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'Status': 'RUNNING'|'COMPLETED'|'STOPPING'|'STOPPED'|'ERROR',
'ErrorMessage': 'string',
'Statistics': {
'TotalActions': 123,
'TimeoutActions': 123,
'FailedActions': 123,
'StoppedActions': 123,
'SucceededActions': 123,
'RunningActions': 123
},
'Graph': {
'Nodes': [
{
'Type': 'CRAWLER'|'JOB'|'TRIGGER',
'Name': 'string',
'UniqueId': 'string',
'TriggerDetails': {
'Trigger': {
'Name': 'string',
'WorkflowName': 'string',
'Id': 'string',
'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND'|'EVENT',
'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
'Description': 'string',
'Schedule': 'string',
'Actions': [
{
'JobName': 'string',
'Arguments': {
'string': 'string'
},
'Timeout': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'CrawlerName': 'string'
},
],
'Predicate': {
'Logical': 'AND'|'ANY',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'CrawlerName': 'string',
'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'
},
]
},
'EventBatchingCondition': {
'BatchSize': 123,
'BatchWindow': 123
}
}
},
'JobDetails': {
'JobRuns': [
{
'Id': 'string',
'Attempt': 123,
'PreviousRunId': 'string',
'TriggerName': 'string',
'JobName': 'string',
'StartedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'Arguments': {
'string': 'string'
},
'ErrorMessage': 'string',
'PredecessorRuns': [
{
'JobName': 'string',
'RunId': 'string'
},
],
'AllocatedCapacity': 123,
'ExecutionTime': 123,
'Timeout': 123,
'MaxCapacity': 123.0,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'NumberOfWorkers': 123,
'SecurityConfiguration': 'string',
'LogGroupName': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'GlueVersion': 'string'
},
]
},
'CrawlerDetails': {
'Crawls': [
{
'State': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED',
'StartedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'ErrorMessage': 'string',
'LogGroup': 'string',
'LogStream': 'string'
},
]
}
},
],
'Edges': [
{
'SourceId': 'string',
'DestinationId': 'string'
},
]
},
'StartingEventBatchCondition': {
'BatchSize': 123,
'BatchWindow': 123
}
},
'Graph': {
'Nodes': [
{
'Type': 'CRAWLER'|'JOB'|'TRIGGER',
'Name': 'string',
'UniqueId': 'string',
'TriggerDetails': {
'Trigger': {
'Name': 'string',
'WorkflowName': 'string',
'Id': 'string',
'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND'|'EVENT',
'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
'Description': 'string',
'Schedule': 'string',
'Actions': [
{
'JobName': 'string',
'Arguments': {
'string': 'string'
},
'Timeout': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'CrawlerName': 'string'
},
],
'Predicate': {
'Logical': 'AND'|'ANY',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'CrawlerName': 'string',
'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'
},
]
},
'EventBatchingCondition': {
'BatchSize': 123,
'BatchWindow': 123
}
}
},
'JobDetails': {
'JobRuns': [
{
'Id': 'string',
'Attempt': 123,
'PreviousRunId': 'string',
'TriggerName': 'string',
'JobName': 'string',
'StartedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'Arguments': {
'string': 'string'
},
'ErrorMessage': 'string',
'PredecessorRuns': [
{
'JobName': 'string',
'RunId': 'string'
},
],
'AllocatedCapacity': 123,
'ExecutionTime': 123,
'Timeout': 123,
'MaxCapacity': 123.0,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'NumberOfWorkers': 123,
'SecurityConfiguration': 'string',
'LogGroupName': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'GlueVersion': 'string'
},
]
},
'CrawlerDetails': {
'Crawls': [
{
'State': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED',
'StartedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'ErrorMessage': 'string',
'LogGroup': 'string',
'LogStream': 'string'
},
]
}
},
],
'Edges': [
{
'SourceId': 'string',
'DestinationId': 'string'
},
]
},
'MaxConcurrentRuns': 123,
'BlueprintDetails': {
'BlueprintName': 'string',
'RunId': 'string'
}
},
],
'MissingWorkflows': [
'string',
]
}
Response Structure
(dict) --
Workflows (list) --
A list of workflow resource metadata.
(dict) --
A workflow is a collection of multiple dependent Glue jobs and crawlers that are run to complete a complex ETL task. A workflow manages the execution and monitoring of all its jobs and crawlers.
Name (string) --
The name of the workflow.
Description (string) --
A description of the workflow.
DefaultRunProperties (dict) --
A collection of properties to be used as part of each execution of the workflow. The run properties are made available to each job in the workflow. A job can modify the properties for the next jobs in the flow.
CreatedOn (datetime) --
The date and time when the workflow was created.
LastModifiedOn (datetime) --
The date and time when the workflow was last modified.
LastRun (dict) --
The information about the last execution of the workflow.
Name (string) --
Name of the workflow that was run.
WorkflowRunId (string) --
The ID of this workflow run.
PreviousRunId (string) --
The ID of the previous workflow run.
WorkflowRunProperties (dict) --
The workflow run properties which were set during the run.
StartedOn (datetime) --
The date and time when the workflow run was started.
CompletedOn (datetime) --
The date and time when the workflow run completed.
Status (string) --
The status of the workflow run.
ErrorMessage (string) --
This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo ."
Statistics (dict) --
The statistics of the run.
TotalActions (integer) --
Total number of Actions in the workflow run.
TimeoutActions (integer) --
Total number of Actions that timed out.
FailedActions (integer) --
Total number of Actions that have failed.
StoppedActions (integer) --
Total number of Actions that have stopped.
SucceededActions (integer) --
Total number of Actions that have succeeded.
RunningActions (integer) --
Total number Actions in running state.
Graph (dict) --
The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
Nodes (list) --
A list of the the Glue components belong to the workflow represented as nodes.
(dict) --
A node represents an Glue component (trigger, crawler, or job) on a workflow graph.
Type (string) --
The type of Glue component represented by the node.
Name (string) --
The name of the Glue component represented by the node.
UniqueId (string) --
The unique Id assigned to the node within the workflow.
TriggerDetails (dict) --
Details of the Trigger when the node represents a Trigger.
Trigger (dict) --
The information of the trigger represented by the trigger node.
Name (string) --
The name of the trigger.
WorkflowName (string) --
The name of the workflow associated with the trigger.
Id (string) --
Reserved for future use.
Type (string) --
The type of trigger that this is.
State (string) --
The current state of the trigger.
Description (string) --
A description of this trigger.
Schedule (string) --
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
Actions (list) --
The actions initiated by this trigger.
(dict) --
Defines an action to be initiated by a trigger.
JobName (string) --
The name of a job to be run.
Arguments (dict) --
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this action.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
CrawlerName (string) --
The name of the crawler to be used with this action.
Predicate (dict) --
The predicate of this trigger, which defines when it will fire.
Logical (string) --
An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
Conditions (list) --
A list of the conditions that determine when the trigger will fire.
(dict) --
Defines a condition under which a trigger fires.
LogicalOperator (string) --
A logical operator.
JobName (string) --
The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
State (string) --
The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .
CrawlerName (string) --
The name of the crawler to which this condition applies.
CrawlState (string) --
The state of the crawler to which this condition applies.
EventBatchingCondition (dict) --
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize (integer) --
Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow (integer) --
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
JobDetails (dict) --
Details of the Job when the node represents a Job.
JobRuns (list) --
The information for the job runs represented by the job node.
(dict) --
Contains information about a job run.
Id (string) --
The ID of this job run.
Attempt (integer) --
The number of the attempt to run this job.
PreviousRunId (string) --
The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.
TriggerName (string) --
The name of the trigger that started this job run.
JobName (string) --
The name of the job definition being used in this run.
StartedOn (datetime) --
The date and time at which this job run was started.
LastModifiedOn (datetime) --
The last time that this job run was modified.
CompletedOn (datetime) --
The date and time that this job run completed.
JobRunState (string) --
The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses .
Arguments (dict) --
The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
ErrorMessage (string) --
An error message associated with this job run.
PredecessorRuns (list) --
A list of predecessors to this job run.
(dict) --
A job run that was used in the predicate of a conditional trigger that triggered this job run.
JobName (string) --
The name of the job definition used by the predecessor job run.
RunId (string) --
The job-run ID of the predecessor job run.
AllocatedCapacity (integer) --
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
ExecutionTime (integer) --
The amount of time (in seconds) that the job run consumed resources.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
MaxCapacity (float) --
The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Do not set Max Capacity if using WorkerType and NumberOfWorkers .
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:
WorkerType (string) --
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
NumberOfWorkers (integer) --
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this job run.
LogGroupName (string) --
The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
GlueVersion (string) --
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
CrawlerDetails (dict) --
Details of the crawler when the node represents a crawler.
Crawls (list) --
A list of crawls represented by the crawl node.
(dict) --
The details of a crawl in the workflow.
State (string) --
The state of the crawler.
StartedOn (datetime) --
The date and time on which the crawl started.
CompletedOn (datetime) --
The date and time on which the crawl completed.
ErrorMessage (string) --
The error message associated with the crawl.
LogGroup (string) --
The log group associated with the crawl.
LogStream (string) --
The log stream associated with the crawl.
Edges (list) --
A list of all the directed connections between the nodes belonging to the workflow.
(dict) --
An edge represents a directed connection between two components on a workflow graph.
SourceId (string) --
The unique of the node within the workflow where the edge starts.
DestinationId (string) --
The unique of the node within the workflow where the edge ends.
StartingEventBatchCondition (dict) --
The batch condition that started the workflow run.
BatchSize (integer) --
Number of events in the batch.
BatchWindow (integer) --
Duration of the batch window in seconds.
Graph (dict) --
The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
Nodes (list) --
A list of the the Glue components belong to the workflow represented as nodes.
(dict) --
A node represents an Glue component (trigger, crawler, or job) on a workflow graph.
Type (string) --
The type of Glue component represented by the node.
Name (string) --
The name of the Glue component represented by the node.
UniqueId (string) --
The unique Id assigned to the node within the workflow.
TriggerDetails (dict) --
Details of the Trigger when the node represents a Trigger.
Trigger (dict) --
The information of the trigger represented by the trigger node.
Name (string) --
The name of the trigger.
WorkflowName (string) --
The name of the workflow associated with the trigger.
Id (string) --
Reserved for future use.
Type (string) --
The type of trigger that this is.
State (string) --
The current state of the trigger.
Description (string) --
A description of this trigger.
Schedule (string) --
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
Actions (list) --
The actions initiated by this trigger.
(dict) --
Defines an action to be initiated by a trigger.
JobName (string) --
The name of a job to be run.
Arguments (dict) --
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this action.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
CrawlerName (string) --
The name of the crawler to be used with this action.
Predicate (dict) --
The predicate of this trigger, which defines when it will fire.
Logical (string) --
An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
Conditions (list) --
A list of the conditions that determine when the trigger will fire.
(dict) --
Defines a condition under which a trigger fires.
LogicalOperator (string) --
A logical operator.
JobName (string) --
The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
State (string) --
The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .
CrawlerName (string) --
The name of the crawler to which this condition applies.
CrawlState (string) --
The state of the crawler to which this condition applies.
EventBatchingCondition (dict) --
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize (integer) --
Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow (integer) --
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
JobDetails (dict) --
Details of the Job when the node represents a Job.
JobRuns (list) --
The information for the job runs represented by the job node.
(dict) --
Contains information about a job run.
Id (string) --
The ID of this job run.
Attempt (integer) --
The number of the attempt to run this job.
PreviousRunId (string) --
The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.
TriggerName (string) --
The name of the trigger that started this job run.
JobName (string) --
The name of the job definition being used in this run.
StartedOn (datetime) --
The date and time at which this job run was started.
LastModifiedOn (datetime) --
The last time that this job run was modified.
CompletedOn (datetime) --
The date and time that this job run completed.
JobRunState (string) --
The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses .
Arguments (dict) --
The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
ErrorMessage (string) --
An error message associated with this job run.
PredecessorRuns (list) --
A list of predecessors to this job run.
(dict) --
A job run that was used in the predicate of a conditional trigger that triggered this job run.
JobName (string) --
The name of the job definition used by the predecessor job run.
RunId (string) --
The job-run ID of the predecessor job run.
AllocatedCapacity (integer) --
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
ExecutionTime (integer) --
The amount of time (in seconds) that the job run consumed resources.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
MaxCapacity (float) --
The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Do not set Max Capacity if using WorkerType and NumberOfWorkers .
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:
WorkerType (string) --
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
NumberOfWorkers (integer) --
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this job run.
LogGroupName (string) --
The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
GlueVersion (string) --
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
CrawlerDetails (dict) --
Details of the crawler when the node represents a crawler.
Crawls (list) --
A list of crawls represented by the crawl node.
(dict) --
The details of a crawl in the workflow.
State (string) --
The state of the crawler.
StartedOn (datetime) --
The date and time on which the crawl started.
CompletedOn (datetime) --
The date and time on which the crawl completed.
ErrorMessage (string) --
The error message associated with the crawl.
LogGroup (string) --
The log group associated with the crawl.
LogStream (string) --
The log stream associated with the crawl.
Edges (list) --
A list of all the directed connections between the nodes belonging to the workflow.
(dict) --
An edge represents a directed connection between two components on a workflow graph.
SourceId (string) --
The unique of the node within the workflow where the edge starts.
DestinationId (string) --
The unique of the node within the workflow where the edge ends.
MaxConcurrentRuns (integer) --
You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
BlueprintDetails (dict) --
This structure indicates the details of the blueprint that this particular workflow is created from.
BlueprintName (string) --
The name of the blueprint.
RunId (string) --
The run ID for this blueprint.
MissingWorkflows (list) --
A list of names of workflows not found.
Exceptions
Stops one or more job runs for a specified job definition.
See also: AWS API Documentation
Request Syntax
response = client.batch_stop_job_run(
JobName='string',
JobRunIds=[
'string',
]
)
[REQUIRED]
The name of the job definition for which to stop job runs.
[REQUIRED]
A list of the JobRunIds that should be stopped for that job definition.
dict
Response Syntax
{
'SuccessfulSubmissions': [
{
'JobName': 'string',
'JobRunId': 'string'
},
],
'Errors': [
{
'JobName': 'string',
'JobRunId': 'string',
'ErrorDetail': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
SuccessfulSubmissions (list) --
A list of the JobRuns that were successfully submitted for stopping.
(dict) --
Records a successful request to stop a specified JobRun .
JobName (string) --
The name of the job definition used in the job run that was stopped.
JobRunId (string) --
The JobRunId of the job run that was stopped.
Errors (list) --
A list of the errors that were encountered in trying to stop JobRuns , including the JobRunId for which each error was encountered and details about the error.
(dict) --
Records an error that occurred when attempting to stop a specified job run.
JobName (string) --
The name of the job definition that is used in the job run in question.
JobRunId (string) --
The JobRunId of the job run in question.
ErrorDetail (dict) --
Specifies details about the error that was encountered.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Exceptions
Updates one or more partitions in a batch operation.
See also: AWS API Documentation
Request Syntax
response = client.batch_update_partition(
CatalogId='string',
DatabaseName='string',
TableName='string',
Entries=[
{
'PartitionValueList': [
'string',
],
'PartitionInput': {
'Values': [
'string',
],
'LastAccessTime': datetime(2015, 1, 1),
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'Parameters': {
'string': 'string'
},
'LastAnalyzedTime': datetime(2015, 1, 1)
}
},
]
)
[REQUIRED]
The name of the metadata database in which the partition is to be updated.
[REQUIRED]
The name of the metadata table in which the partition is to be updated.
[REQUIRED]
A list of up to 100 BatchUpdatePartitionRequestEntry objects to update.
A structure that contains the values and structure used to update a partition.
A list of values defining the partitions.
The structure used to update a partition.
The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.
The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.
The last time at which the partition was accessed.
Provides information about the physical location where the partition is stored.
A list of the Columns in the table.
A column in a Table .
The name of the Column .
The data type of the Column .
A free-form text comment.
These key-value pairs define properties associated with the column.
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
True if the data in the table is compressed, or False if not.
Must be specified if the table contains any dimension columns.
The serialization/deserialization (SerDe) information.
Name of the SerDe.
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
These key-value pairs define initialization parameters for the SerDe.
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
A list specifying the sort order of each bucket in the table.
Specifies the sort order of a sorted column.
The name of the column.
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
The user-supplied properties in key-value form.
The information about values that appear frequently in a column (skewed values).
A list of names of columns that contain skewed values.
A list of values that appear so frequently as to be considered skewed.
A mapping of skewed values to the columns that contain them.
True if the table data is stored in subdirectories, or False if not.
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
The version number of the schema.
These key-value pairs define partition parameters.
The last time at which column statistics were computed for this partition.
dict
Response Syntax
{
'Errors': [
{
'PartitionValueList': [
'string',
],
'ErrorDetail': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
Errors (list) --
The errors encountered when trying to update the requested partitions. A list of BatchUpdatePartitionFailureEntry objects.
(dict) --
Contains information about a batch update partition error.
PartitionValueList (list) --
A list of values defining the partitions.
ErrorDetail (dict) --
The details about the batch update partition error.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Exceptions
Check if an operation can be paginated.
Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can cancel a machine learning task run at any time by calling CancelMLTaskRun with a task run's parent transform's TransformID and the task run's TaskRunId .
See also: AWS API Documentation
Request Syntax
response = client.cancel_ml_task_run(
TransformId='string',
TaskRunId='string'
)
[REQUIRED]
The unique identifier of the machine learning transform.
[REQUIRED]
A unique identifier for the task run.
dict
Response Syntax
{
'TransformId': 'string',
'TaskRunId': 'string',
'Status': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT'
}
Response Structure
(dict) --
TransformId (string) --
The unique identifier of the machine learning transform.
TaskRunId (string) --
The unique identifier for the task run.
Status (string) --
The status for this run.
Exceptions
Validates the supplied schema. This call has no side effects, it simply validates using the supplied schema using DataFormat as the format. Since it does not take a schema set name, no compatibility checks are performed.
See also: AWS API Documentation
Request Syntax
response = client.check_schema_version_validity(
DataFormat='AVRO'|'JSON',
SchemaDefinition='string'
)
[REQUIRED]
The data format of the schema definition. Currently AVRO and JSON are supported.
[REQUIRED]
The definition of the schema that has to be validated.
dict
Response Syntax
{
'Valid': True|False,
'Error': 'string'
}
Response Structure
(dict) --
Valid (boolean) --
Return true, if the schema is valid and false otherwise.
Error (string) --
A validation failure error message.
Exceptions
Registers a blueprint with Glue.
See also: AWS API Documentation
Request Syntax
response = client.create_blueprint(
Name='string',
Description='string',
BlueprintLocation='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The name of the blueprint.
[REQUIRED]
Specifies a path in Amazon S3 where the blueprint is published.
The tags to be applied to this blueprint.
dict
Response Syntax
{
'Name': 'string'
}
Response Structure
(dict) --
Name (string) --
Returns the name of the blueprint that was registered.
Exceptions
Creates a classifier in the user's account. This can be a GrokClassifier , an XMLClassifier , a JsonClassifier , or a CsvClassifier , depending on which field of the request is present.
See also: AWS API Documentation
Request Syntax
response = client.create_classifier(
GrokClassifier={
'Classification': 'string',
'Name': 'string',
'GrokPattern': 'string',
'CustomPatterns': 'string'
},
XMLClassifier={
'Classification': 'string',
'Name': 'string',
'RowTag': 'string'
},
JsonClassifier={
'Name': 'string',
'JsonPath': 'string'
},
CsvClassifier={
'Name': 'string',
'Delimiter': 'string',
'QuoteSymbol': 'string',
'ContainsHeader': 'UNKNOWN'|'PRESENT'|'ABSENT',
'Header': [
'string',
],
'DisableValueTrimming': True|False,
'AllowSingleColumn': True|False
}
)
A GrokClassifier object specifying the classifier to create.
An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.
The name of the new classifier.
The grok pattern used by this classifier.
Optional custom grok patterns used by this classifier.
An XMLClassifier object specifying the classifier to create.
An identifier of the data format that the classifier matches.
The name of the classifier.
The XML tag designating the element that contains each record in an XML document being parsed. This can't identify a self-closing element (closed by /> ). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).
A JsonClassifier object specifying the classifier to create.
The name of the classifier.
A JsonPath string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers .
A CsvClassifier object specifying the classifier to create.
The name of the classifier.
A custom symbol to denote what separates each column entry in the row.
A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter.
Indicates whether the CSV file contains a header.
A list of strings representing column names.
Specifies not to trim values before identifying the type of column values. The default value is true.
Enables the processing of files that contain only one column.
dict
Response Syntax
{}
Response Structure
Exceptions
Creates a connection definition in the Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.create_connection(
CatalogId='string',
ConnectionInput={
'Name': 'string',
'Description': 'string',
'ConnectionType': 'JDBC'|'SFTP'|'MONGODB'|'KAFKA'|'NETWORK'|'MARKETPLACE'|'CUSTOM',
'MatchCriteria': [
'string',
],
'ConnectionProperties': {
'string': 'string'
},
'PhysicalConnectionRequirements': {
'SubnetId': 'string',
'SecurityGroupIdList': [
'string',
],
'AvailabilityZone': 'string'
}
},
Tags={
'string': 'string'
}
)
[REQUIRED]
A ConnectionInput object defining the connection to create.
The name of the connection.
The description of the connection.
The type of the connection. Currently, these types are supported:
SFTP is not supported.
A list of criteria that can be used in selecting this connection.
These key-value pairs define parameters for the connection.
A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to successfully make this connection.
The subnet ID used by the connection.
The security group ID list used by the connection.
The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.
The tags you assign to the connection.
dict
Response Syntax
{}
Response Structure
Exceptions
Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the s3Targets field, the jdbcTargets field, or the DynamoDBTargets field.
See also: AWS API Documentation
Request Syntax
response = client.create_crawler(
Name='string',
Role='string',
DatabaseName='string',
Description='string',
Targets={
'S3Targets': [
{
'Path': 'string',
'Exclusions': [
'string',
],
'ConnectionName': 'string',
'SampleSize': 123,
'EventQueueArn': 'string',
'DlqEventQueueArn': 'string'
},
],
'JdbcTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'Exclusions': [
'string',
]
},
],
'MongoDBTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'ScanAll': True|False
},
],
'DynamoDBTargets': [
{
'Path': 'string',
'scanAll': True|False,
'scanRate': 123.0
},
],
'CatalogTargets': [
{
'DatabaseName': 'string',
'Tables': [
'string',
]
},
]
},
Schedule='string',
Classifiers=[
'string',
],
TablePrefix='string',
SchemaChangePolicy={
'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
},
RecrawlPolicy={
'RecrawlBehavior': 'CRAWL_EVERYTHING'|'CRAWL_NEW_FOLDERS_ONLY'|'CRAWL_EVENT_MODE'
},
LineageConfiguration={
'CrawlerLineageSettings': 'ENABLE'|'DISABLE'
},
Configuration='string',
CrawlerSecurityConfiguration='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
Name of the new crawler.
[REQUIRED]
The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
[REQUIRED]
A list of collection of targets to crawl.
Specifies Amazon Simple Storage Service (Amazon S3) targets.
Specifies a data store in Amazon Simple Storage Service (Amazon S3).
The path to the Amazon S3 target.
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .
The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs .
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue .
Specifies JDBC targets.
Specifies a JDBC data store to crawl.
The name of the connection to use to connect to the JDBC target.
The path of the JDBC target.
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .
Specifies Amazon DocumentDB or MongoDB targets.
Specifies an Amazon DocumentDB or MongoDB data store to crawl.
The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
The path of the Amazon DocumentDB or MongoDB target (database/collection).
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .
Specifies Amazon DynamoDB targets.
Specifies an Amazon DynamoDB table to crawl.
The name of the DynamoDB table to crawl.
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .
The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
Specifies Glue Data Catalog targets.
Specifies an Glue Data Catalog target.
The name of the database to be synchronized.
A list of the tables to be synchronized.
A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
The policy for the crawler's update and deletion behavior.
The update behavior when the crawler finds a changed schema.
The deletion behavior when the crawler finds a deleted object.
A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.
A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
Specifies data lineage configuration settings for the crawler.
Specifies whether data lineage is enabled for the crawler. Valid values are:
The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
dict
Response Syntax
{}
Response Structure
Exceptions
Creates a new database in a Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.create_database(
CatalogId='string',
DatabaseInput={
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'Parameters': {
'string': 'string'
},
'CreateTableDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'TargetDatabase': {
'CatalogId': 'string',
'DatabaseName': 'string'
}
}
)
[REQUIRED]
The metadata for the database.
The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
A description of the database.
The location of the database (for example, an HDFS path).
These key-value pairs define parameters and properties of the database.
These key-value pairs define parameters and properties of the database.
Creates a set of default permissions on the table for principals.
Permissions granted to a principal.
The principal who is granted permissions.
An identifier for the Lake Formation principal.
The permissions that are granted to the principal.
A DatabaseIdentifier structure that describes a target database for resource linking.
The ID of the Data Catalog in which the database resides.
The name of the catalog database.
dict
Response Syntax
{}
Response Structure
Exceptions
Creates a new development endpoint.
See also: AWS API Documentation
Request Syntax
response = client.create_dev_endpoint(
EndpointName='string',
RoleArn='string',
SecurityGroupIds=[
'string',
],
SubnetId='string',
PublicKey='string',
PublicKeys=[
'string',
],
NumberOfNodes=123,
WorkerType='Standard'|'G.1X'|'G.2X',
GlueVersion='string',
NumberOfWorkers=123,
ExtraPythonLibsS3Path='string',
ExtraJarsS3Path='string',
SecurityConfiguration='string',
Tags={
'string': 'string'
},
Arguments={
'string': 'string'
}
)
[REQUIRED]
The name to be assigned to the new DevEndpoint .
[REQUIRED]
The IAM role for the DevEndpoint .
Security group IDs for the security groups to be used by the new DevEndpoint .
A list of public keys to be used by the development endpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.
Note
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
The number of workers of a defined workerType that are allocated to the development endpoint.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint . Multiple values must be complete paths separated by a comma.
Note
You can only use pure Python libraries with a DevEndpoint . Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.
The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
A map of arguments used to configure the DevEndpoint .
dict
Response Syntax
{
'EndpointName': 'string',
'Status': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string',
'RoleArn': 'string',
'YarnEndpointAddress': 'string',
'ZeppelinRemoteSparkInterpreterPort': 123,
'NumberOfNodes': 123,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'GlueVersion': 'string',
'NumberOfWorkers': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'ExtraPythonLibsS3Path': 'string',
'ExtraJarsS3Path': 'string',
'FailureReason': 'string',
'SecurityConfiguration': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'Arguments': {
'string': 'string'
}
}
Response Structure
(dict) --
EndpointName (string) --
The name assigned to the new DevEndpoint .
Status (string) --
The current status of the new DevEndpoint .
SecurityGroupIds (list) --
The security groups assigned to the new DevEndpoint .
SubnetId (string) --
The subnet ID assigned to the new DevEndpoint .
RoleArn (string) --
The Amazon Resource Name (ARN) of the role assigned to the new DevEndpoint .
YarnEndpointAddress (string) --
The address of the YARN endpoint used by this DevEndpoint .
ZeppelinRemoteSparkInterpreterPort (integer) --
The Apache Zeppelin port for the remote Apache Spark interpreter.
NumberOfNodes (integer) --
The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint.
WorkerType (string) --
The type of predefined worker that is allocated to the development endpoint. May be a value of Standard, G.1X, or G.2X.
GlueVersion (string) --
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
NumberOfWorkers (integer) --
The number of workers of a defined workerType that are allocated to the development endpoint.
AvailabilityZone (string) --
The AWS Availability Zone where this DevEndpoint is located.
VpcId (string) --
The ID of the virtual private cloud (VPC) used by this DevEndpoint .
ExtraPythonLibsS3Path (string) --
The paths to one or more Python libraries in an S3 bucket that will be loaded in your DevEndpoint .
ExtraJarsS3Path (string) --
Path to one or more Java .jar files in an S3 bucket that will be loaded in your DevEndpoint .
FailureReason (string) --
The reason for a current failure in this DevEndpoint .
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure being used with this DevEndpoint .
CreatedTimestamp (datetime) --
The point in time at which this DevEndpoint was created.
Arguments (dict) --
The map of arguments used to configure this DevEndpoint .
Valid arguments are:
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
Exceptions
Creates a new job definition.
See also: AWS API Documentation
Request Syntax
response = client.create_job(
Name='string',
Description='string',
LogUri='string',
Role='string',
ExecutionProperty={
'MaxConcurrentRuns': 123
},
Command={
'Name': 'string',
'ScriptLocation': 'string',
'PythonVersion': 'string'
},
DefaultArguments={
'string': 'string'
},
NonOverridableArguments={
'string': 'string'
},
Connections={
'Connections': [
'string',
]
},
MaxRetries=123,
AllocatedCapacity=123,
Timeout=123,
MaxCapacity=123.0,
SecurityConfiguration='string',
Tags={
'string': 'string'
},
NotificationProperty={
'NotifyDelayAfter': 123
},
GlueVersion='string',
NumberOfWorkers=123,
WorkerType='Standard'|'G.1X'|'G.2X'
)
[REQUIRED]
The name you assign to this job definition. It must be unique in your account.
[REQUIRED]
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.
[REQUIRED]
The JobCommand that runs this job.
The name of the job command. For an Apache Spark ETL job, this must be glueetl . For a Python shell job, it must be pythonshell . For an Apache Spark streaming ETL job, this must be gluestreaming .
Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.
The Python version being used to run a Python shell job. Allowed values are 2 or 3.
The default arguments for this job.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
Non-overridable arguments for this job, specified as name-value pairs.
The connections used for this job.
A list of connections used by the job.
This parameter is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this Job. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Do not set Max Capacity if using WorkerType and NumberOfWorkers .
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity . Instead, you should specify a Worker type and the Number of workers .
The tags to use with this job. You may use tags to limit access to the job. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
Specifies configuration properties of a job notification.
After a job run starts, the number of minutes to wait before sending a job run delay notification.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
dict
Response Syntax
{
'Name': 'string'
}
Response Structure
(dict) --
Name (string) --
The unique name that was provided for this job definition.
Exceptions
Creates an Glue machine learning transform. This operation creates the transform and all the necessary parameters to train it.
Call this operation as the first step in the process of using a machine learning transform (such as the FindMatches transform) for deduplicating data. You can provide an optional Description , in addition to the parameters that you want to use for your algorithm.
You must also specify certain parameters for the tasks that Glue runs on your behalf as part of learning from your data and creating a high-quality machine learning transform. These parameters include Role , and optionally, AllocatedCapacity , Timeout , and MaxRetries . For more information, see Jobs .
See also: AWS API Documentation
Request Syntax
response = client.create_ml_transform(
Name='string',
Description='string',
InputRecordTables=[
{
'DatabaseName': 'string',
'TableName': 'string',
'CatalogId': 'string',
'ConnectionName': 'string'
},
],
Parameters={
'TransformType': 'FIND_MATCHES',
'FindMatchesParameters': {
'PrimaryKeyColumnName': 'string',
'PrecisionRecallTradeoff': 123.0,
'AccuracyCostTradeoff': 123.0,
'EnforceProvidedLabels': True|False
}
},
Role='string',
GlueVersion='string',
MaxCapacity=123.0,
WorkerType='Standard'|'G.1X'|'G.2X',
NumberOfWorkers=123,
Timeout=123,
MaxRetries=123,
Tags={
'string': 'string'
},
TransformEncryption={
'MlUserDataEncryption': {
'MlUserDataEncryptionMode': 'DISABLED'|'SSE-KMS',
'KmsKeyId': 'string'
},
'TaskRunSecurityConfigurationName': 'string'
}
)
[REQUIRED]
The unique name that you give the transform when you create it.
[REQUIRED]
A list of Glue table definitions used by the transform.
The database and table in the Glue Data Catalog that is used for input or output data.
A database name in the Glue Data Catalog.
A table name in the Glue Data Catalog.
A unique identifier for the Glue Data Catalog.
The name of the connection to the Glue Data Catalog.
[REQUIRED]
The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.
The type of machine learning transform.
For information about the types of machine learning transforms, see Creating Machine Learning Transforms .
The parameters for the find matches algorithm.
The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.
The precision metric indicates how often your model is correct when it predicts a match.
The recall metric indicates that for an actual match, how often your model predicts the match.
The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate FindMatches transform, sometimes with unacceptable accuracy.
Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
Cost measures how many compute resources, and thus money, are consumed to run the transform.
The value to switch on or off to force the output to match the provided labels from users. If the value is True , the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False , the find matches transform does not ensure all the labels provided are respected, and the results rely on the trained model.
Note that setting this value to true may increase the conflation execution time.
[REQUIRED]
The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType .
When the WorkerType field is set to a value other than Standard , the MaxCapacity field is set automatically and becomes read-only.
When the WorkerType field is set to a value other than Standard , the MaxCapacity field is set automatically and becomes read-only.
The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType .
The number of workers of a defined workerType that are allocated when this task runs.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
An MLUserDataEncryption object containing the encryption mode and customer-provided KMS key ID.
The encryption mode applied to user data. Valid values are:
The ID for the customer-provided KMS key.
The name of the security configuration.
dict
Response Syntax
{
'TransformId': 'string'
}
Response Structure
(dict) --
TransformId (string) --
A unique identifier that is generated for the transform.
Exceptions
Creates a new partition.
See also: AWS API Documentation
Request Syntax
response = client.create_partition(
CatalogId='string',
DatabaseName='string',
TableName='string',
PartitionInput={
'Values': [
'string',
],
'LastAccessTime': datetime(2015, 1, 1),
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'Parameters': {
'string': 'string'
},
'LastAnalyzedTime': datetime(2015, 1, 1)
}
)
[REQUIRED]
The name of the metadata database in which the partition is to be created.
[REQUIRED]
The name of the metadata table in which the partition is to be created.
[REQUIRED]
A PartitionInput structure defining the partition to be created.
The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.
The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.
The last time at which the partition was accessed.
Provides information about the physical location where the partition is stored.
A list of the Columns in the table.
A column in a Table .
The name of the Column .
The data type of the Column .
A free-form text comment.
These key-value pairs define properties associated with the column.
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
True if the data in the table is compressed, or False if not.
Must be specified if the table contains any dimension columns.
The serialization/deserialization (SerDe) information.
Name of the SerDe.
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
These key-value pairs define initialization parameters for the SerDe.
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
A list specifying the sort order of each bucket in the table.
Specifies the sort order of a sorted column.
The name of the column.
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
The user-supplied properties in key-value form.
The information about values that appear frequently in a column (skewed values).
A list of names of columns that contain skewed values.
A list of values that appear so frequently as to be considered skewed.
A mapping of skewed values to the columns that contain them.
True if the table data is stored in subdirectories, or False if not.
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
The version number of the schema.
These key-value pairs define partition parameters.
The last time at which column statistics were computed for this partition.
dict
Response Syntax
{}
Response Structure
Exceptions
Creates a specified partition index in an existing table.
See also: AWS API Documentation
Request Syntax
response = client.create_partition_index(
CatalogId='string',
DatabaseName='string',
TableName='string',
PartitionIndex={
'Keys': [
'string',
],
'IndexName': 'string'
}
)
[REQUIRED]
Specifies the name of a database in which you want to create a partition index.
[REQUIRED]
Specifies the name of a table in which you want to create a partition index.
[REQUIRED]
Specifies a PartitionIndex structure to create a partition index in an existing table.
The keys for the partition index.
The name of the partition index.
dict
Response Syntax
{}
Response Structure
Exceptions
Creates a new registry which may be used to hold a collection of schemas.
See also: AWS API Documentation
Request Syntax
response = client.create_registry(
RegistryName='string',
Description='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API.
dict
Response Syntax
{
'RegistryArn': 'string',
'RegistryName': 'string',
'Description': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
RegistryArn (string) --
The Amazon Resource Name (ARN) of the newly created registry.
RegistryName (string) --
The name of the registry.
Description (string) --
A description of the registry.
Tags (dict) --
The tags for the registry.
Exceptions
Creates a new schema set and registers the schema definition. Returns an error if the schema set already exists without actually registering the version.
When the schema set is created, a version checkpoint will be set to the first version. Compatibility mode "DISABLED" restricts any additional schema versions from being added after the first schema version. For all other compatibility modes, validation of compatibility settings will be applied only from the second version onwards when the RegisterSchemaVersion API is used.
When this API is called without a RegistryId , this will create an entry for a "default-registry" in the registry database tables, if it is not already present.
See also: AWS API Documentation
Request Syntax
response = client.create_schema(
RegistryId={
'RegistryName': 'string',
'RegistryArn': 'string'
},
SchemaName='string',
DataFormat='AVRO'|'JSON',
Compatibility='NONE'|'DISABLED'|'BACKWARD'|'BACKWARD_ALL'|'FORWARD'|'FORWARD_ALL'|'FULL'|'FULL_ALL',
Description='string',
Tags={
'string': 'string'
},
SchemaDefinition='string'
)
This is a wrapper shape to contain the registry identity fields. If this is not provided, the default registry will be used. The ARN format for the same will be: arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id .
Name of the registry. Used only for lookup. One of RegistryArn or RegistryName has to be provided.
Arn of the registry to be updated. One of RegistryArn or RegistryName has to be provided.
[REQUIRED]
Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
[REQUIRED]
The data format of the schema definition. Currently AVRO and JSON are supported.
The compatibility mode of the schema. The possible values are:
Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API. If specified, follows the Amazon Web Services tags-on-create pattern.
dict
Response Syntax
{
'RegistryName': 'string',
'RegistryArn': 'string',
'SchemaName': 'string',
'SchemaArn': 'string',
'Description': 'string',
'DataFormat': 'AVRO'|'JSON',
'Compatibility': 'NONE'|'DISABLED'|'BACKWARD'|'BACKWARD_ALL'|'FORWARD'|'FORWARD_ALL'|'FULL'|'FULL_ALL',
'SchemaCheckpoint': 123,
'LatestSchemaVersion': 123,
'NextSchemaVersion': 123,
'SchemaStatus': 'AVAILABLE'|'PENDING'|'DELETING',
'Tags': {
'string': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionStatus': 'AVAILABLE'|'PENDING'|'FAILURE'|'DELETING'
}
Response Structure
(dict) --
RegistryName (string) --
The name of the registry.
RegistryArn (string) --
The Amazon Resource Name (ARN) of the registry.
SchemaName (string) --
The name of the schema.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema.
Description (string) --
A description of the schema if specified when created.
DataFormat (string) --
The data format of the schema definition. Currently AVRO and JSON are supported.
Compatibility (string) --
The schema compatibility mode.
SchemaCheckpoint (integer) --
The version number of the checkpoint (the last time the compatibility mode was changed).
LatestSchemaVersion (integer) --
The latest version of the schema associated with the returned schema definition.
NextSchemaVersion (integer) --
The next version of the schema associated with the returned schema definition.
SchemaStatus (string) --
The status of the schema.
Tags (dict) --
The tags for the schema.
SchemaVersionId (string) --
The unique identifier of the first schema version.
SchemaVersionStatus (string) --
The status of the first schema version created.
Exceptions
Transforms a directed acyclic graph (DAG) into code.
See also: AWS API Documentation
Request Syntax
response = client.create_script(
DagNodes=[
{
'Id': 'string',
'NodeType': 'string',
'Args': [
{
'Name': 'string',
'Value': 'string',
'Param': True|False
},
],
'LineNumber': 123
},
],
DagEdges=[
{
'Source': 'string',
'Target': 'string',
'TargetParameter': 'string'
},
],
Language='PYTHON'|'SCALA'
)
A list of the nodes in the DAG.
Represents a node in a directed acyclic graph (DAG)
A node identifier that is unique within the node's graph.
The type of node that this is.
Properties of the node, in the form of name-value pairs.
An argument or property of a node.
The name of the argument or property.
The value of the argument or property.
True if the value is used as a parameter.
The line number of the node.
A list of the edges in the DAG.
Represents a directional edge in a directed acyclic graph (DAG).
The ID of the node at which the edge starts.
The ID of the node at which the edge ends.
The target of the edge.
dict
Response Syntax
{
'PythonScript': 'string',
'ScalaCode': 'string'
}
Response Structure
(dict) --
PythonScript (string) --
The Python script generated from the DAG.
ScalaCode (string) --
The Scala code generated from the DAG.
Exceptions
Creates a new security configuration. A security configuration is a set of security properties that can be used by Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints .
See also: AWS API Documentation
Request Syntax
response = client.create_security_configuration(
Name='string',
EncryptionConfiguration={
'S3Encryption': [
{
'S3EncryptionMode': 'DISABLED'|'SSE-KMS'|'SSE-S3',
'KmsKeyArn': 'string'
},
],
'CloudWatchEncryption': {
'CloudWatchEncryptionMode': 'DISABLED'|'SSE-KMS',
'KmsKeyArn': 'string'
},
'JobBookmarksEncryption': {
'JobBookmarksEncryptionMode': 'DISABLED'|'CSE-KMS',
'KmsKeyArn': 'string'
}
}
)
[REQUIRED]
The name for the new security configuration.
[REQUIRED]
The encryption configuration for the new security configuration.
The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.
Specifies how Amazon Simple Storage Service (Amazon S3) data should be encrypted.
The encryption mode to use for Amazon S3 data.
The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
The encryption configuration for Amazon CloudWatch.
The encryption mode to use for CloudWatch data.
The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
The encryption configuration for job bookmarks.
The encryption mode to use for job bookmarks data.
The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
dict
Response Syntax
{
'Name': 'string',
'CreatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Name (string) --
The name assigned to the new security configuration.
CreatedTimestamp (datetime) --
The time at which the new security configuration was created.
Exceptions
Creates a new table definition in the Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.create_table(
CatalogId='string',
DatabaseName='string',
TableInput={
'Name': 'string',
'Description': 'string',
'Owner': 'string',
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string'
}
},
PartitionIndexes=[
{
'Keys': [
'string',
],
'IndexName': 'string'
},
]
)
[REQUIRED]
The catalog database in which to create the new table. For Hive compatibility, this name is entirely lowercase.
[REQUIRED]
The TableInput object that defines the metadata table to create in the catalog.
The table name. For Hive compatibility, this is folded to lowercase when it is stored.
A description of the table.
The table owner.
The last time that the table was accessed.
The last time that column statistics were computed for this table.
The retention time for this table.
A storage descriptor containing information about the physical storage of this table.
A list of the Columns in the table.
A column in a Table .
The name of the Column .
The data type of the Column .
A free-form text comment.
These key-value pairs define properties associated with the column.
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
True if the data in the table is compressed, or False if not.
Must be specified if the table contains any dimension columns.
The serialization/deserialization (SerDe) information.
Name of the SerDe.
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
These key-value pairs define initialization parameters for the SerDe.
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
A list specifying the sort order of each bucket in the table.
Specifies the sort order of a sorted column.
The name of the column.
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
The user-supplied properties in key-value form.
The information about values that appear frequently in a column (skewed values).
A list of names of columns that contain skewed values.
A list of values that appear so frequently as to be considered skewed.
A mapping of skewed values to the columns that contain them.
True if the table data is stored in subdirectories, or False if not.
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
The version number of the schema.
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": []
A column in a Table .
The name of the Column .
The data type of the Column .
A free-form text comment.
These key-value pairs define properties associated with the column.
If the table is a view, the original text of the view; otherwise null .
If the table is a view, the expanded text of the view; otherwise null .
The type of this table (EXTERNAL_TABLE , VIRTUAL_VIEW , etc.).
These key-value pairs define properties associated with the table.
A TableIdentifier structure that describes a target table for resource linking.
The ID of the Data Catalog in which the table resides.
The name of the catalog database that contains the target table.
The name of the target table.
A list of partition indexes, PartitionIndex structures, to create in the table.
A structure for a partition index.
The keys for the partition index.
The name of the partition index.
dict
Response Syntax
{}
Response Structure
Exceptions
Creates a new trigger.
See also: AWS API Documentation
Request Syntax
response = client.create_trigger(
Name='string',
WorkflowName='string',
Type='SCHEDULED'|'CONDITIONAL'|'ON_DEMAND'|'EVENT',
Schedule='string',
Predicate={
'Logical': 'AND'|'ANY',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'CrawlerName': 'string',
'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'
},
]
},
Actions=[
{
'JobName': 'string',
'Arguments': {
'string': 'string'
},
'Timeout': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'CrawlerName': 'string'
},
],
Description='string',
StartOnCreation=True|False,
Tags={
'string': 'string'
},
EventBatchingCondition={
'BatchSize': 123,
'BatchWindow': 123
}
)
[REQUIRED]
The name of the trigger.
[REQUIRED]
The type of the new trigger.
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
This field is required when the trigger type is SCHEDULED.
A predicate to specify when the new trigger should fire.
This field is required when the trigger type is CONDITIONAL .
An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
A list of the conditions that determine when the trigger will fire.
Defines a condition under which a trigger fires.
A logical operator.
The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .
The name of the crawler to which this condition applies.
The state of the crawler to which this condition applies.
[REQUIRED]
The actions initiated by this trigger when it fires.
Defines an action to be initiated by a trigger.
The name of a job to be run.
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
The name of the SecurityConfiguration structure to be used with this action.
Specifies configuration properties of a job run notification.
After a job run starts, the number of minutes to wait before sending a job run delay notification.
The name of the crawler to be used with this action.
The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
dict
Response Syntax
{
'Name': 'string'
}
Response Structure
(dict) --
Name (string) --
The name of the trigger.
Exceptions
Creates a new function definition in the Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.create_user_defined_function(
CatalogId='string',
DatabaseName='string',
FunctionInput={
'FunctionName': 'string',
'ClassName': 'string',
'OwnerName': 'string',
'OwnerType': 'USER'|'ROLE'|'GROUP',
'ResourceUris': [
{
'ResourceType': 'JAR'|'FILE'|'ARCHIVE',
'Uri': 'string'
},
]
}
)
[REQUIRED]
The name of the catalog database in which to create the function.
[REQUIRED]
A FunctionInput object that defines the function to create in the Data Catalog.
The name of the function.
The Java class that contains the function code.
The owner of the function.
The owner type.
The resource URIs for the function.
The URIs for function resources.
The type of the resource.
The URI for accessing the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Creates a new workflow.
See also: AWS API Documentation
Request Syntax
response = client.create_workflow(
Name='string',
Description='string',
DefaultRunProperties={
'string': 'string'
},
Tags={
'string': 'string'
},
MaxConcurrentRuns=123
)
[REQUIRED]
The name to be assigned to the workflow. It should be unique within your account.
A collection of properties to be used as part of each execution of the workflow.
The tags to be used with this workflow.
dict
Response Syntax
{
'Name': 'string'
}
Response Structure
(dict) --
Name (string) --
The name of the workflow which was provided as part of the request.
Exceptions
Deletes an existing blueprint.
See also: AWS API Documentation
Request Syntax
response = client.delete_blueprint(
Name='string'
)
[REQUIRED]
The name of the blueprint to delete.
{
'Name': 'string'
}
Response Structure
Returns the name of the blueprint that was deleted.
Exceptions
Removes a classifier from the Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.delete_classifier(
Name='string'
)
[REQUIRED]
Name of the classifier to remove.
{}
Response Structure
Exceptions
Delete the partition column statistics of a column.
The Identity and Access Management (IAM) permission required for this operation is DeletePartition .
See also: AWS API Documentation
Request Syntax
response = client.delete_column_statistics_for_partition(
CatalogId='string',
DatabaseName='string',
TableName='string',
PartitionValues=[
'string',
],
ColumnName='string'
)
[REQUIRED]
The name of the catalog database where the partitions reside.
[REQUIRED]
The name of the partitions' table.
[REQUIRED]
A list of partition values identifying the partition.
[REQUIRED]
Name of the column.
dict
Response Syntax
{}
Response Structure
Exceptions
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is DeleteTable .
See also: AWS API Documentation
Request Syntax
response = client.delete_column_statistics_for_table(
CatalogId='string',
DatabaseName='string',
TableName='string',
ColumnName='string'
)
[REQUIRED]
The name of the catalog database where the partitions reside.
[REQUIRED]
The name of the partitions' table.
[REQUIRED]
The name of the column.
dict
Response Syntax
{}
Response Structure
Exceptions
Deletes a connection from the Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.delete_connection(
CatalogId='string',
ConnectionName='string'
)
[REQUIRED]
The name of the connection to delete.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes a specified crawler from the Glue Data Catalog, unless the crawler state is RUNNING .
See also: AWS API Documentation
Request Syntax
response = client.delete_crawler(
Name='string'
)
[REQUIRED]
The name of the crawler to remove.
{}
Response Structure
Exceptions
Removes a specified database from a Data Catalog.
Note
After completing this operation, you no longer have access to the tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted database. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling DeleteDatabase , use DeleteTableVersion or BatchDeleteTableVersion , DeletePartition or BatchDeletePartition , DeleteUserDefinedFunction , and DeleteTable or BatchDeleteTable , to delete any resources that belong to the database.
See also: AWS API Documentation
Request Syntax
response = client.delete_database(
CatalogId='string',
Name='string'
)
[REQUIRED]
The name of the database to delete. For Hive compatibility, this must be all lowercase.
dict
Response Syntax
{}
Response Structure
Exceptions
Deletes a specified development endpoint.
See also: AWS API Documentation
Request Syntax
response = client.delete_dev_endpoint(
EndpointName='string'
)
[REQUIRED]
The name of the DevEndpoint .
{}
Response Structure
Exceptions
Deletes a specified job definition. If the job definition is not found, no exception is thrown.
See also: AWS API Documentation
Request Syntax
response = client.delete_job(
JobName='string'
)
[REQUIRED]
The name of the job definition to delete.
{
'JobName': 'string'
}
Response Structure
The name of the job definition that was deleted.
Exceptions
Deletes an Glue machine learning transform. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. If you no longer need a transform, you can delete it by calling DeleteMLTransforms . However, any Glue jobs that still reference the deleted transform will no longer succeed.
See also: AWS API Documentation
Request Syntax
response = client.delete_ml_transform(
TransformId='string'
)
[REQUIRED]
The unique identifier of the transform to delete.
{
'TransformId': 'string'
}
Response Structure
The unique identifier of the transform that was deleted.
Exceptions
Deletes a specified partition.
See also: AWS API Documentation
Request Syntax
response = client.delete_partition(
CatalogId='string',
DatabaseName='string',
TableName='string',
PartitionValues=[
'string',
]
)
[REQUIRED]
The name of the catalog database in which the table in question resides.
[REQUIRED]
The name of the table that contains the partition to be deleted.
[REQUIRED]
The values that define the partition.
dict
Response Syntax
{}
Response Structure
Exceptions
Deletes a specified partition index from an existing table.
See also: AWS API Documentation
Request Syntax
response = client.delete_partition_index(
CatalogId='string',
DatabaseName='string',
TableName='string',
IndexName='string'
)
[REQUIRED]
Specifies the name of a database from which you want to delete a partition index.
[REQUIRED]
Specifies the name of a table from which you want to delete a partition index.
[REQUIRED]
The name of the partition index to be deleted.
dict
Response Syntax
{}
Response Structure
Exceptions
Delete the entire registry including schema and all of its versions. To get the status of the delete operation, you can call the GetRegistry API after the asynchronous call. Deleting a registry will deactivate all online operations for the registry such as the UpdateRegistry , CreateSchema , UpdateSchema , and RegisterSchemaVersion APIs.
See also: AWS API Documentation
Request Syntax
response = client.delete_registry(
RegistryId={
'RegistryName': 'string',
'RegistryArn': 'string'
}
)
[REQUIRED]
This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
Name of the registry. Used only for lookup. One of RegistryArn or RegistryName has to be provided.
Arn of the registry to be updated. One of RegistryArn or RegistryName has to be provided.
{
'RegistryName': 'string',
'RegistryArn': 'string',
'Status': 'AVAILABLE'|'DELETING'
}
Response Structure
The name of the registry being deleted.
The Amazon Resource Name (ARN) of the registry being deleted.
The status of the registry. A successful operation will return the Deleting status.
Exceptions
Deletes a specified policy.
See also: AWS API Documentation
Request Syntax
response = client.delete_resource_policy(
PolicyHashCondition='string',
ResourceArn='string'
)
dict
Response Syntax
{}
Response Structure
Exceptions
Deletes the entire schema set, including the schema set and all of its versions. To get the status of the delete operation, you can call GetSchema API after the asynchronous call. Deleting a registry will deactivate all online operations for the schema, such as the GetSchemaByDefinition , and RegisterSchemaVersion APIs.
See also: AWS API Documentation
Request Syntax
response = client.delete_schema(
SchemaId={
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
}
)
[REQUIRED]
This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
{
'SchemaArn': 'string',
'SchemaName': 'string',
'Status': 'AVAILABLE'|'PENDING'|'DELETING'
}
Response Structure
The Amazon Resource Name (ARN) of the schema being deleted.
The name of the schema being deleted.
The status of the schema.
Exceptions
Remove versions from the specified schema. A version number or range may be supplied. If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned. Calling the GetSchemaVersions API after this call will list the status of the deleted versions.
When the range of version numbers contain check pointed version, the API will return a 409 conflict and will not proceed with the deletion. You have to remove the checkpoint first using the DeleteSchemaCheckpoint API before using this API.
You cannot use the DeleteSchemaVersions API to delete the first schema version in the schema set. The first schema version can only be deleted by the DeleteSchema API. This operation will also delete the attached SchemaVersionMetadata under the schema versions. Hard deletes will be enforced on the database.
If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned.
See also: AWS API Documentation
Request Syntax
response = client.delete_schema_versions(
SchemaId={
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
Versions='string'
)
[REQUIRED]
This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
[REQUIRED]
A version range may be supplied which may be of the format:
dict
Response Syntax
{
'SchemaVersionErrors': [
{
'VersionNumber': 123,
'ErrorDetails': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
SchemaVersionErrors (list) --
A list of SchemaVersionErrorItem objects, each containing an error and schema version.
(dict) --
An object that contains the error details for an operation on a schema version.
VersionNumber (integer) --
The version number of the schema.
ErrorDetails (dict) --
The details of the error for the schema version.
ErrorCode (string) --
The error code for an error.
ErrorMessage (string) --
The error message for an error.
Exceptions
Deletes a specified security configuration.
See also: AWS API Documentation
Request Syntax
response = client.delete_security_configuration(
Name='string'
)
[REQUIRED]
The name of the security configuration to delete.
{}
Response Structure
Exceptions
Removes a table definition from the Data Catalog.
Note
After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling DeleteTable , use DeleteTableVersion or BatchDeleteTableVersion , and DeletePartition or BatchDeletePartition , to delete any resources that belong to the table.
See also: AWS API Documentation
Request Syntax
response = client.delete_table(
CatalogId='string',
DatabaseName='string',
Name='string'
)
[REQUIRED]
The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.
[REQUIRED]
The name of the table to be deleted. For Hive compatibility, this name is entirely lowercase.
dict
Response Syntax
{}
Response Structure
Exceptions
Deletes a specified version of a table.
See also: AWS API Documentation
Request Syntax
response = client.delete_table_version(
CatalogId='string',
DatabaseName='string',
TableName='string',
VersionId='string'
)
[REQUIRED]
The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
[REQUIRED]
The name of the table. For Hive compatibility, this name is entirely lowercase.
[REQUIRED]
The ID of the table version to be deleted. A VersionID is a string representation of an integer. Each version is incremented by 1.
dict
Response Syntax
{}
Response Structure
Exceptions
Deletes a specified trigger. If the trigger is not found, no exception is thrown.
See also: AWS API Documentation
Request Syntax
response = client.delete_trigger(
Name='string'
)
[REQUIRED]
The name of the trigger to delete.
{
'Name': 'string'
}
Response Structure
The name of the trigger that was deleted.
Exceptions
Deletes an existing function definition from the Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.delete_user_defined_function(
CatalogId='string',
DatabaseName='string',
FunctionName='string'
)
[REQUIRED]
The name of the catalog database where the function is located.
[REQUIRED]
The name of the function definition to be deleted.
dict
Response Syntax
{}
Response Structure
Exceptions
Deletes a workflow.
See also: AWS API Documentation
Request Syntax
response = client.delete_workflow(
Name='string'
)
[REQUIRED]
Name of the workflow to be deleted.
{
'Name': 'string'
}
Response Structure
Name of the workflow specified in input.
Exceptions
Retrieves the details of a blueprint.
See also: AWS API Documentation
Request Syntax
response = client.get_blueprint(
Name='string',
IncludeBlueprint=True|False,
IncludeParameterSpec=True|False
)
[REQUIRED]
The name of the blueprint.
dict
Response Syntax
{
'Blueprint': {
'Name': 'string',
'Description': 'string',
'CreatedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'ParameterSpec': 'string',
'BlueprintLocation': 'string',
'BlueprintServiceLocation': 'string',
'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'FAILED',
'ErrorMessage': 'string',
'LastActiveDefinition': {
'Description': 'string',
'LastModifiedOn': datetime(2015, 1, 1),
'ParameterSpec': 'string',
'BlueprintLocation': 'string',
'BlueprintServiceLocation': 'string'
}
}
}
Response Structure
(dict) --
Blueprint (dict) --
Returns a Blueprint object.
Name (string) --
The name of the blueprint.
Description (string) --
The description of the blueprint.
CreatedOn (datetime) --
The date and time the blueprint was registered.
LastModifiedOn (datetime) --
The date and time the blueprint was last modified.
ParameterSpec (string) --
A JSON string that indicates the list of parameter specifications for the blueprint.
BlueprintLocation (string) --
Specifies the path in Amazon S3 where the blueprint is published.
BlueprintServiceLocation (string) --
Specifies a path in Amazon S3 where the blueprint is copied when you call CreateBlueprint/UpdateBlueprint to register the blueprint in Glue.
Status (string) --
The status of the blueprint registration.
ErrorMessage (string) --
An error message.
LastActiveDefinition (dict) --
When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.
Description (string) --
The description of the blueprint.
LastModifiedOn (datetime) --
The date and time the blueprint was last modified.
ParameterSpec (string) --
A JSON string specifying the parameters for the blueprint.
BlueprintLocation (string) --
Specifies a path in Amazon S3 where the blueprint is published by the Glue developer.
BlueprintServiceLocation (string) --
Specifies a path in Amazon S3 where the blueprint is copied when you create or update the blueprint.
Exceptions
Retrieves the details of a blueprint run.
See also: AWS API Documentation
Request Syntax
response = client.get_blueprint_run(
BlueprintName='string',
RunId='string'
)
[REQUIRED]
The name of the blueprint.
[REQUIRED]
The run ID for the blueprint run you want to retrieve.
dict
Response Syntax
{
'BlueprintRun': {
'BlueprintName': 'string',
'RunId': 'string',
'WorkflowName': 'string',
'State': 'RUNNING'|'SUCCEEDED'|'FAILED'|'ROLLING_BACK',
'StartedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'ErrorMessage': 'string',
'RollbackErrorMessage': 'string',
'Parameters': 'string',
'RoleArn': 'string'
}
}
Response Structure
(dict) --
BlueprintRun (dict) --
Returns a BlueprintRun object.
BlueprintName (string) --
The name of the blueprint.
RunId (string) --
The run ID for this blueprint run.
WorkflowName (string) --
The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.
State (string) --
The state of the blueprint run. Possible values are:
StartedOn (datetime) --
The date and time that the blueprint run started.
CompletedOn (datetime) --
The date and time that the blueprint run completed.
ErrorMessage (string) --
Indicates any errors that are seen while running the blueprint.
RollbackErrorMessage (string) --
If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.
Parameters (string) --
The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the Blueprint$ParameterSpec .
RoleArn (string) --
The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.
Exceptions
Retrieves the details of blueprint runs for a specified blueprint.
See also: AWS API Documentation
Request Syntax
response = client.get_blueprint_runs(
BlueprintName='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The name of the blueprint.
dict
Response Syntax
{
'BlueprintRuns': [
{
'BlueprintName': 'string',
'RunId': 'string',
'WorkflowName': 'string',
'State': 'RUNNING'|'SUCCEEDED'|'FAILED'|'ROLLING_BACK',
'StartedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'ErrorMessage': 'string',
'RollbackErrorMessage': 'string',
'Parameters': 'string',
'RoleArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
BlueprintRuns (list) --
Returns a list of BlueprintRun objects.
(dict) --
The details of a blueprint run.
BlueprintName (string) --
The name of the blueprint.
RunId (string) --
The run ID for this blueprint run.
WorkflowName (string) --
The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.
State (string) --
The state of the blueprint run. Possible values are:
StartedOn (datetime) --
The date and time that the blueprint run started.
CompletedOn (datetime) --
The date and time that the blueprint run completed.
ErrorMessage (string) --
Indicates any errors that are seen while running the blueprint.
RollbackErrorMessage (string) --
If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.
Parameters (string) --
The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the Blueprint$ParameterSpec .
RoleArn (string) --
The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.
NextToken (string) --
A continuation token, if not all blueprint runs have been returned.
Exceptions
Retrieves the status of a migration operation.
See also: AWS API Documentation
Request Syntax
response = client.get_catalog_import_status(
CatalogId='string'
)
{
'ImportStatus': {
'ImportCompleted': True|False,
'ImportTime': datetime(2015, 1, 1),
'ImportedBy': 'string'
}
}
Response Structure
The status of the specified catalog migration.
True if the migration has completed, or False otherwise.
The time that the migration was started.
The name of the person who initiated the migration.
Exceptions
Retrieve a classifier by name.
See also: AWS API Documentation
Request Syntax
response = client.get_classifier(
Name='string'
)
[REQUIRED]
Name of the classifier to retrieve.
{
'Classifier': {
'GrokClassifier': {
'Name': 'string',
'Classification': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Version': 123,
'GrokPattern': 'string',
'CustomPatterns': 'string'
},
'XMLClassifier': {
'Name': 'string',
'Classification': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Version': 123,
'RowTag': 'string'
},
'JsonClassifier': {
'Name': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Version': 123,
'JsonPath': 'string'
},
'CsvClassifier': {
'Name': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Version': 123,
'Delimiter': 'string',
'QuoteSymbol': 'string',
'ContainsHeader': 'UNKNOWN'|'PRESENT'|'ABSENT',
'Header': [
'string',
],
'DisableValueTrimming': True|False,
'AllowSingleColumn': True|False
}
}
}
Response Structure
The requested classifier.
A classifier that uses grok .
The name of the classifier.
An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.
The time that this classifier was registered.
The time that this classifier was last updated.
The version of this classifier.
The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers .
Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers .
A classifier for XML content.
The name of the classifier.
An identifier of the data format that the classifier matches.
The time that this classifier was registered.
The time that this classifier was last updated.
The version of this classifier.
The XML tag designating the element that contains each record in an XML document being parsed. This can't identify a self-closing element (closed by /> ). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).
A classifier for JSON content.
The name of the classifier.
The time that this classifier was registered.
The time that this classifier was last updated.
The version of this classifier.
A JsonPath string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers .
A classifier for comma-separated values (CSV).
The name of the classifier.
The time that this classifier was registered.
The time that this classifier was last updated.
The version of this classifier.
A custom symbol to denote what separates each column entry in the row.
A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
Indicates whether the CSV file contains a header.
A list of strings representing column names.
Specifies not to trim values before identifying the type of column values. The default value is true .
Enables the processing of files that contain only one column.
Exceptions
Lists all classifier objects in the Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.get_classifiers(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'Classifiers': [
{
'GrokClassifier': {
'Name': 'string',
'Classification': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Version': 123,
'GrokPattern': 'string',
'CustomPatterns': 'string'
},
'XMLClassifier': {
'Name': 'string',
'Classification': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Version': 123,
'RowTag': 'string'
},
'JsonClassifier': {
'Name': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Version': 123,
'JsonPath': 'string'
},
'CsvClassifier': {
'Name': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Version': 123,
'Delimiter': 'string',
'QuoteSymbol': 'string',
'ContainsHeader': 'UNKNOWN'|'PRESENT'|'ABSENT',
'Header': [
'string',
],
'DisableValueTrimming': True|False,
'AllowSingleColumn': True|False
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Classifiers (list) --
The requested list of classifier objects.
(dict) --
Classifiers are triggered during a crawl task. A classifier checks whether a given file is in a format it can handle. If it is, the classifier creates a schema in the form of a StructType object that matches that data format.
You can use the standard classifiers that Glue provides, or you can write your own classifiers to best categorize your data sources and specify the appropriate schemas to use for them. A classifier can be a grok classifier, an XML classifier, a JSON classifier, or a custom CSV classifier, as specified in one of the fields in the Classifier object.
GrokClassifier (dict) --
A classifier that uses grok .
Name (string) --
The name of the classifier.
Classification (string) --
An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.
CreationTime (datetime) --
The time that this classifier was registered.
LastUpdated (datetime) --
The time that this classifier was last updated.
Version (integer) --
The version of this classifier.
GrokPattern (string) --
The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers .
CustomPatterns (string) --
Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers .
XMLClassifier (dict) --
A classifier for XML content.
Name (string) --
The name of the classifier.
Classification (string) --
An identifier of the data format that the classifier matches.
CreationTime (datetime) --
The time that this classifier was registered.
LastUpdated (datetime) --
The time that this classifier was last updated.
Version (integer) --
The version of this classifier.
RowTag (string) --
The XML tag designating the element that contains each record in an XML document being parsed. This can't identify a self-closing element (closed by /> ). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).
JsonClassifier (dict) --
A classifier for JSON content.
Name (string) --
The name of the classifier.
CreationTime (datetime) --
The time that this classifier was registered.
LastUpdated (datetime) --
The time that this classifier was last updated.
Version (integer) --
The version of this classifier.
JsonPath (string) --
A JsonPath string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers .
CsvClassifier (dict) --
A classifier for comma-separated values (CSV).
Name (string) --
The name of the classifier.
CreationTime (datetime) --
The time that this classifier was registered.
LastUpdated (datetime) --
The time that this classifier was last updated.
Version (integer) --
The version of this classifier.
Delimiter (string) --
A custom symbol to denote what separates each column entry in the row.
QuoteSymbol (string) --
A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
ContainsHeader (string) --
Indicates whether the CSV file contains a header.
Header (list) --
A list of strings representing column names.
DisableValueTrimming (boolean) --
Specifies not to trim values before identifying the type of column values. The default value is true .
AllowSingleColumn (boolean) --
Enables the processing of files that contain only one column.
NextToken (string) --
A continuation token.
Exceptions
Retrieves partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is GetPartition .
See also: AWS API Documentation
Request Syntax
response = client.get_column_statistics_for_partition(
CatalogId='string',
DatabaseName='string',
TableName='string',
PartitionValues=[
'string',
],
ColumnNames=[
'string',
]
)
[REQUIRED]
The name of the catalog database where the partitions reside.
[REQUIRED]
The name of the partitions' table.
[REQUIRED]
A list of partition values identifying the partition.
[REQUIRED]
A list of the column names.
dict
Response Syntax
{
'ColumnStatisticsList': [
{
'ColumnName': 'string',
'ColumnType': 'string',
'AnalyzedTime': datetime(2015, 1, 1),
'StatisticsData': {
'Type': 'BOOLEAN'|'DATE'|'DECIMAL'|'DOUBLE'|'LONG'|'STRING'|'BINARY',
'BooleanColumnStatisticsData': {
'NumberOfTrues': 123,
'NumberOfFalses': 123,
'NumberOfNulls': 123
},
'DateColumnStatisticsData': {
'MinimumValue': datetime(2015, 1, 1),
'MaximumValue': datetime(2015, 1, 1),
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'DecimalColumnStatisticsData': {
'MinimumValue': {
'UnscaledValue': b'bytes',
'Scale': 123
},
'MaximumValue': {
'UnscaledValue': b'bytes',
'Scale': 123
},
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'DoubleColumnStatisticsData': {
'MinimumValue': 123.0,
'MaximumValue': 123.0,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'LongColumnStatisticsData': {
'MinimumValue': 123,
'MaximumValue': 123,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'StringColumnStatisticsData': {
'MaximumLength': 123,
'AverageLength': 123.0,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'BinaryColumnStatisticsData': {
'MaximumLength': 123,
'AverageLength': 123.0,
'NumberOfNulls': 123
}
}
},
],
'Errors': [
{
'ColumnName': 'string',
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
ColumnStatisticsList (list) --
List of ColumnStatistics that failed to be retrieved.
(dict) --
Represents the generated column-level statistics for a table or partition.
ColumnName (string) --
Name of column which statistics belong to.
ColumnType (string) --
The data type of the column.
AnalyzedTime (datetime) --
The timestamp of when column statistics were generated.
StatisticsData (dict) --
A ColumnStatisticData object that contains the statistics data values.
Type (string) --
The type of column statistics data.
BooleanColumnStatisticsData (dict) --
Boolean column statistics data.
NumberOfTrues (integer) --
The number of true values in the column.
NumberOfFalses (integer) --
The number of false values in the column.
NumberOfNulls (integer) --
The number of null values in the column.
DateColumnStatisticsData (dict) --
Date column statistics data.
MinimumValue (datetime) --
The lowest value in the column.
MaximumValue (datetime) --
The highest value in the column.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
DecimalColumnStatisticsData (dict) --
Decimal column statistics data.
MinimumValue (dict) --
The lowest value in the column.
UnscaledValue (bytes) --
The unscaled numeric value.
Scale (integer) --
The scale that determines where the decimal point falls in the unscaled value.
MaximumValue (dict) --
The highest value in the column.
UnscaledValue (bytes) --
The unscaled numeric value.
Scale (integer) --
The scale that determines where the decimal point falls in the unscaled value.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
DoubleColumnStatisticsData (dict) --
Double column statistics data.
MinimumValue (float) --
The lowest value in the column.
MaximumValue (float) --
The highest value in the column.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
LongColumnStatisticsData (dict) --
Long column statistics data.
MinimumValue (integer) --
The lowest value in the column.
MaximumValue (integer) --
The highest value in the column.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
StringColumnStatisticsData (dict) --
String column statistics data.
MaximumLength (integer) --
The size of the longest string in the column.
AverageLength (float) --
The average string length in the column.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
BinaryColumnStatisticsData (dict) --
Binary column statistics data.
MaximumLength (integer) --
The size of the longest bit sequence in the column.
AverageLength (float) --
The average bit sequence length in the column.
NumberOfNulls (integer) --
The number of null values in the column.
Errors (list) --
Error occurred during retrieving column statistics data.
(dict) --
Encapsulates a column name that failed and the reason for failure.
ColumnName (string) --
The name of the column that failed.
Error (dict) --
An error message with the reason for the failure of an operation.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Exceptions
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is GetTable .
See also: AWS API Documentation
Request Syntax
response = client.get_column_statistics_for_table(
CatalogId='string',
DatabaseName='string',
TableName='string',
ColumnNames=[
'string',
]
)
[REQUIRED]
The name of the catalog database where the partitions reside.
[REQUIRED]
The name of the partitions' table.
[REQUIRED]
A list of the column names.
dict
Response Syntax
{
'ColumnStatisticsList': [
{
'ColumnName': 'string',
'ColumnType': 'string',
'AnalyzedTime': datetime(2015, 1, 1),
'StatisticsData': {
'Type': 'BOOLEAN'|'DATE'|'DECIMAL'|'DOUBLE'|'LONG'|'STRING'|'BINARY',
'BooleanColumnStatisticsData': {
'NumberOfTrues': 123,
'NumberOfFalses': 123,
'NumberOfNulls': 123
},
'DateColumnStatisticsData': {
'MinimumValue': datetime(2015, 1, 1),
'MaximumValue': datetime(2015, 1, 1),
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'DecimalColumnStatisticsData': {
'MinimumValue': {
'UnscaledValue': b'bytes',
'Scale': 123
},
'MaximumValue': {
'UnscaledValue': b'bytes',
'Scale': 123
},
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'DoubleColumnStatisticsData': {
'MinimumValue': 123.0,
'MaximumValue': 123.0,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'LongColumnStatisticsData': {
'MinimumValue': 123,
'MaximumValue': 123,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'StringColumnStatisticsData': {
'MaximumLength': 123,
'AverageLength': 123.0,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'BinaryColumnStatisticsData': {
'MaximumLength': 123,
'AverageLength': 123.0,
'NumberOfNulls': 123
}
}
},
],
'Errors': [
{
'ColumnName': 'string',
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
ColumnStatisticsList (list) --
List of ColumnStatistics that failed to be retrieved.
(dict) --
Represents the generated column-level statistics for a table or partition.
ColumnName (string) --
Name of column which statistics belong to.
ColumnType (string) --
The data type of the column.
AnalyzedTime (datetime) --
The timestamp of when column statistics were generated.
StatisticsData (dict) --
A ColumnStatisticData object that contains the statistics data values.
Type (string) --
The type of column statistics data.
BooleanColumnStatisticsData (dict) --
Boolean column statistics data.
NumberOfTrues (integer) --
The number of true values in the column.
NumberOfFalses (integer) --
The number of false values in the column.
NumberOfNulls (integer) --
The number of null values in the column.
DateColumnStatisticsData (dict) --
Date column statistics data.
MinimumValue (datetime) --
The lowest value in the column.
MaximumValue (datetime) --
The highest value in the column.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
DecimalColumnStatisticsData (dict) --
Decimal column statistics data.
MinimumValue (dict) --
The lowest value in the column.
UnscaledValue (bytes) --
The unscaled numeric value.
Scale (integer) --
The scale that determines where the decimal point falls in the unscaled value.
MaximumValue (dict) --
The highest value in the column.
UnscaledValue (bytes) --
The unscaled numeric value.
Scale (integer) --
The scale that determines where the decimal point falls in the unscaled value.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
DoubleColumnStatisticsData (dict) --
Double column statistics data.
MinimumValue (float) --
The lowest value in the column.
MaximumValue (float) --
The highest value in the column.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
LongColumnStatisticsData (dict) --
Long column statistics data.
MinimumValue (integer) --
The lowest value in the column.
MaximumValue (integer) --
The highest value in the column.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
StringColumnStatisticsData (dict) --
String column statistics data.
MaximumLength (integer) --
The size of the longest string in the column.
AverageLength (float) --
The average string length in the column.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
BinaryColumnStatisticsData (dict) --
Binary column statistics data.
MaximumLength (integer) --
The size of the longest bit sequence in the column.
AverageLength (float) --
The average bit sequence length in the column.
NumberOfNulls (integer) --
The number of null values in the column.
Errors (list) --
List of ColumnStatistics that failed to be retrieved.
(dict) --
Encapsulates a column name that failed and the reason for failure.
ColumnName (string) --
The name of the column that failed.
Error (dict) --
An error message with the reason for the failure of an operation.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Exceptions
Retrieves a connection definition from the Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.get_connection(
CatalogId='string',
Name='string',
HidePassword=True|False
)
[REQUIRED]
The name of the connection definition to retrieve.
dict
Response Syntax
{
'Connection': {
'Name': 'string',
'Description': 'string',
'ConnectionType': 'JDBC'|'SFTP'|'MONGODB'|'KAFKA'|'NETWORK'|'MARKETPLACE'|'CUSTOM',
'MatchCriteria': [
'string',
],
'ConnectionProperties': {
'string': 'string'
},
'PhysicalConnectionRequirements': {
'SubnetId': 'string',
'SecurityGroupIdList': [
'string',
],
'AvailabilityZone': 'string'
},
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'LastUpdatedBy': 'string'
}
}
Response Structure
(dict) --
Connection (dict) --
The requested connection definition.
Name (string) --
The name of the connection definition.
Description (string) --
The description of the connection.
ConnectionType (string) --
The type of the connection. Currently, SFTP is not supported.
MatchCriteria (list) --
A list of criteria that can be used in selecting this connection.
ConnectionProperties (dict) --
These key-value pairs define parameters for the connection:
PhysicalConnectionRequirements (dict) --
A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to make this connection successfully.
SubnetId (string) --
The subnet ID used by the connection.
SecurityGroupIdList (list) --
The security group ID list used by the connection.
AvailabilityZone (string) --
The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.
CreationTime (datetime) --
The time that this connection definition was created.
LastUpdatedTime (datetime) --
The last time that this connection definition was updated.
LastUpdatedBy (string) --
The user, group, or role that last updated this connection definition.
Exceptions
Retrieves a list of connection definitions from the Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.get_connections(
CatalogId='string',
Filter={
'MatchCriteria': [
'string',
],
'ConnectionType': 'JDBC'|'SFTP'|'MONGODB'|'KAFKA'|'NETWORK'|'MARKETPLACE'|'CUSTOM'
},
HidePassword=True|False,
NextToken='string',
MaxResults=123
)
A filter that controls which connections are returned.
A criteria string that must match the criteria recorded in the connection definition for that connection definition to be returned.
The type of connections to return. Currently, SFTP is not supported.
dict
Response Syntax
{
'ConnectionList': [
{
'Name': 'string',
'Description': 'string',
'ConnectionType': 'JDBC'|'SFTP'|'MONGODB'|'KAFKA'|'NETWORK'|'MARKETPLACE'|'CUSTOM',
'MatchCriteria': [
'string',
],
'ConnectionProperties': {
'string': 'string'
},
'PhysicalConnectionRequirements': {
'SubnetId': 'string',
'SecurityGroupIdList': [
'string',
],
'AvailabilityZone': 'string'
},
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'LastUpdatedBy': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConnectionList (list) --
A list of requested connection definitions.
(dict) --
Defines a connection to a data source.
Name (string) --
The name of the connection definition.
Description (string) --
The description of the connection.
ConnectionType (string) --
The type of the connection. Currently, SFTP is not supported.
MatchCriteria (list) --
A list of criteria that can be used in selecting this connection.
ConnectionProperties (dict) --
These key-value pairs define parameters for the connection:
PhysicalConnectionRequirements (dict) --
A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to make this connection successfully.
SubnetId (string) --
The subnet ID used by the connection.
SecurityGroupIdList (list) --
The security group ID list used by the connection.
AvailabilityZone (string) --
The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.
CreationTime (datetime) --
The time that this connection definition was created.
LastUpdatedTime (datetime) --
The last time that this connection definition was updated.
LastUpdatedBy (string) --
The user, group, or role that last updated this connection definition.
NextToken (string) --
A continuation token, if the list of connections returned does not include the last of the filtered connections.
Exceptions
Retrieves metadata for a specified crawler.
See also: AWS API Documentation
Request Syntax
response = client.get_crawler(
Name='string'
)
[REQUIRED]
The name of the crawler to retrieve metadata for.
{
'Crawler': {
'Name': 'string',
'Role': 'string',
'Targets': {
'S3Targets': [
{
'Path': 'string',
'Exclusions': [
'string',
],
'ConnectionName': 'string',
'SampleSize': 123,
'EventQueueArn': 'string',
'DlqEventQueueArn': 'string'
},
],
'JdbcTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'Exclusions': [
'string',
]
},
],
'MongoDBTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'ScanAll': True|False
},
],
'DynamoDBTargets': [
{
'Path': 'string',
'scanAll': True|False,
'scanRate': 123.0
},
],
'CatalogTargets': [
{
'DatabaseName': 'string',
'Tables': [
'string',
]
},
]
},
'DatabaseName': 'string',
'Description': 'string',
'Classifiers': [
'string',
],
'RecrawlPolicy': {
'RecrawlBehavior': 'CRAWL_EVERYTHING'|'CRAWL_NEW_FOLDERS_ONLY'|'CRAWL_EVENT_MODE'
},
'SchemaChangePolicy': {
'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
},
'LineageConfiguration': {
'CrawlerLineageSettings': 'ENABLE'|'DISABLE'
},
'State': 'READY'|'RUNNING'|'STOPPING',
'TablePrefix': 'string',
'Schedule': {
'ScheduleExpression': 'string',
'State': 'SCHEDULED'|'NOT_SCHEDULED'|'TRANSITIONING'
},
'CrawlElapsedTime': 123,
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'LastCrawl': {
'Status': 'SUCCEEDED'|'CANCELLED'|'FAILED',
'ErrorMessage': 'string',
'LogGroup': 'string',
'LogStream': 'string',
'MessagePrefix': 'string',
'StartTime': datetime(2015, 1, 1)
},
'Version': 123,
'Configuration': 'string',
'CrawlerSecurityConfiguration': 'string'
}
}
Response Structure
The metadata for the specified crawler.
The name of the crawler.
The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
A collection of targets to crawl.
Specifies Amazon Simple Storage Service (Amazon S3) targets.
Specifies a data store in Amazon Simple Storage Service (Amazon S3).
The path to the Amazon S3 target.
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .
The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs .
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue .
Specifies JDBC targets.
Specifies a JDBC data store to crawl.
The name of the connection to use to connect to the JDBC target.
The path of the JDBC target.
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .
Specifies Amazon DocumentDB or MongoDB targets.
Specifies an Amazon DocumentDB or MongoDB data store to crawl.
The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
The path of the Amazon DocumentDB or MongoDB target (database/collection).
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .
Specifies Amazon DynamoDB targets.
Specifies an Amazon DynamoDB table to crawl.
The name of the DynamoDB table to crawl.
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .
The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
Specifies Glue Data Catalog targets.
Specifies an Glue Data Catalog target.
The name of the database to be synchronized.
A list of the tables to be synchronized.
The name of the database in which the crawler's output is stored.
A description of the crawler.
A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.
A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
The policy that specifies update and delete behaviors for the crawler.
The update behavior when the crawler finds a changed schema.
The deletion behavior when the crawler finds a deleted object.
A configuration that specifies whether data lineage is enabled for the crawler.
Specifies whether data lineage is enabled for the crawler. Valid values are:
Indicates whether the crawler is running, or whether a run is pending.
The prefix added to the names of tables that are created.
For scheduled crawlers, the schedule when the crawler runs.
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
The state of the schedule.
If the crawler is running, contains the total time elapsed since the last crawl began.
The time that the crawler was created.
The time that the crawler was last updated.
The status of the last crawl, and potentially error information if an error occurred.
Status of the last crawl.
If an error occurred, the error information about the last crawl.
The log group for the last crawl.
The log stream for the last crawl.
The prefix for a message about this crawl.
The time at which the crawl started.
The version of the crawler.
Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Include and Exclude Patterns .
The name of the SecurityConfiguration structure to be used by this crawler.
Exceptions
Retrieves metrics about specified crawlers.
See also: AWS API Documentation
Request Syntax
response = client.get_crawler_metrics(
CrawlerNameList=[
'string',
],
MaxResults=123,
NextToken='string'
)
A list of the names of crawlers about which to retrieve metrics.
dict
Response Syntax
{
'CrawlerMetricsList': [
{
'CrawlerName': 'string',
'TimeLeftSeconds': 123.0,
'StillEstimating': True|False,
'LastRuntimeSeconds': 123.0,
'MedianRuntimeSeconds': 123.0,
'TablesCreated': 123,
'TablesUpdated': 123,
'TablesDeleted': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CrawlerMetricsList (list) --
A list of metrics for the specified crawler.
(dict) --
Metrics for a specified crawler.
CrawlerName (string) --
The name of the crawler.
TimeLeftSeconds (float) --
The estimated time left to complete a running crawl.
StillEstimating (boolean) --
True if the crawler is still estimating how long it will take to complete this run.
LastRuntimeSeconds (float) --
The duration of the crawler's most recent run, in seconds.
MedianRuntimeSeconds (float) --
The median duration of this crawler's runs, in seconds.
TablesCreated (integer) --
The number of tables created by this crawler.
TablesUpdated (integer) --
The number of tables updated by this crawler.
TablesDeleted (integer) --
The number of tables deleted by this crawler.
NextToken (string) --
A continuation token, if the returned list does not contain the last metric available.
Exceptions
Retrieves metadata for all crawlers defined in the customer account.
See also: AWS API Documentation
Request Syntax
response = client.get_crawlers(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'Crawlers': [
{
'Name': 'string',
'Role': 'string',
'Targets': {
'S3Targets': [
{
'Path': 'string',
'Exclusions': [
'string',
],
'ConnectionName': 'string',
'SampleSize': 123,
'EventQueueArn': 'string',
'DlqEventQueueArn': 'string'
},
],
'JdbcTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'Exclusions': [
'string',
]
},
],
'MongoDBTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'ScanAll': True|False
},
],
'DynamoDBTargets': [
{
'Path': 'string',
'scanAll': True|False,
'scanRate': 123.0
},
],
'CatalogTargets': [
{
'DatabaseName': 'string',
'Tables': [
'string',
]
},
]
},
'DatabaseName': 'string',
'Description': 'string',
'Classifiers': [
'string',
],
'RecrawlPolicy': {
'RecrawlBehavior': 'CRAWL_EVERYTHING'|'CRAWL_NEW_FOLDERS_ONLY'|'CRAWL_EVENT_MODE'
},
'SchemaChangePolicy': {
'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
},
'LineageConfiguration': {
'CrawlerLineageSettings': 'ENABLE'|'DISABLE'
},
'State': 'READY'|'RUNNING'|'STOPPING',
'TablePrefix': 'string',
'Schedule': {
'ScheduleExpression': 'string',
'State': 'SCHEDULED'|'NOT_SCHEDULED'|'TRANSITIONING'
},
'CrawlElapsedTime': 123,
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'LastCrawl': {
'Status': 'SUCCEEDED'|'CANCELLED'|'FAILED',
'ErrorMessage': 'string',
'LogGroup': 'string',
'LogStream': 'string',
'MessagePrefix': 'string',
'StartTime': datetime(2015, 1, 1)
},
'Version': 123,
'Configuration': 'string',
'CrawlerSecurityConfiguration': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Crawlers (list) --
A list of crawler metadata.
(dict) --
Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source in the Glue Data Catalog.
Name (string) --
The name of the crawler.
Role (string) --
The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
Targets (dict) --
A collection of targets to crawl.
S3Targets (list) --
Specifies Amazon Simple Storage Service (Amazon S3) targets.
(dict) --
Specifies a data store in Amazon Simple Storage Service (Amazon S3).
Path (string) --
The path to the Amazon S3 target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .
ConnectionName (string) --
The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
SampleSize (integer) --
Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
EventQueueArn (string) --
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs .
DlqEventQueueArn (string) --
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue .
JdbcTargets (list) --
Specifies JDBC targets.
(dict) --
Specifies a JDBC data store to crawl.
ConnectionName (string) --
The name of the connection to use to connect to the JDBC target.
Path (string) --
The path of the JDBC target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .
MongoDBTargets (list) --
Specifies Amazon DocumentDB or MongoDB targets.
(dict) --
Specifies an Amazon DocumentDB or MongoDB data store to crawl.
ConnectionName (string) --
The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
Path (string) --
The path of the Amazon DocumentDB or MongoDB target (database/collection).
ScanAll (boolean) --
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .
DynamoDBTargets (list) --
Specifies Amazon DynamoDB targets.
(dict) --
Specifies an Amazon DynamoDB table to crawl.
Path (string) --
The name of the DynamoDB table to crawl.
scanAll (boolean) --
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .
scanRate (float) --
The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
CatalogTargets (list) --
Specifies Glue Data Catalog targets.
(dict) --
Specifies an Glue Data Catalog target.
DatabaseName (string) --
The name of the database to be synchronized.
Tables (list) --
A list of the tables to be synchronized.
DatabaseName (string) --
The name of the database in which the crawler's output is stored.
Description (string) --
A description of the crawler.
Classifiers (list) --
A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
RecrawlPolicy (dict) --
A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
RecrawlBehavior (string) --
Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.
A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
SchemaChangePolicy (dict) --
The policy that specifies update and delete behaviors for the crawler.
UpdateBehavior (string) --
The update behavior when the crawler finds a changed schema.
DeleteBehavior (string) --
The deletion behavior when the crawler finds a deleted object.
LineageConfiguration (dict) --
A configuration that specifies whether data lineage is enabled for the crawler.
CrawlerLineageSettings (string) --
Specifies whether data lineage is enabled for the crawler. Valid values are:
State (string) --
Indicates whether the crawler is running, or whether a run is pending.
TablePrefix (string) --
The prefix added to the names of tables that are created.
Schedule (dict) --
For scheduled crawlers, the schedule when the crawler runs.
ScheduleExpression (string) --
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
State (string) --
The state of the schedule.
CrawlElapsedTime (integer) --
If the crawler is running, contains the total time elapsed since the last crawl began.
CreationTime (datetime) --
The time that the crawler was created.
LastUpdated (datetime) --
The time that the crawler was last updated.
LastCrawl (dict) --
The status of the last crawl, and potentially error information if an error occurred.
Status (string) --
Status of the last crawl.
ErrorMessage (string) --
If an error occurred, the error information about the last crawl.
LogGroup (string) --
The log group for the last crawl.
LogStream (string) --
The log stream for the last crawl.
MessagePrefix (string) --
The prefix for a message about this crawl.
StartTime (datetime) --
The time at which the crawl started.
Version (integer) --
The version of the crawler.
Configuration (string) --
Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Include and Exclude Patterns .
CrawlerSecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used by this crawler.
NextToken (string) --
A continuation token, if the returned list has not reached the end of those defined in this customer account.
Exceptions
Retrieves the security configuration for a specified catalog.
See also: AWS API Documentation
Request Syntax
response = client.get_data_catalog_encryption_settings(
CatalogId='string'
)
{
'DataCatalogEncryptionSettings': {
'EncryptionAtRest': {
'CatalogEncryptionMode': 'DISABLED'|'SSE-KMS',
'SseAwsKmsKeyId': 'string'
},
'ConnectionPasswordEncryption': {
'ReturnConnectionPasswordEncrypted': True|False,
'AwsKmsKeyId': 'string'
}
}
}
Response Structure
The requested security configuration.
Specifies the encryption-at-rest configuration for the Data Catalog.
The encryption-at-rest mode for encrypting Data Catalog data.
The ID of the KMS key to use for encryption at rest.
When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption.
When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords remain encrypted in the responses of GetConnection and GetConnections . This encryption takes effect independently from catalog encryption.
An KMS key that is used to encrypt the connection password.
If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified KMS key, to encrypt passwords before storing them in the Data Catalog.
You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.
Exceptions
Retrieves the definition of a specified database.
See also: AWS API Documentation
Request Syntax
response = client.get_database(
CatalogId='string',
Name='string'
)
[REQUIRED]
The name of the database to retrieve. For Hive compatibility, this should be all lowercase.
dict
Response Syntax
{
'Database': {
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'Parameters': {
'string': 'string'
},
'CreateTime': datetime(2015, 1, 1),
'CreateTableDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'TargetDatabase': {
'CatalogId': 'string',
'DatabaseName': 'string'
},
'CatalogId': 'string'
}
}
Response Structure
(dict) --
Database (dict) --
The definition of the specified database in the Data Catalog.
Name (string) --
The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
Description (string) --
A description of the database.
LocationUri (string) --
The location of the database (for example, an HDFS path).
Parameters (dict) --
These key-value pairs define parameters and properties of the database.
CreateTime (datetime) --
The time at which the metadata database was created in the catalog.
CreateTableDefaultPermissions (list) --
Creates a set of default permissions on the table for principals.
(dict) --
Permissions granted to a principal.
Principal (dict) --
The principal who is granted permissions.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
Permissions (list) --
The permissions that are granted to the principal.
TargetDatabase (dict) --
A DatabaseIdentifier structure that describes a target database for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the database resides.
DatabaseName (string) --
The name of the catalog database.
CatalogId (string) --
The ID of the Data Catalog in which the database resides.
Exceptions
Retrieves all databases defined in a given Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.get_databases(
CatalogId='string',
NextToken='string',
MaxResults=123,
ResourceShareType='FOREIGN'|'ALL'
)
Allows you to specify that you want to list the databases shared with your account. The allowable values are FOREIGN or ALL .
dict
Response Syntax
{
'DatabaseList': [
{
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'Parameters': {
'string': 'string'
},
'CreateTime': datetime(2015, 1, 1),
'CreateTableDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'TargetDatabase': {
'CatalogId': 'string',
'DatabaseName': 'string'
},
'CatalogId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DatabaseList (list) --
A list of Database objects from the specified catalog.
(dict) --
The Database object represents a logical grouping of tables that might reside in a Hive metastore or an RDBMS.
Name (string) --
The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
Description (string) --
A description of the database.
LocationUri (string) --
The location of the database (for example, an HDFS path).
Parameters (dict) --
These key-value pairs define parameters and properties of the database.
CreateTime (datetime) --
The time at which the metadata database was created in the catalog.
CreateTableDefaultPermissions (list) --
Creates a set of default permissions on the table for principals.
(dict) --
Permissions granted to a principal.
Principal (dict) --
The principal who is granted permissions.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
Permissions (list) --
The permissions that are granted to the principal.
TargetDatabase (dict) --
A DatabaseIdentifier structure that describes a target database for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the database resides.
DatabaseName (string) --
The name of the catalog database.
CatalogId (string) --
The ID of the Data Catalog in which the database resides.
NextToken (string) --
A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
Exceptions
Transforms a Python script into a directed acyclic graph (DAG).
See also: AWS API Documentation
Request Syntax
response = client.get_dataflow_graph(
PythonScript='string'
)
{
'DagNodes': [
{
'Id': 'string',
'NodeType': 'string',
'Args': [
{
'Name': 'string',
'Value': 'string',
'Param': True|False
},
],
'LineNumber': 123
},
],
'DagEdges': [
{
'Source': 'string',
'Target': 'string',
'TargetParameter': 'string'
},
]
}
Response Structure
A list of the nodes in the resulting DAG.
Represents a node in a directed acyclic graph (DAG)
A node identifier that is unique within the node's graph.
The type of node that this is.
Properties of the node, in the form of name-value pairs.
An argument or property of a node.
The name of the argument or property.
The value of the argument or property.
True if the value is used as a parameter.
The line number of the node.
A list of the edges in the resulting DAG.
Represents a directional edge in a directed acyclic graph (DAG).
The ID of the node at which the edge starts.
The ID of the node at which the edge ends.
The target of the edge.
Exceptions
Retrieves information about a specified development endpoint.
Note
When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address.
See also: AWS API Documentation
Request Syntax
response = client.get_dev_endpoint(
EndpointName='string'
)
[REQUIRED]
Name of the DevEndpoint to retrieve information for.
{
'DevEndpoint': {
'EndpointName': 'string',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string',
'YarnEndpointAddress': 'string',
'PrivateAddress': 'string',
'ZeppelinRemoteSparkInterpreterPort': 123,
'PublicAddress': 'string',
'Status': 'string',
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'GlueVersion': 'string',
'NumberOfWorkers': 123,
'NumberOfNodes': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'ExtraPythonLibsS3Path': 'string',
'ExtraJarsS3Path': 'string',
'FailureReason': 'string',
'LastUpdateStatus': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastModifiedTimestamp': datetime(2015, 1, 1),
'PublicKey': 'string',
'PublicKeys': [
'string',
],
'SecurityConfiguration': 'string',
'Arguments': {
'string': 'string'
}
}
}
Response Structure
A DevEndpoint definition.
The name of the DevEndpoint .
The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint .
A list of security group identifiers used in this DevEndpoint .
The subnet ID for this DevEndpoint .
The YARN endpoint address used by this DevEndpoint .
A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your VPC.
The Apache Zeppelin port for the remote Apache Spark interpreter.
The public IP address used by this DevEndpoint . The PublicAddress field is present only when you create a non-virtual private cloud (VPC) DevEndpoint .
The current status of this DevEndpoint .
The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
The number of workers of a defined workerType that are allocated to the development endpoint.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint .
The AWS Availability Zone where this DevEndpoint is located.
The ID of the virtual private cloud (VPC) used by this DevEndpoint .
The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint . Multiple values must be complete paths separated by a comma.
Note
You can only use pure Python libraries with a DevEndpoint . Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.
The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint .
Note
You can only use pure Java/Scala libraries with a DevEndpoint .
The reason for a current failure in this DevEndpoint .
The status of the last update.
The point in time at which this DevEndpoint was created.
The point in time at which this DevEndpoint was last modified.
The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.
A list of public keys to be used by the DevEndpoints for authentication. Using this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.
Note
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint API operation with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
The name of the SecurityConfiguration structure to be used with this DevEndpoint .
A map of arguments used to configure the DevEndpoint .
Valid arguments are:
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
Exceptions
Retrieves all the development endpoints in this AWS account.
Note
When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address.
See also: AWS API Documentation
Request Syntax
response = client.get_dev_endpoints(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'DevEndpoints': [
{
'EndpointName': 'string',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string',
'YarnEndpointAddress': 'string',
'PrivateAddress': 'string',
'ZeppelinRemoteSparkInterpreterPort': 123,
'PublicAddress': 'string',
'Status': 'string',
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'GlueVersion': 'string',
'NumberOfWorkers': 123,
'NumberOfNodes': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'ExtraPythonLibsS3Path': 'string',
'ExtraJarsS3Path': 'string',
'FailureReason': 'string',
'LastUpdateStatus': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastModifiedTimestamp': datetime(2015, 1, 1),
'PublicKey': 'string',
'PublicKeys': [
'string',
],
'SecurityConfiguration': 'string',
'Arguments': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DevEndpoints (list) --
A list of DevEndpoint definitions.
(dict) --
A development endpoint where a developer can remotely debug extract, transform, and load (ETL) scripts.
EndpointName (string) --
The name of the DevEndpoint .
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint .
SecurityGroupIds (list) --
A list of security group identifiers used in this DevEndpoint .
SubnetId (string) --
The subnet ID for this DevEndpoint .
YarnEndpointAddress (string) --
The YARN endpoint address used by this DevEndpoint .
PrivateAddress (string) --
A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your VPC.
ZeppelinRemoteSparkInterpreterPort (integer) --
The Apache Zeppelin port for the remote Apache Spark interpreter.
PublicAddress (string) --
The public IP address used by this DevEndpoint . The PublicAddress field is present only when you create a non-virtual private cloud (VPC) DevEndpoint .
Status (string) --
The current status of this DevEndpoint .
WorkerType (string) --
The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.
GlueVersion (string) --
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
NumberOfWorkers (integer) --
The number of workers of a defined workerType that are allocated to the development endpoint.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
NumberOfNodes (integer) --
The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint .
AvailabilityZone (string) --
The AWS Availability Zone where this DevEndpoint is located.
VpcId (string) --
The ID of the virtual private cloud (VPC) used by this DevEndpoint .
ExtraPythonLibsS3Path (string) --
The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint . Multiple values must be complete paths separated by a comma.
Note
You can only use pure Python libraries with a DevEndpoint . Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.
ExtraJarsS3Path (string) --
The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint .
Note
You can only use pure Java/Scala libraries with a DevEndpoint .
FailureReason (string) --
The reason for a current failure in this DevEndpoint .
LastUpdateStatus (string) --
The status of the last update.
CreatedTimestamp (datetime) --
The point in time at which this DevEndpoint was created.
LastModifiedTimestamp (datetime) --
The point in time at which this DevEndpoint was last modified.
PublicKey (string) --
The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.
PublicKeys (list) --
A list of public keys to be used by the DevEndpoints for authentication. Using this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.
Note
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint API operation with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this DevEndpoint .
Arguments (dict) --
A map of arguments used to configure the DevEndpoint .
Valid arguments are:
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
NextToken (string) --
A continuation token, if not all DevEndpoint definitions have yet been returned.
Exceptions
Retrieves an existing job definition.
See also: AWS API Documentation
Request Syntax
response = client.get_job(
JobName='string'
)
[REQUIRED]
The name of the job definition to retrieve.
{
'Job': {
'Name': 'string',
'Description': 'string',
'LogUri': 'string',
'Role': 'string',
'CreatedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'ExecutionProperty': {
'MaxConcurrentRuns': 123
},
'Command': {
'Name': 'string',
'ScriptLocation': 'string',
'PythonVersion': 'string'
},
'DefaultArguments': {
'string': 'string'
},
'NonOverridableArguments': {
'string': 'string'
},
'Connections': {
'Connections': [
'string',
]
},
'MaxRetries': 123,
'AllocatedCapacity': 123,
'Timeout': 123,
'MaxCapacity': 123.0,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'NumberOfWorkers': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'GlueVersion': 'string'
}
}
Response Structure
The requested job definition.
The name you assign to this job definition.
A description of the job.
This field is reserved for future use.
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
The time and date that this job definition was created.
The last point in time when this job definition was modified.
An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.
The JobCommand that runs this job.
The name of the job command. For an Apache Spark ETL job, this must be glueetl . For a Python shell job, it must be pythonshell . For an Apache Spark streaming ETL job, this must be gluestreaming .
Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.
The Python version being used to run a Python shell job. Allowed values are 2 or 3.
The default arguments for this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
Non-overridable arguments for this job, specified as name-value pairs.
The connections used for this job.
A list of connections used by the job.
The maximum number of times to retry this job after a JobRun fails.
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Do not set Max Capacity if using WorkerType and NumberOfWorkers .
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity . Instead, you should specify a Worker type and the Number of workers .
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
The name of the SecurityConfiguration structure to be used with this job.
Specifies configuration properties of a job notification.
After a job run starts, the number of minutes to wait before sending a job run delay notification.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
Exceptions
Returns information on a job bookmark entry.
See also: AWS API Documentation
Request Syntax
response = client.get_job_bookmark(
JobName='string',
RunId='string'
)
[REQUIRED]
The name of the job in question.
dict
Response Syntax
{
'JobBookmarkEntry': {
'JobName': 'string',
'Version': 123,
'Run': 123,
'Attempt': 123,
'PreviousRunId': 'string',
'RunId': 'string',
'JobBookmark': 'string'
}
}
Response Structure
(dict) --
JobBookmarkEntry (dict) --
A structure that defines a point that a job can resume processing.
JobName (string) --
The name of the job in question.
Version (integer) --
The version of the job.
Run (integer) --
The run ID number.
Attempt (integer) --
The attempt ID number.
PreviousRunId (string) --
The unique run identifier associated with the previous job run.
RunId (string) --
The run ID number.
JobBookmark (string) --
The bookmark itself.
Exceptions
Retrieves the metadata for a given job run.
See also: AWS API Documentation
Request Syntax
response = client.get_job_run(
JobName='string',
RunId='string',
PredecessorsIncluded=True|False
)
[REQUIRED]
Name of the job definition being run.
[REQUIRED]
The ID of the job run.
dict
Response Syntax
{
'JobRun': {
'Id': 'string',
'Attempt': 123,
'PreviousRunId': 'string',
'TriggerName': 'string',
'JobName': 'string',
'StartedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'Arguments': {
'string': 'string'
},
'ErrorMessage': 'string',
'PredecessorRuns': [
{
'JobName': 'string',
'RunId': 'string'
},
],
'AllocatedCapacity': 123,
'ExecutionTime': 123,
'Timeout': 123,
'MaxCapacity': 123.0,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'NumberOfWorkers': 123,
'SecurityConfiguration': 'string',
'LogGroupName': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'GlueVersion': 'string'
}
}
Response Structure
(dict) --
JobRun (dict) --
The requested job-run metadata.
Id (string) --
The ID of this job run.
Attempt (integer) --
The number of the attempt to run this job.
PreviousRunId (string) --
The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.
TriggerName (string) --
The name of the trigger that started this job run.
JobName (string) --
The name of the job definition being used in this run.
StartedOn (datetime) --
The date and time at which this job run was started.
LastModifiedOn (datetime) --
The last time that this job run was modified.
CompletedOn (datetime) --
The date and time that this job run completed.
JobRunState (string) --
The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses .
Arguments (dict) --
The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
ErrorMessage (string) --
An error message associated with this job run.
PredecessorRuns (list) --
A list of predecessors to this job run.
(dict) --
A job run that was used in the predicate of a conditional trigger that triggered this job run.
JobName (string) --
The name of the job definition used by the predecessor job run.
RunId (string) --
The job-run ID of the predecessor job run.
AllocatedCapacity (integer) --
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
ExecutionTime (integer) --
The amount of time (in seconds) that the job run consumed resources.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
MaxCapacity (float) --
The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Do not set Max Capacity if using WorkerType and NumberOfWorkers .
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:
WorkerType (string) --
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
NumberOfWorkers (integer) --
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this job run.
LogGroupName (string) --
The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
GlueVersion (string) --
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
Exceptions
Retrieves metadata for all runs of a given job definition.
See also: AWS API Documentation
Request Syntax
response = client.get_job_runs(
JobName='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The name of the job definition for which to retrieve all job runs.
dict
Response Syntax
{
'JobRuns': [
{
'Id': 'string',
'Attempt': 123,
'PreviousRunId': 'string',
'TriggerName': 'string',
'JobName': 'string',
'StartedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'Arguments': {
'string': 'string'
},
'ErrorMessage': 'string',
'PredecessorRuns': [
{
'JobName': 'string',
'RunId': 'string'
},
],
'AllocatedCapacity': 123,
'ExecutionTime': 123,
'Timeout': 123,
'MaxCapacity': 123.0,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'NumberOfWorkers': 123,
'SecurityConfiguration': 'string',
'LogGroupName': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'GlueVersion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
JobRuns (list) --
A list of job-run metadata objects.
(dict) --
Contains information about a job run.
Id (string) --
The ID of this job run.
Attempt (integer) --
The number of the attempt to run this job.
PreviousRunId (string) --
The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.
TriggerName (string) --
The name of the trigger that started this job run.
JobName (string) --
The name of the job definition being used in this run.
StartedOn (datetime) --
The date and time at which this job run was started.
LastModifiedOn (datetime) --
The last time that this job run was modified.
CompletedOn (datetime) --
The date and time that this job run completed.
JobRunState (string) --
The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses .
Arguments (dict) --
The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
ErrorMessage (string) --
An error message associated with this job run.
PredecessorRuns (list) --
A list of predecessors to this job run.
(dict) --
A job run that was used in the predicate of a conditional trigger that triggered this job run.
JobName (string) --
The name of the job definition used by the predecessor job run.
RunId (string) --
The job-run ID of the predecessor job run.
AllocatedCapacity (integer) --
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
ExecutionTime (integer) --
The amount of time (in seconds) that the job run consumed resources.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
MaxCapacity (float) --
The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Do not set Max Capacity if using WorkerType and NumberOfWorkers .
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:
WorkerType (string) --
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
NumberOfWorkers (integer) --
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this job run.
LogGroupName (string) --
The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
GlueVersion (string) --
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
NextToken (string) --
A continuation token, if not all requested job runs have been returned.
Exceptions
Retrieves all current job definitions.
See also: AWS API Documentation
Request Syntax
response = client.get_jobs(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Jobs': [
{
'Name': 'string',
'Description': 'string',
'LogUri': 'string',
'Role': 'string',
'CreatedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'ExecutionProperty': {
'MaxConcurrentRuns': 123
},
'Command': {
'Name': 'string',
'ScriptLocation': 'string',
'PythonVersion': 'string'
},
'DefaultArguments': {
'string': 'string'
},
'NonOverridableArguments': {
'string': 'string'
},
'Connections': {
'Connections': [
'string',
]
},
'MaxRetries': 123,
'AllocatedCapacity': 123,
'Timeout': 123,
'MaxCapacity': 123.0,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'NumberOfWorkers': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'GlueVersion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Jobs (list) --
A list of job definitions.
(dict) --
Specifies a job definition.
Name (string) --
The name you assign to this job definition.
Description (string) --
A description of the job.
LogUri (string) --
This field is reserved for future use.
Role (string) --
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
CreatedOn (datetime) --
The time and date that this job definition was created.
LastModifiedOn (datetime) --
The last point in time when this job definition was modified.
ExecutionProperty (dict) --
An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
MaxConcurrentRuns (integer) --
The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.
Command (dict) --
The JobCommand that runs this job.
Name (string) --
The name of the job command. For an Apache Spark ETL job, this must be glueetl . For a Python shell job, it must be pythonshell . For an Apache Spark streaming ETL job, this must be gluestreaming .
ScriptLocation (string) --
Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.
PythonVersion (string) --
The Python version being used to run a Python shell job. Allowed values are 2 or 3.
DefaultArguments (dict) --
The default arguments for this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
NonOverridableArguments (dict) --
Non-overridable arguments for this job, specified as name-value pairs.
Connections (dict) --
The connections used for this job.
Connections (list) --
A list of connections used by the job.
MaxRetries (integer) --
The maximum number of times to retry this job after a JobRun fails.
AllocatedCapacity (integer) --
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Timeout (integer) --
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
MaxCapacity (float) --
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Do not set Max Capacity if using WorkerType and NumberOfWorkers .
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity . Instead, you should specify a Worker type and the Number of workers .
WorkerType (string) --
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
NumberOfWorkers (integer) --
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this job.
NotificationProperty (dict) --
Specifies configuration properties of a job notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
GlueVersion (string) --
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
NextToken (string) --
A continuation token, if not all job definitions have yet been returned.
Exceptions
Creates mappings.
See also: AWS API Documentation
Request Syntax
response = client.get_mapping(
Source={
'DatabaseName': 'string',
'TableName': 'string'
},
Sinks=[
{
'DatabaseName': 'string',
'TableName': 'string'
},
],
Location={
'Jdbc': [
{
'Name': 'string',
'Value': 'string',
'Param': True|False
},
],
'S3': [
{
'Name': 'string',
'Value': 'string',
'Param': True|False
},
],
'DynamoDB': [
{
'Name': 'string',
'Value': 'string',
'Param': True|False
},
]
}
)
[REQUIRED]
Specifies the source table.
The database in which the table metadata resides.
The name of the table in question.
A list of target tables.
Specifies a table definition in the Glue Data Catalog.
The database in which the table metadata resides.
The name of the table in question.
Parameters for the mapping.
A JDBC location.
An argument or property of a node.
The name of the argument or property.
The value of the argument or property.
True if the value is used as a parameter.
An Amazon Simple Storage Service (Amazon S3) location.
An argument or property of a node.
The name of the argument or property.
The value of the argument or property.
True if the value is used as a parameter.
An Amazon DynamoDB table location.
An argument or property of a node.
The name of the argument or property.
The value of the argument or property.
True if the value is used as a parameter.
dict
Response Syntax
{
'Mapping': [
{
'SourceTable': 'string',
'SourcePath': 'string',
'SourceType': 'string',
'TargetTable': 'string',
'TargetPath': 'string',
'TargetType': 'string'
},
]
}
Response Structure
(dict) --
Mapping (list) --
A list of mappings to the specified targets.
(dict) --
Defines a mapping.
SourceTable (string) --
The name of the source table.
SourcePath (string) --
The source path.
SourceType (string) --
The source type.
TargetTable (string) --
The target table.
TargetPath (string) --
The target path.
TargetType (string) --
The target type.
Exceptions
Gets details for a specific task run on a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can check the stats of any task run by calling GetMLTaskRun with the TaskRunID and its parent transform's TransformID .
See also: AWS API Documentation
Request Syntax
response = client.get_ml_task_run(
TransformId='string',
TaskRunId='string'
)
[REQUIRED]
The unique identifier of the machine learning transform.
[REQUIRED]
The unique identifier of the task run.
dict
Response Syntax
{
'TransformId': 'string',
'TaskRunId': 'string',
'Status': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'LogGroupName': 'string',
'Properties': {
'TaskType': 'EVALUATION'|'LABELING_SET_GENERATION'|'IMPORT_LABELS'|'EXPORT_LABELS'|'FIND_MATCHES',
'ImportLabelsTaskRunProperties': {
'InputS3Path': 'string',
'Replace': True|False
},
'ExportLabelsTaskRunProperties': {
'OutputS3Path': 'string'
},
'LabelingSetGenerationTaskRunProperties': {
'OutputS3Path': 'string'
},
'FindMatchesTaskRunProperties': {
'JobId': 'string',
'JobName': 'string',
'JobRunId': 'string'
}
},
'ErrorString': 'string',
'StartedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'ExecutionTime': 123
}
Response Structure
(dict) --
TransformId (string) --
The unique identifier of the task run.
TaskRunId (string) --
The unique run identifier associated with this run.
Status (string) --
The status for this task run.
LogGroupName (string) --
The names of the log groups that are associated with the task run.
Properties (dict) --
The list of properties that are associated with the task run.
TaskType (string) --
The type of task run.
ImportLabelsTaskRunProperties (dict) --
The configuration properties for an importing labels task run.
InputS3Path (string) --
The Amazon Simple Storage Service (Amazon S3) path from where you will import the labels.
Replace (boolean) --
Indicates whether to overwrite your existing labels.
ExportLabelsTaskRunProperties (dict) --
The configuration properties for an exporting labels task run.
OutputS3Path (string) --
The Amazon Simple Storage Service (Amazon S3) path where you will export the labels.
LabelingSetGenerationTaskRunProperties (dict) --
The configuration properties for a labeling set generation task run.
OutputS3Path (string) --
The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling set.
FindMatchesTaskRunProperties (dict) --
The configuration properties for a find matches task run.
JobId (string) --
The job ID for the Find Matches task run.
JobName (string) --
The name assigned to the job for the Find Matches task run.
JobRunId (string) --
The job run ID for the Find Matches task run.
ErrorString (string) --
The error strings that are associated with the task run.
StartedOn (datetime) --
The date and time when this task run started.
LastModifiedOn (datetime) --
The date and time when this task run was last modified.
CompletedOn (datetime) --
The date and time when this task run was completed.
ExecutionTime (integer) --
The amount of time (in seconds) that the task run consumed resources.
Exceptions
Gets a list of runs for a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can get a sortable, filterable list of machine learning task runs by calling GetMLTaskRuns with their parent transform's TransformID and other optional parameters as documented in this section.
This operation returns a list of historic runs and must be paginated.
See also: AWS API Documentation
Request Syntax
response = client.get_ml_task_runs(
TransformId='string',
NextToken='string',
MaxResults=123,
Filter={
'TaskRunType': 'EVALUATION'|'LABELING_SET_GENERATION'|'IMPORT_LABELS'|'EXPORT_LABELS'|'FIND_MATCHES',
'Status': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'StartedBefore': datetime(2015, 1, 1),
'StartedAfter': datetime(2015, 1, 1)
},
Sort={
'Column': 'TASK_RUN_TYPE'|'STATUS'|'STARTED',
'SortDirection': 'DESCENDING'|'ASCENDING'
}
)
[REQUIRED]
The unique identifier of the machine learning transform.
The filter criteria, in the TaskRunFilterCriteria structure, for the task run.
The type of task run.
The current status of the task run.
Filter on task runs started before this date.
Filter on task runs started after this date.
The sorting criteria, in the TaskRunSortCriteria structure, for the task run.
The column to be used to sort the list of task runs for the machine learning transform.
The sort direction to be used to sort the list of task runs for the machine learning transform.
dict
Response Syntax
{
'TaskRuns': [
{
'TransformId': 'string',
'TaskRunId': 'string',
'Status': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'LogGroupName': 'string',
'Properties': {
'TaskType': 'EVALUATION'|'LABELING_SET_GENERATION'|'IMPORT_LABELS'|'EXPORT_LABELS'|'FIND_MATCHES',
'ImportLabelsTaskRunProperties': {
'InputS3Path': 'string',
'Replace': True|False
},
'ExportLabelsTaskRunProperties': {
'OutputS3Path': 'string'
},
'LabelingSetGenerationTaskRunProperties': {
'OutputS3Path': 'string'
},
'FindMatchesTaskRunProperties': {
'JobId': 'string',
'JobName': 'string',
'JobRunId': 'string'
}
},
'ErrorString': 'string',
'StartedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'ExecutionTime': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TaskRuns (list) --
A list of task runs that are associated with the transform.
(dict) --
The sampling parameters that are associated with the machine learning transform.
TransformId (string) --
The unique identifier for the transform.
TaskRunId (string) --
The unique identifier for this task run.
Status (string) --
The current status of the requested task run.
LogGroupName (string) --
The names of the log group for secure logging, associated with this task run.
Properties (dict) --
Specifies configuration properties associated with this task run.
TaskType (string) --
The type of task run.
ImportLabelsTaskRunProperties (dict) --
The configuration properties for an importing labels task run.
InputS3Path (string) --
The Amazon Simple Storage Service (Amazon S3) path from where you will import the labels.
Replace (boolean) --
Indicates whether to overwrite your existing labels.
ExportLabelsTaskRunProperties (dict) --
The configuration properties for an exporting labels task run.
OutputS3Path (string) --
The Amazon Simple Storage Service (Amazon S3) path where you will export the labels.
LabelingSetGenerationTaskRunProperties (dict) --
The configuration properties for a labeling set generation task run.
OutputS3Path (string) --
The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling set.
FindMatchesTaskRunProperties (dict) --
The configuration properties for a find matches task run.
JobId (string) --
The job ID for the Find Matches task run.
JobName (string) --
The name assigned to the job for the Find Matches task run.
JobRunId (string) --
The job run ID for the Find Matches task run.
ErrorString (string) --
The list of error strings associated with this task run.
StartedOn (datetime) --
The date and time that this task run started.
LastModifiedOn (datetime) --
The last point in time that the requested task run was updated.
CompletedOn (datetime) --
The last point in time that the requested task run was completed.
ExecutionTime (integer) --
The amount of time (in seconds) that the task run consumed resources.
NextToken (string) --
A pagination token, if more results are available.
Exceptions
Gets an Glue machine learning transform artifact and all its corresponding metadata. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. You can retrieve their metadata by calling GetMLTransform .
See also: AWS API Documentation
Request Syntax
response = client.get_ml_transform(
TransformId='string'
)
[REQUIRED]
The unique identifier of the transform, generated at the time that the transform was created.
{
'TransformId': 'string',
'Name': 'string',
'Description': 'string',
'Status': 'NOT_READY'|'READY'|'DELETING',
'CreatedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'InputRecordTables': [
{
'DatabaseName': 'string',
'TableName': 'string',
'CatalogId': 'string',
'ConnectionName': 'string'
},
],
'Parameters': {
'TransformType': 'FIND_MATCHES',
'FindMatchesParameters': {
'PrimaryKeyColumnName': 'string',
'PrecisionRecallTradeoff': 123.0,
'AccuracyCostTradeoff': 123.0,
'EnforceProvidedLabels': True|False
}
},
'EvaluationMetrics': {
'TransformType': 'FIND_MATCHES',
'FindMatchesMetrics': {
'AreaUnderPRCurve': 123.0,
'Precision': 123.0,
'Recall': 123.0,
'F1': 123.0,
'ConfusionMatrix': {
'NumTruePositives': 123,
'NumFalsePositives': 123,
'NumTrueNegatives': 123,
'NumFalseNegatives': 123
},
'ColumnImportances': [
{
'ColumnName': 'string',
'Importance': 123.0
},
]
}
},
'LabelCount': 123,
'Schema': [
{
'Name': 'string',
'DataType': 'string'
},
],
'Role': 'string',
'GlueVersion': 'string',
'MaxCapacity': 123.0,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'NumberOfWorkers': 123,
'Timeout': 123,
'MaxRetries': 123,
'TransformEncryption': {
'MlUserDataEncryption': {
'MlUserDataEncryptionMode': 'DISABLED'|'SSE-KMS',
'KmsKeyId': 'string'
},
'TaskRunSecurityConfigurationName': 'string'
}
}
Response Structure
The unique identifier of the transform, generated at the time that the transform was created.
The unique name given to the transform when it was created.
A description of the transform.
The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".
The date and time when the transform was created.
The date and time when the transform was last modified.
A list of Glue table definitions used by the transform.
The database and table in the Glue Data Catalog that is used for input or output data.
A database name in the Glue Data Catalog.
A table name in the Glue Data Catalog.
A unique identifier for the Glue Data Catalog.
The name of the connection to the Glue Data Catalog.
The configuration parameters that are specific to the algorithm used.
The type of machine learning transform.
For information about the types of machine learning transforms, see Creating Machine Learning Transforms .
The parameters for the find matches algorithm.
The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.
The precision metric indicates how often your model is correct when it predicts a match.
The recall metric indicates that for an actual match, how often your model predicts the match.
The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate FindMatches transform, sometimes with unacceptable accuracy.
Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
Cost measures how many compute resources, and thus money, are consumed to run the transform.
The value to switch on or off to force the output to match the provided labels from users. If the value is True , the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False , the find matches transform does not ensure all the labels provided are respected, and the results rely on the trained model.
Note that setting this value to true may increase the conflation execution time.
The latest evaluation metrics.
The type of machine learning transform.
The evaluation metrics for the find matches algorithm.
The area under the precision/recall curve (AUPRC) is a single number measuring the overall quality of the transform, that is independent of the choice made for precision vs. recall. Higher values indicate that you have a more attractive precision vs. recall tradeoff.
For more information, see Precision and recall in Wikipedia.
The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.
For more information, see Precision and recall in Wikipedia.
The recall metric indicates that for an actual match, how often your transform predicts the match. Specifically, it measures how well the transform finds true positives from the total records in the source data.
For more information, see Precision and recall in Wikipedia.
The maximum F1 metric indicates the transform's accuracy between 0 and 1, where 1 is the best accuracy.
For more information, see F1 score in Wikipedia.
The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
For more information, see Confusion matrix in Wikipedia.
The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.
The number of nonmatches in the data that the transform incorrectly classified as a match, in the confusion matrix for your transform.
The number of nonmatches in the data that the transform correctly rejected, in the confusion matrix for your transform.
The number of matches in the data that the transform didn't find, in the confusion matrix for your transform.
A list of ColumnImportance structures containing column importance metrics, sorted in order of descending importance.
A structure containing the column name and column importance score for a column.
Column importance helps you understand how columns contribute to your model, by identifying which columns in your records are more important than others.
The name of a column.
The column importance score for the column, as a decimal.
The number of labels available for this transform.
The Map<Column, Type> object that represents the schema that this transform accepts. Has an upper bound of 100 columns.
A key-value pair representing a column and data type that this transform can run against. The Schema parameter of the MLTransform may contain up to 100 of these structures.
The name of the column.
The type of data in the column.
The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
When the WorkerType field is set to a value other than Standard , the MaxCapacity field is set automatically and becomes read-only.
The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
The number of workers of a defined workerType that are allocated when this task runs.
The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The maximum number of times to retry a task for this transform after a task run fails.
The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
An MLUserDataEncryption object containing the encryption mode and customer-provided KMS key ID.
The encryption mode applied to user data. Valid values are:
The ID for the customer-provided KMS key.
The name of the security configuration.
Exceptions
Gets a sortable, filterable list of existing Glue machine learning transforms. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue, and you can retrieve their metadata by calling GetMLTransforms .
See also: AWS API Documentation
Request Syntax
response = client.get_ml_transforms(
NextToken='string',
MaxResults=123,
Filter={
'Name': 'string',
'TransformType': 'FIND_MATCHES',
'Status': 'NOT_READY'|'READY'|'DELETING',
'GlueVersion': 'string',
'CreatedBefore': datetime(2015, 1, 1),
'CreatedAfter': datetime(2015, 1, 1),
'LastModifiedBefore': datetime(2015, 1, 1),
'LastModifiedAfter': datetime(2015, 1, 1),
'Schema': [
{
'Name': 'string',
'DataType': 'string'
},
]
},
Sort={
'Column': 'NAME'|'TRANSFORM_TYPE'|'STATUS'|'CREATED'|'LAST_MODIFIED',
'SortDirection': 'DESCENDING'|'ASCENDING'
}
)
The filter transformation criteria.
A unique transform name that is used to filter the machine learning transforms.
The type of machine learning transform that is used to filter the machine learning transforms.
Filters the list of machine learning transforms by the last known status of the transforms (to indicate whether a transform can be used or not). One of "NOT_READY", "READY", or "DELETING".
This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
The time and date before which the transforms were created.
The time and date after which the transforms were created.
Filter on transforms last modified before this date.
Filter on transforms last modified after this date.
Filters on datasets with a specific schema. The Map<Column, Type> object is an array of key-value pairs representing the schema this transform accepts, where Column is the name of a column, and Type is the type of the data such as an integer or string. Has an upper bound of 100 columns.
A key-value pair representing a column and data type that this transform can run against. The Schema parameter of the MLTransform may contain up to 100 of these structures.
The name of the column.
The type of data in the column.
The sorting criteria.
The column to be used in the sorting criteria that are associated with the machine learning transform.
The sort direction to be used in the sorting criteria that are associated with the machine learning transform.
dict
Response Syntax
{
'Transforms': [
{
'TransformId': 'string',
'Name': 'string',
'Description': 'string',
'Status': 'NOT_READY'|'READY'|'DELETING',
'CreatedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'InputRecordTables': [
{
'DatabaseName': 'string',
'TableName': 'string',
'CatalogId': 'string',
'ConnectionName': 'string'
},
],
'Parameters': {
'TransformType': 'FIND_MATCHES',
'FindMatchesParameters': {
'PrimaryKeyColumnName': 'string',
'PrecisionRecallTradeoff': 123.0,
'AccuracyCostTradeoff': 123.0,
'EnforceProvidedLabels': True|False
}
},
'EvaluationMetrics': {
'TransformType': 'FIND_MATCHES',
'FindMatchesMetrics': {
'AreaUnderPRCurve': 123.0,
'Precision': 123.0,
'Recall': 123.0,
'F1': 123.0,
'ConfusionMatrix': {
'NumTruePositives': 123,
'NumFalsePositives': 123,
'NumTrueNegatives': 123,
'NumFalseNegatives': 123
},
'ColumnImportances': [
{
'ColumnName': 'string',
'Importance': 123.0
},
]
}
},
'LabelCount': 123,
'Schema': [
{
'Name': 'string',
'DataType': 'string'
},
],
'Role': 'string',
'GlueVersion': 'string',
'MaxCapacity': 123.0,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'NumberOfWorkers': 123,
'Timeout': 123,
'MaxRetries': 123,
'TransformEncryption': {
'MlUserDataEncryption': {
'MlUserDataEncryptionMode': 'DISABLED'|'SSE-KMS',
'KmsKeyId': 'string'
},
'TaskRunSecurityConfigurationName': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Transforms (list) --
A list of machine learning transforms.
(dict) --
A structure for a machine learning transform.
TransformId (string) --
The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.
Name (string) --
A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.
Description (string) --
A user-defined, long-form description text for the machine learning transform. Descriptions are not guaranteed to be unique and can be changed at any time.
Status (string) --
The current status of the machine learning transform.
CreatedOn (datetime) --
A timestamp. The time and date that this machine learning transform was created.
LastModifiedOn (datetime) --
A timestamp. The last point in time when this machine learning transform was modified.
InputRecordTables (list) --
A list of Glue table definitions used by the transform.
(dict) --
The database and table in the Glue Data Catalog that is used for input or output data.
DatabaseName (string) --
A database name in the Glue Data Catalog.
TableName (string) --
A table name in the Glue Data Catalog.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
ConnectionName (string) --
The name of the connection to the Glue Data Catalog.
Parameters (dict) --
A TransformParameters object. You can use parameters to tune (customize) the behavior of the machine learning transform by specifying what data it learns from and your preference on various tradeoffs (such as precious vs. recall, or accuracy vs. cost).
TransformType (string) --
The type of machine learning transform.
For information about the types of machine learning transforms, see Creating Machine Learning Transforms .
FindMatchesParameters (dict) --
The parameters for the find matches algorithm.
PrimaryKeyColumnName (string) --
The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
PrecisionRecallTradeoff (float) --
The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.
The precision metric indicates how often your model is correct when it predicts a match.
The recall metric indicates that for an actual match, how often your model predicts the match.
AccuracyCostTradeoff (float) --
The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate FindMatches transform, sometimes with unacceptable accuracy.
Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
Cost measures how many compute resources, and thus money, are consumed to run the transform.
EnforceProvidedLabels (boolean) --
The value to switch on or off to force the output to match the provided labels from users. If the value is True , the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False , the find matches transform does not ensure all the labels provided are respected, and the results rely on the trained model.
Note that setting this value to true may increase the conflation execution time.
EvaluationMetrics (dict) --
An EvaluationMetrics object. Evaluation metrics provide an estimate of the quality of your machine learning transform.
TransformType (string) --
The type of machine learning transform.
FindMatchesMetrics (dict) --
The evaluation metrics for the find matches algorithm.
AreaUnderPRCurve (float) --
The area under the precision/recall curve (AUPRC) is a single number measuring the overall quality of the transform, that is independent of the choice made for precision vs. recall. Higher values indicate that you have a more attractive precision vs. recall tradeoff.
For more information, see Precision and recall in Wikipedia.
Precision (float) --
The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.
For more information, see Precision and recall in Wikipedia.
Recall (float) --
The recall metric indicates that for an actual match, how often your transform predicts the match. Specifically, it measures how well the transform finds true positives from the total records in the source data.
For more information, see Precision and recall in Wikipedia.
F1 (float) --
The maximum F1 metric indicates the transform's accuracy between 0 and 1, where 1 is the best accuracy.
For more information, see F1 score in Wikipedia.
ConfusionMatrix (dict) --
The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
For more information, see Confusion matrix in Wikipedia.
NumTruePositives (integer) --
The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.
NumFalsePositives (integer) --
The number of nonmatches in the data that the transform incorrectly classified as a match, in the confusion matrix for your transform.
NumTrueNegatives (integer) --
The number of nonmatches in the data that the transform correctly rejected, in the confusion matrix for your transform.
NumFalseNegatives (integer) --
The number of matches in the data that the transform didn't find, in the confusion matrix for your transform.
ColumnImportances (list) --
A list of ColumnImportance structures containing column importance metrics, sorted in order of descending importance.
(dict) --
A structure containing the column name and column importance score for a column.
Column importance helps you understand how columns contribute to your model, by identifying which columns in your records are more important than others.
ColumnName (string) --
The name of a column.
Importance (float) --
The column importance score for the column, as a decimal.
LabelCount (integer) --
A count identifier for the labeling files generated by Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.
Schema (list) --
A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.
(dict) --
A key-value pair representing a column and data type that this transform can run against. The Schema parameter of the MLTransform may contain up to 100 of these structures.
Name (string) --
The name of the column.
DataType (string) --
The type of data in the column.
Role (string) --
The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
GlueVersion (string) --
This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
MaxCapacity (float) --
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType .
When the WorkerType field is set to a value other than Standard , the MaxCapacity field is set automatically and becomes read-only.
WorkerType (string) --
The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X.
MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType .
NumberOfWorkers (integer) --
The number of workers of a defined workerType that are allocated when a task of the transform runs.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
Timeout (integer) --
The timeout in minutes of the machine learning transform.
MaxRetries (integer) --
The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.
TransformEncryption (dict) --
The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
MlUserDataEncryption (dict) --
An MLUserDataEncryption object containing the encryption mode and customer-provided KMS key ID.
MlUserDataEncryptionMode (string) --
The encryption mode applied to user data. Valid values are:
KmsKeyId (string) --
The ID for the customer-provided KMS key.
TaskRunSecurityConfigurationName (string) --
The name of the security configuration.
NextToken (string) --
A pagination token, if more results are available.
Exceptions
Create a paginator for an operation.
Retrieves information about a specified partition.
See also: AWS API Documentation
Request Syntax
response = client.get_partition(
CatalogId='string',
DatabaseName='string',
TableName='string',
PartitionValues=[
'string',
]
)
[REQUIRED]
The name of the catalog database where the partition resides.
[REQUIRED]
The name of the partition's table.
[REQUIRED]
The values that define the partition.
dict
Response Syntax
{
'Partition': {
'Values': [
'string',
],
'DatabaseName': 'string',
'TableName': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'Parameters': {
'string': 'string'
},
'LastAnalyzedTime': datetime(2015, 1, 1),
'CatalogId': 'string'
}
}
Response Structure
(dict) --
Partition (dict) --
The requested information, in the form of a Partition object.
Values (list) --
The values of the partition.
DatabaseName (string) --
The name of the catalog database in which to create the partition.
TableName (string) --
The name of the database table in which to create the partition.
CreationTime (datetime) --
The time at which the partition was created.
LastAccessTime (datetime) --
The last time at which the partition was accessed.
StorageDescriptor (dict) --
Provides information about the physical location where the partition is stored.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
Parameters (dict) --
The user-supplied properties in key-value form.
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
Parameters (dict) --
These key-value pairs define partition parameters.
LastAnalyzedTime (datetime) --
The last time at which column statistics were computed for this partition.
CatalogId (string) --
The ID of the Data Catalog in which the partition resides.
Exceptions
Retrieves the partition indexes associated with a table.
See also: AWS API Documentation
Request Syntax
response = client.get_partition_indexes(
CatalogId='string',
DatabaseName='string',
TableName='string',
NextToken='string'
)
[REQUIRED]
Specifies the name of a database from which you want to retrieve partition indexes.
[REQUIRED]
Specifies the name of a table for which you want to retrieve the partition indexes.
dict
Response Syntax
{
'PartitionIndexDescriptorList': [
{
'IndexName': 'string',
'Keys': [
{
'Name': 'string',
'Type': 'string'
},
],
'IndexStatus': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
'BackfillErrors': [
{
'Code': 'ENCRYPTED_PARTITION_ERROR'|'INTERNAL_ERROR'|'INVALID_PARTITION_TYPE_DATA_ERROR'|'MISSING_PARTITION_VALUE_ERROR'|'UNSUPPORTED_PARTITION_CHARACTER_ERROR',
'Partitions': [
{
'Values': [
'string',
]
},
]
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PartitionIndexDescriptorList (list) --
A list of index descriptors.
(dict) --
A descriptor for a partition index in a table.
IndexName (string) --
The name of the partition index.
Keys (list) --
A list of one or more keys, as KeySchemaElement structures, for the partition index.
(dict) --
A partition key pair consisting of a name and a type.
Name (string) --
The name of a partition key.
Type (string) --
The type of a partition key.
IndexStatus (string) --
The status of the partition index.
The possible statuses are:
BackfillErrors (list) --
A list of errors that can occur when registering partition indexes for an existing table.
(dict) --
A list of errors that can occur when registering partition indexes for an existing table.
These errors give the details about why an index registration failed and provide a limited number of partitions in the response, so that you can fix the partitions at fault and try registering the index again. The most common set of errors that can occur are categorized as follows:
Code (string) --
The error code for an error that occurred when registering partition indexes for an existing table.
Partitions (list) --
A list of a limited number of partitions in the response.
(dict) --
Contains a list of values defining partitions.
Values (list) --
The list of values.
NextToken (string) --
A continuation token, present if the current list segment is not the last.
Exceptions
Retrieves information about the partitions in a table.
See also: AWS API Documentation
Request Syntax
response = client.get_partitions(
CatalogId='string',
DatabaseName='string',
TableName='string',
Expression='string',
NextToken='string',
Segment={
'SegmentNumber': 123,
'TotalSegments': 123
},
MaxResults=123,
ExcludeColumnSchema=True|False
)
[REQUIRED]
The name of the catalog database where the partitions reside.
[REQUIRED]
The name of the partitions' table.
An expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser JSQLParser parses the expression.
Operators : The following are the operators that you can use in the Expression API call:=
Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume 'variable a' holds 10 and 'variable b' holds 20.
(a = b) is not true.
< >
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
>
Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
<
Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
>=
Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a >= b) is not true.
<=
Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a <= b) is true.
AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL
Logical operators.
Supported Partition Key Types : The following are the supported partition keys.
If an type is encountered that is not valid, an exception is thrown.
The following list shows the valid operators on each type. When you define a crawler, the partitionKey type is created as a STRING , to be compatible with the catalog partitions.
Sample API Call :
The segment of the table's partitions to scan in this request.
The zero-based index number of the segment. For example, if the total number of segments is 4, SegmentNumber values range from 0 through 3.
The total number of segments.
dict
Response Syntax
{
'Partitions': [
{
'Values': [
'string',
],
'DatabaseName': 'string',
'TableName': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'Parameters': {
'string': 'string'
},
'LastAnalyzedTime': datetime(2015, 1, 1),
'CatalogId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Partitions (list) --
A list of requested partitions.
(dict) --
Represents a slice of table data.
Values (list) --
The values of the partition.
DatabaseName (string) --
The name of the catalog database in which to create the partition.
TableName (string) --
The name of the database table in which to create the partition.
CreationTime (datetime) --
The time at which the partition was created.
LastAccessTime (datetime) --
The last time at which the partition was accessed.
StorageDescriptor (dict) --
Provides information about the physical location where the partition is stored.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
Parameters (dict) --
The user-supplied properties in key-value form.
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
Parameters (dict) --
These key-value pairs define partition parameters.
LastAnalyzedTime (datetime) --
The last time at which column statistics were computed for this partition.
CatalogId (string) --
The ID of the Data Catalog in which the partition resides.
NextToken (string) --
A continuation token, if the returned list of partitions does not include the last one.
Exceptions
Gets code to perform a specified mapping.
See also: AWS API Documentation
Request Syntax
response = client.get_plan(
Mapping=[
{
'SourceTable': 'string',
'SourcePath': 'string',
'SourceType': 'string',
'TargetTable': 'string',
'TargetPath': 'string',
'TargetType': 'string'
},
],
Source={
'DatabaseName': 'string',
'TableName': 'string'
},
Sinks=[
{
'DatabaseName': 'string',
'TableName': 'string'
},
],
Location={
'Jdbc': [
{
'Name': 'string',
'Value': 'string',
'Param': True|False
},
],
'S3': [
{
'Name': 'string',
'Value': 'string',
'Param': True|False
},
],
'DynamoDB': [
{
'Name': 'string',
'Value': 'string',
'Param': True|False
},
]
},
Language='PYTHON'|'SCALA',
AdditionalPlanOptionsMap={
'string': 'string'
}
)
[REQUIRED]
The list of mappings from a source table to target tables.
Defines a mapping.
The name of the source table.
The source path.
The source type.
The target table.
The target path.
The target type.
[REQUIRED]
The source table.
The database in which the table metadata resides.
The name of the table in question.
The target tables.
Specifies a table definition in the Glue Data Catalog.
The database in which the table metadata resides.
The name of the table in question.
The parameters for the mapping.
A JDBC location.
An argument or property of a node.
The name of the argument or property.
The value of the argument or property.
True if the value is used as a parameter.
An Amazon Simple Storage Service (Amazon S3) location.
An argument or property of a node.
The name of the argument or property.
The value of the argument or property.
True if the value is used as a parameter.
An Amazon DynamoDB table location.
An argument or property of a node.
The name of the argument or property.
The value of the argument or property.
True if the value is used as a parameter.
A map to hold additional optional key-value parameters.
Currently, these key-value pairs are supported:
dict
Response Syntax
{
'PythonScript': 'string',
'ScalaCode': 'string'
}
Response Structure
(dict) --
PythonScript (string) --
A Python script to perform the mapping.
ScalaCode (string) --
The Scala code to perform the mapping.
Exceptions
Describes the specified registry in detail.
See also: AWS API Documentation
Request Syntax
response = client.get_registry(
RegistryId={
'RegistryName': 'string',
'RegistryArn': 'string'
}
)
[REQUIRED]
This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
Name of the registry. Used only for lookup. One of RegistryArn or RegistryName has to be provided.
Arn of the registry to be updated. One of RegistryArn or RegistryName has to be provided.
{
'RegistryName': 'string',
'RegistryArn': 'string',
'Description': 'string',
'Status': 'AVAILABLE'|'DELETING',
'CreatedTime': 'string',
'UpdatedTime': 'string'
}
Response Structure
The name of the registry.
The Amazon Resource Name (ARN) of the registry.
A description of the registry.
The status of the registry.
The date and time the registry was created.
The date and time the registry was updated.
Exceptions
Retrieves the resource policies set on individual resources by Resource Access Manager during cross-account permission grants. Also retrieves the Data Catalog resource policy.
If you enabled metadata encryption in Data Catalog settings, and you do not have permission on the KMS key, the operation can't return the Data Catalog resource policy.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_policies(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'GetResourcePoliciesResponseList': [
{
'PolicyInJson': 'string',
'PolicyHash': 'string',
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
GetResourcePoliciesResponseList (list) --
A list of the individual resource policies and the account-level resource policy.
(dict) --
A structure for returning a resource policy.
PolicyInJson (string) --
Contains the requested policy document, in JSON format.
PolicyHash (string) --
Contains the hash value associated with this policy.
CreateTime (datetime) --
The date and time at which the policy was created.
UpdateTime (datetime) --
The date and time at which the policy was last updated.
NextToken (string) --
A continuation token, if the returned list does not contain the last resource policy available.
Exceptions
Retrieves a specified resource policy.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_policy(
ResourceArn='string'
)
{
'PolicyInJson': 'string',
'PolicyHash': 'string',
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
Contains the requested policy document, in JSON format.
Contains the hash value associated with this policy.
The date and time at which the policy was created.
The date and time at which the policy was last updated.
Exceptions
Describes the specified schema in detail.
See also: AWS API Documentation
Request Syntax
response = client.get_schema(
SchemaId={
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
}
)
[REQUIRED]
This is a wrapper structure to contain schema identity fields. The structure contains:
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
{
'RegistryName': 'string',
'RegistryArn': 'string',
'SchemaName': 'string',
'SchemaArn': 'string',
'Description': 'string',
'DataFormat': 'AVRO'|'JSON',
'Compatibility': 'NONE'|'DISABLED'|'BACKWARD'|'BACKWARD_ALL'|'FORWARD'|'FORWARD_ALL'|'FULL'|'FULL_ALL',
'SchemaCheckpoint': 123,
'LatestSchemaVersion': 123,
'NextSchemaVersion': 123,
'SchemaStatus': 'AVAILABLE'|'PENDING'|'DELETING',
'CreatedTime': 'string',
'UpdatedTime': 'string'
}
Response Structure
The name of the registry.
The Amazon Resource Name (ARN) of the registry.
The name of the schema.
The Amazon Resource Name (ARN) of the schema.
A description of schema if specified when created
The data format of the schema definition. Currently AVRO and JSON are supported.
The compatibility mode of the schema.
The version number of the checkpoint (the last time the compatibility mode was changed).
The latest version of the schema associated with the returned schema definition.
The next version of the schema associated with the returned schema definition.
The status of the schema.
The date and time the schema was created.
The date and time the schema was updated.
Exceptions
Retrieves a schema by the SchemaDefinition . The schema definition is sent to the Schema Registry, canonicalized, and hashed. If the hash is matched within the scope of the SchemaName or ARN (or the default registry, if none is supplied), that schema’s metadata is returned. Otherwise, a 404 or NotFound error is returned. Schema versions in Deleted statuses will not be included in the results.
See also: AWS API Documentation
Request Syntax
response = client.get_schema_by_definition(
SchemaId={
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
SchemaDefinition='string'
)
[REQUIRED]
This is a wrapper structure to contain schema identity fields. The structure contains:
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
[REQUIRED]
The definition of the schema for which schema details are required.
dict
Response Syntax
{
'SchemaVersionId': 'string',
'SchemaArn': 'string',
'DataFormat': 'AVRO'|'JSON',
'Status': 'AVAILABLE'|'PENDING'|'FAILURE'|'DELETING',
'CreatedTime': 'string'
}
Response Structure
(dict) --
SchemaVersionId (string) --
The schema ID of the schema version.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema.
DataFormat (string) --
The data format of the schema definition. Currently only AVRO and JSON are supported.
Status (string) --
The status of the schema version.
CreatedTime (string) --
The date and time the schema was created.
Exceptions
Get the specified schema by its unique ID assigned when a version of the schema is created or registered. Schema versions in Deleted status will not be included in the results.
See also: AWS API Documentation
Request Syntax
response = client.get_schema_version(
SchemaId={
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
SchemaVersionId='string',
SchemaVersionNumber={
'LatestVersion': True|False,
'VersionNumber': 123
}
)
This is a wrapper structure to contain schema identity fields. The structure contains:
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
The version number of the schema.
The latest version available for the schema.
The version number of the schema.
dict
Response Syntax
{
'SchemaVersionId': 'string',
'SchemaDefinition': 'string',
'DataFormat': 'AVRO'|'JSON',
'SchemaArn': 'string',
'VersionNumber': 123,
'Status': 'AVAILABLE'|'PENDING'|'FAILURE'|'DELETING',
'CreatedTime': 'string'
}
Response Structure
(dict) --
SchemaVersionId (string) --
The SchemaVersionId of the schema version.
SchemaDefinition (string) --
The schema definition for the schema ID.
DataFormat (string) --
The data format of the schema definition. Currently AVRO and JSON are supported.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema.
VersionNumber (integer) --
The version number of the schema.
Status (string) --
The status of the schema version.
CreatedTime (string) --
The date and time the schema version was created.
Exceptions
Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry.
This API allows you to compare two schema versions between two schema definitions under the same schema.
See also: AWS API Documentation
Request Syntax
response = client.get_schema_versions_diff(
SchemaId={
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
FirstSchemaVersionNumber={
'LatestVersion': True|False,
'VersionNumber': 123
},
SecondSchemaVersionNumber={
'LatestVersion': True|False,
'VersionNumber': 123
},
SchemaDiffType='SYNTAX_DIFF'
)
[REQUIRED]
This is a wrapper structure to contain schema identity fields. The structure contains:
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
[REQUIRED]
The first of the two schema versions to be compared.
The latest version available for the schema.
The version number of the schema.
[REQUIRED]
The second of the two schema versions to be compared.
The latest version available for the schema.
The version number of the schema.
[REQUIRED]
Refers to SYNTAX_DIFF , which is the currently supported diff type.
dict
Response Syntax
{
'Diff': 'string'
}
Response Structure
(dict) --
Diff (string) --
The difference between schemas as a string in JsonPatch format.
Exceptions
Retrieves a specified security configuration.
See also: AWS API Documentation
Request Syntax
response = client.get_security_configuration(
Name='string'
)
[REQUIRED]
The name of the security configuration to retrieve.
{
'SecurityConfiguration': {
'Name': 'string',
'CreatedTimeStamp': datetime(2015, 1, 1),
'EncryptionConfiguration': {
'S3Encryption': [
{
'S3EncryptionMode': 'DISABLED'|'SSE-KMS'|'SSE-S3',
'KmsKeyArn': 'string'
},
],
'CloudWatchEncryption': {
'CloudWatchEncryptionMode': 'DISABLED'|'SSE-KMS',
'KmsKeyArn': 'string'
},
'JobBookmarksEncryption': {
'JobBookmarksEncryptionMode': 'DISABLED'|'CSE-KMS',
'KmsKeyArn': 'string'
}
}
}
}
Response Structure
The requested security configuration.
The name of the security configuration.
The time at which this security configuration was created.
The encryption configuration associated with this security configuration.
The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.
Specifies how Amazon Simple Storage Service (Amazon S3) data should be encrypted.
The encryption mode to use for Amazon S3 data.
The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
The encryption configuration for Amazon CloudWatch.
The encryption mode to use for CloudWatch data.
The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
The encryption configuration for job bookmarks.
The encryption mode to use for job bookmarks data.
The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
Exceptions
Retrieves a list of all security configurations.
See also: AWS API Documentation
Request Syntax
response = client.get_security_configurations(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'SecurityConfigurations': [
{
'Name': 'string',
'CreatedTimeStamp': datetime(2015, 1, 1),
'EncryptionConfiguration': {
'S3Encryption': [
{
'S3EncryptionMode': 'DISABLED'|'SSE-KMS'|'SSE-S3',
'KmsKeyArn': 'string'
},
],
'CloudWatchEncryption': {
'CloudWatchEncryptionMode': 'DISABLED'|'SSE-KMS',
'KmsKeyArn': 'string'
},
'JobBookmarksEncryption': {
'JobBookmarksEncryptionMode': 'DISABLED'|'CSE-KMS',
'KmsKeyArn': 'string'
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SecurityConfigurations (list) --
A list of security configurations.
(dict) --
Specifies a security configuration.
Name (string) --
The name of the security configuration.
CreatedTimeStamp (datetime) --
The time at which this security configuration was created.
EncryptionConfiguration (dict) --
The encryption configuration associated with this security configuration.
S3Encryption (list) --
The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.
(dict) --
Specifies how Amazon Simple Storage Service (Amazon S3) data should be encrypted.
S3EncryptionMode (string) --
The encryption mode to use for Amazon S3 data.
KmsKeyArn (string) --
The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
CloudWatchEncryption (dict) --
The encryption configuration for Amazon CloudWatch.
CloudWatchEncryptionMode (string) --
The encryption mode to use for CloudWatch data.
KmsKeyArn (string) --
The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
JobBookmarksEncryption (dict) --
The encryption configuration for job bookmarks.
JobBookmarksEncryptionMode (string) --
The encryption mode to use for job bookmarks data.
KmsKeyArn (string) --
The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
NextToken (string) --
A continuation token, if there are more security configurations to return.
Exceptions
Retrieves the Table definition in a Data Catalog for a specified table.
See also: AWS API Documentation
Request Syntax
response = client.get_table(
CatalogId='string',
DatabaseName='string',
Name='string'
)
[REQUIRED]
The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
[REQUIRED]
The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.
dict
Response Syntax
{
'Table': {
'Name': 'string',
'DatabaseName': 'string',
'Description': 'string',
'Owner': 'string',
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'CreatedBy': 'string',
'IsRegisteredWithLakeFormation': True|False,
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string'
},
'CatalogId': 'string'
}
}
Response Structure
(dict) --
Table (dict) --
The Table object that defines the specified table.
Name (string) --
The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName (string) --
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description (string) --
A description of the table.
Owner (string) --
The owner of the table.
CreateTime (datetime) --
The time when the table definition was created in the Data Catalog.
UpdateTime (datetime) --
The last time that the table was updated.
LastAccessTime (datetime) --
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime (datetime) --
The last time that column statistics were computed for this table.
Retention (integer) --
The retention time for this table.
StorageDescriptor (dict) --
A storage descriptor containing information about the physical storage of this table.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
Parameters (dict) --
The user-supplied properties in key-value form.
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
PartitionKeys (list) --
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": []
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
ViewOriginalText (string) --
If the table is a view, the original text of the view; otherwise null .
ViewExpandedText (string) --
If the table is a view, the expanded text of the view; otherwise null .
TableType (string) --
The type of this table (EXTERNAL_TABLE , VIRTUAL_VIEW , etc.).
Parameters (dict) --
These key-value pairs define properties associated with the table.
CreatedBy (string) --
The person or entity who created the table.
IsRegisteredWithLakeFormation (boolean) --
Indicates whether the table has been registered with Lake Formation.
TargetTable (dict) --
A TableIdentifier structure that describes a target table for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
DatabaseName (string) --
The name of the catalog database that contains the target table.
Name (string) --
The name of the target table.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
Exceptions
Retrieves a specified version of a table.
See also: AWS API Documentation
Request Syntax
response = client.get_table_version(
CatalogId='string',
DatabaseName='string',
TableName='string',
VersionId='string'
)
[REQUIRED]
The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
[REQUIRED]
The name of the table. For Hive compatibility, this name is entirely lowercase.
dict
Response Syntax
{
'TableVersion': {
'Table': {
'Name': 'string',
'DatabaseName': 'string',
'Description': 'string',
'Owner': 'string',
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'CreatedBy': 'string',
'IsRegisteredWithLakeFormation': True|False,
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string'
},
'CatalogId': 'string'
},
'VersionId': 'string'
}
}
Response Structure
(dict) --
TableVersion (dict) --
The requested table version.
Table (dict) --
The table in question.
Name (string) --
The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName (string) --
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description (string) --
A description of the table.
Owner (string) --
The owner of the table.
CreateTime (datetime) --
The time when the table definition was created in the Data Catalog.
UpdateTime (datetime) --
The last time that the table was updated.
LastAccessTime (datetime) --
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime (datetime) --
The last time that column statistics were computed for this table.
Retention (integer) --
The retention time for this table.
StorageDescriptor (dict) --
A storage descriptor containing information about the physical storage of this table.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
Parameters (dict) --
The user-supplied properties in key-value form.
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
PartitionKeys (list) --
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": []
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
ViewOriginalText (string) --
If the table is a view, the original text of the view; otherwise null .
ViewExpandedText (string) --
If the table is a view, the expanded text of the view; otherwise null .
TableType (string) --
The type of this table (EXTERNAL_TABLE , VIRTUAL_VIEW , etc.).
Parameters (dict) --
These key-value pairs define properties associated with the table.
CreatedBy (string) --
The person or entity who created the table.
IsRegisteredWithLakeFormation (boolean) --
Indicates whether the table has been registered with Lake Formation.
TargetTable (dict) --
A TableIdentifier structure that describes a target table for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
DatabaseName (string) --
The name of the catalog database that contains the target table.
Name (string) --
The name of the target table.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
VersionId (string) --
The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1.
Exceptions
Retrieves a list of strings that identify available versions of a specified table.
See also: AWS API Documentation
Request Syntax
response = client.get_table_versions(
CatalogId='string',
DatabaseName='string',
TableName='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
[REQUIRED]
The name of the table. For Hive compatibility, this name is entirely lowercase.
dict
Response Syntax
{
'TableVersions': [
{
'Table': {
'Name': 'string',
'DatabaseName': 'string',
'Description': 'string',
'Owner': 'string',
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'CreatedBy': 'string',
'IsRegisteredWithLakeFormation': True|False,
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string'
},
'CatalogId': 'string'
},
'VersionId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TableVersions (list) --
A list of strings identifying available versions of the specified table.
(dict) --
Specifies a version of a table.
Table (dict) --
The table in question.
Name (string) --
The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName (string) --
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description (string) --
A description of the table.
Owner (string) --
The owner of the table.
CreateTime (datetime) --
The time when the table definition was created in the Data Catalog.
UpdateTime (datetime) --
The last time that the table was updated.
LastAccessTime (datetime) --
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime (datetime) --
The last time that column statistics were computed for this table.
Retention (integer) --
The retention time for this table.
StorageDescriptor (dict) --
A storage descriptor containing information about the physical storage of this table.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
Parameters (dict) --
The user-supplied properties in key-value form.
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
PartitionKeys (list) --
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": []
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
ViewOriginalText (string) --
If the table is a view, the original text of the view; otherwise null .
ViewExpandedText (string) --
If the table is a view, the expanded text of the view; otherwise null .
TableType (string) --
The type of this table (EXTERNAL_TABLE , VIRTUAL_VIEW , etc.).
Parameters (dict) --
These key-value pairs define properties associated with the table.
CreatedBy (string) --
The person or entity who created the table.
IsRegisteredWithLakeFormation (boolean) --
Indicates whether the table has been registered with Lake Formation.
TargetTable (dict) --
A TableIdentifier structure that describes a target table for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
DatabaseName (string) --
The name of the catalog database that contains the target table.
Name (string) --
The name of the target table.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
VersionId (string) --
The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1.
NextToken (string) --
A continuation token, if the list of available versions does not include the last one.
Exceptions
Retrieves the definitions of some or all of the tables in a given Database .
See also: AWS API Documentation
Request Syntax
response = client.get_tables(
CatalogId='string',
DatabaseName='string',
Expression='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.
dict
Response Syntax
{
'TableList': [
{
'Name': 'string',
'DatabaseName': 'string',
'Description': 'string',
'Owner': 'string',
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'CreatedBy': 'string',
'IsRegisteredWithLakeFormation': True|False,
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string'
},
'CatalogId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TableList (list) --
A list of the requested Table objects.
(dict) --
Represents a collection of related data organized in columns and rows.
Name (string) --
The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName (string) --
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description (string) --
A description of the table.
Owner (string) --
The owner of the table.
CreateTime (datetime) --
The time when the table definition was created in the Data Catalog.
UpdateTime (datetime) --
The last time that the table was updated.
LastAccessTime (datetime) --
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime (datetime) --
The last time that column statistics were computed for this table.
Retention (integer) --
The retention time for this table.
StorageDescriptor (dict) --
A storage descriptor containing information about the physical storage of this table.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
Parameters (dict) --
The user-supplied properties in key-value form.
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
PartitionKeys (list) --
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": []
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
ViewOriginalText (string) --
If the table is a view, the original text of the view; otherwise null .
ViewExpandedText (string) --
If the table is a view, the expanded text of the view; otherwise null .
TableType (string) --
The type of this table (EXTERNAL_TABLE , VIRTUAL_VIEW , etc.).
Parameters (dict) --
These key-value pairs define properties associated with the table.
CreatedBy (string) --
The person or entity who created the table.
IsRegisteredWithLakeFormation (boolean) --
Indicates whether the table has been registered with Lake Formation.
TargetTable (dict) --
A TableIdentifier structure that describes a target table for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
DatabaseName (string) --
The name of the catalog database that contains the target table.
Name (string) --
The name of the target table.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
NextToken (string) --
A continuation token, present if the current list segment is not the last.
Exceptions
Retrieves a list of tags associated with a resource.
See also: AWS API Documentation
Request Syntax
response = client.get_tags(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource for which to retrieve tags.
{
'Tags': {
'string': 'string'
}
}
Response Structure
The requested tags.
Exceptions
Retrieves the definition of a trigger.
See also: AWS API Documentation
Request Syntax
response = client.get_trigger(
Name='string'
)
[REQUIRED]
The name of the trigger to retrieve.
{
'Trigger': {
'Name': 'string',
'WorkflowName': 'string',
'Id': 'string',
'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND'|'EVENT',
'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
'Description': 'string',
'Schedule': 'string',
'Actions': [
{
'JobName': 'string',
'Arguments': {
'string': 'string'
},
'Timeout': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'CrawlerName': 'string'
},
],
'Predicate': {
'Logical': 'AND'|'ANY',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'CrawlerName': 'string',
'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'
},
]
},
'EventBatchingCondition': {
'BatchSize': 123,
'BatchWindow': 123
}
}
}
Response Structure
The requested trigger definition.
The name of the trigger.
The name of the workflow associated with the trigger.
Reserved for future use.
The type of trigger that this is.
The current state of the trigger.
A description of this trigger.
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
The actions initiated by this trigger.
Defines an action to be initiated by a trigger.
The name of a job to be run.
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
The name of the SecurityConfiguration structure to be used with this action.
Specifies configuration properties of a job run notification.
After a job run starts, the number of minutes to wait before sending a job run delay notification.
The name of the crawler to be used with this action.
The predicate of this trigger, which defines when it will fire.
An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
A list of the conditions that determine when the trigger will fire.
Defines a condition under which a trigger fires.
A logical operator.
The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .
The name of the crawler to which this condition applies.
The state of the crawler to which this condition applies.
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
Exceptions
Gets all the triggers associated with a job.
See also: AWS API Documentation
Request Syntax
response = client.get_triggers(
NextToken='string',
DependentJobName='string',
MaxResults=123
)
dict
Response Syntax
{
'Triggers': [
{
'Name': 'string',
'WorkflowName': 'string',
'Id': 'string',
'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND'|'EVENT',
'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
'Description': 'string',
'Schedule': 'string',
'Actions': [
{
'JobName': 'string',
'Arguments': {
'string': 'string'
},
'Timeout': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'CrawlerName': 'string'
},
],
'Predicate': {
'Logical': 'AND'|'ANY',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'CrawlerName': 'string',
'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'
},
]
},
'EventBatchingCondition': {
'BatchSize': 123,
'BatchWindow': 123
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Triggers (list) --
A list of triggers for the specified job.
(dict) --
Information about a specific trigger.
Name (string) --
The name of the trigger.
WorkflowName (string) --
The name of the workflow associated with the trigger.
Id (string) --
Reserved for future use.
Type (string) --
The type of trigger that this is.
State (string) --
The current state of the trigger.
Description (string) --
A description of this trigger.
Schedule (string) --
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
Actions (list) --
The actions initiated by this trigger.
(dict) --
Defines an action to be initiated by a trigger.
JobName (string) --
The name of a job to be run.
Arguments (dict) --
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this action.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
CrawlerName (string) --
The name of the crawler to be used with this action.
Predicate (dict) --
The predicate of this trigger, which defines when it will fire.
Logical (string) --
An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
Conditions (list) --
A list of the conditions that determine when the trigger will fire.
(dict) --
Defines a condition under which a trigger fires.
LogicalOperator (string) --
A logical operator.
JobName (string) --
The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
State (string) --
The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .
CrawlerName (string) --
The name of the crawler to which this condition applies.
CrawlState (string) --
The state of the crawler to which this condition applies.
EventBatchingCondition (dict) --
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize (integer) --
Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow (integer) --
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
NextToken (string) --
A continuation token, if not all the requested triggers have yet been returned.
Exceptions
Retrieves a specified function definition from the Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.get_user_defined_function(
CatalogId='string',
DatabaseName='string',
FunctionName='string'
)
[REQUIRED]
The name of the catalog database where the function is located.
[REQUIRED]
The name of the function.
dict
Response Syntax
{
'UserDefinedFunction': {
'FunctionName': 'string',
'DatabaseName': 'string',
'ClassName': 'string',
'OwnerName': 'string',
'OwnerType': 'USER'|'ROLE'|'GROUP',
'CreateTime': datetime(2015, 1, 1),
'ResourceUris': [
{
'ResourceType': 'JAR'|'FILE'|'ARCHIVE',
'Uri': 'string'
},
],
'CatalogId': 'string'
}
}
Response Structure
(dict) --
UserDefinedFunction (dict) --
The requested function definition.
FunctionName (string) --
The name of the function.
DatabaseName (string) --
The name of the catalog database that contains the function.
ClassName (string) --
The Java class that contains the function code.
OwnerName (string) --
The owner of the function.
OwnerType (string) --
The owner type.
CreateTime (datetime) --
The time at which the function was created.
ResourceUris (list) --
The resource URIs for the function.
(dict) --
The URIs for function resources.
ResourceType (string) --
The type of the resource.
Uri (string) --
The URI for accessing the resource.
CatalogId (string) --
The ID of the Data Catalog in which the function resides.
Exceptions
Retrieves multiple function definitions from the Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.get_user_defined_functions(
CatalogId='string',
DatabaseName='string',
Pattern='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
An optional function-name pattern string that filters the function definitions returned.
dict
Response Syntax
{
'UserDefinedFunctions': [
{
'FunctionName': 'string',
'DatabaseName': 'string',
'ClassName': 'string',
'OwnerName': 'string',
'OwnerType': 'USER'|'ROLE'|'GROUP',
'CreateTime': datetime(2015, 1, 1),
'ResourceUris': [
{
'ResourceType': 'JAR'|'FILE'|'ARCHIVE',
'Uri': 'string'
},
],
'CatalogId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
UserDefinedFunctions (list) --
A list of requested function definitions.
(dict) --
Represents the equivalent of a Hive user-defined function (UDF ) definition.
FunctionName (string) --
The name of the function.
DatabaseName (string) --
The name of the catalog database that contains the function.
ClassName (string) --
The Java class that contains the function code.
OwnerName (string) --
The owner of the function.
OwnerType (string) --
The owner type.
CreateTime (datetime) --
The time at which the function was created.
ResourceUris (list) --
The resource URIs for the function.
(dict) --
The URIs for function resources.
ResourceType (string) --
The type of the resource.
Uri (string) --
The URI for accessing the resource.
CatalogId (string) --
The ID of the Data Catalog in which the function resides.
NextToken (string) --
A continuation token, if the list of functions returned does not include the last requested function.
Exceptions
Returns an object that can wait for some condition.
Retrieves resource metadata for a workflow.
See also: AWS API Documentation
Request Syntax
response = client.get_workflow(
Name='string',
IncludeGraph=True|False
)
[REQUIRED]
The name of the workflow to retrieve.
dict
Response Syntax
{
'Workflow': {
'Name': 'string',
'Description': 'string',
'DefaultRunProperties': {
'string': 'string'
},
'CreatedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'LastRun': {
'Name': 'string',
'WorkflowRunId': 'string',
'PreviousRunId': 'string',
'WorkflowRunProperties': {
'string': 'string'
},
'StartedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'Status': 'RUNNING'|'COMPLETED'|'STOPPING'|'STOPPED'|'ERROR',
'ErrorMessage': 'string',
'Statistics': {
'TotalActions': 123,
'TimeoutActions': 123,
'FailedActions': 123,
'StoppedActions': 123,
'SucceededActions': 123,
'RunningActions': 123
},
'Graph': {
'Nodes': [
{
'Type': 'CRAWLER'|'JOB'|'TRIGGER',
'Name': 'string',
'UniqueId': 'string',
'TriggerDetails': {
'Trigger': {
'Name': 'string',
'WorkflowName': 'string',
'Id': 'string',
'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND'|'EVENT',
'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
'Description': 'string',
'Schedule': 'string',
'Actions': [
{
'JobName': 'string',
'Arguments': {
'string': 'string'
},
'Timeout': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'CrawlerName': 'string'
},
],
'Predicate': {
'Logical': 'AND'|'ANY',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'CrawlerName': 'string',
'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'
},
]
},
'EventBatchingCondition': {
'BatchSize': 123,
'BatchWindow': 123
}
}
},
'JobDetails': {
'JobRuns': [
{
'Id': 'string',
'Attempt': 123,
'PreviousRunId': 'string',
'TriggerName': 'string',
'JobName': 'string',
'StartedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'Arguments': {
'string': 'string'
},
'ErrorMessage': 'string',
'PredecessorRuns': [
{
'JobName': 'string',
'RunId': 'string'
},
],
'AllocatedCapacity': 123,
'ExecutionTime': 123,
'Timeout': 123,
'MaxCapacity': 123.0,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'NumberOfWorkers': 123,
'SecurityConfiguration': 'string',
'LogGroupName': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'GlueVersion': 'string'
},
]
},
'CrawlerDetails': {
'Crawls': [
{
'State': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED',
'StartedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'ErrorMessage': 'string',
'LogGroup': 'string',
'LogStream': 'string'
},
]
}
},
],
'Edges': [
{
'SourceId': 'string',
'DestinationId': 'string'
},
]
},
'StartingEventBatchCondition': {
'BatchSize': 123,
'BatchWindow': 123
}
},
'Graph': {
'Nodes': [
{
'Type': 'CRAWLER'|'JOB'|'TRIGGER',
'Name': 'string',
'UniqueId': 'string',
'TriggerDetails': {
'Trigger': {
'Name': 'string',
'WorkflowName': 'string',
'Id': 'string',
'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND'|'EVENT',
'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
'Description': 'string',
'Schedule': 'string',
'Actions': [
{
'JobName': 'string',
'Arguments': {
'string': 'string'
},
'Timeout': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'CrawlerName': 'string'
},
],
'Predicate': {
'Logical': 'AND'|'ANY',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'CrawlerName': 'string',
'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'
},
]
},
'EventBatchingCondition': {
'BatchSize': 123,
'BatchWindow': 123
}
}
},
'JobDetails': {
'JobRuns': [
{
'Id': 'string',
'Attempt': 123,
'PreviousRunId': 'string',
'TriggerName': 'string',
'JobName': 'string',
'StartedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'Arguments': {
'string': 'string'
},
'ErrorMessage': 'string',
'PredecessorRuns': [
{
'JobName': 'string',
'RunId': 'string'
},
],
'AllocatedCapacity': 123,
'ExecutionTime': 123,
'Timeout': 123,
'MaxCapacity': 123.0,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'NumberOfWorkers': 123,
'SecurityConfiguration': 'string',
'LogGroupName': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'GlueVersion': 'string'
},
]
},
'CrawlerDetails': {
'Crawls': [
{
'State': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED',
'StartedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'ErrorMessage': 'string',
'LogGroup': 'string',
'LogStream': 'string'
},
]
}
},
],
'Edges': [
{
'SourceId': 'string',
'DestinationId': 'string'
},
]
},
'MaxConcurrentRuns': 123,
'BlueprintDetails': {
'BlueprintName': 'string',
'RunId': 'string'
}
}
}
Response Structure
(dict) --
Workflow (dict) --
The resource metadata for the workflow.
Name (string) --
The name of the workflow.
Description (string) --
A description of the workflow.
DefaultRunProperties (dict) --
A collection of properties to be used as part of each execution of the workflow. The run properties are made available to each job in the workflow. A job can modify the properties for the next jobs in the flow.
CreatedOn (datetime) --
The date and time when the workflow was created.
LastModifiedOn (datetime) --
The date and time when the workflow was last modified.
LastRun (dict) --
The information about the last execution of the workflow.
Name (string) --
Name of the workflow that was run.
WorkflowRunId (string) --
The ID of this workflow run.
PreviousRunId (string) --
The ID of the previous workflow run.
WorkflowRunProperties (dict) --
The workflow run properties which were set during the run.
StartedOn (datetime) --
The date and time when the workflow run was started.
CompletedOn (datetime) --
The date and time when the workflow run completed.
Status (string) --
The status of the workflow run.
ErrorMessage (string) --
This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo ."
Statistics (dict) --
The statistics of the run.
TotalActions (integer) --
Total number of Actions in the workflow run.
TimeoutActions (integer) --
Total number of Actions that timed out.
FailedActions (integer) --
Total number of Actions that have failed.
StoppedActions (integer) --
Total number of Actions that have stopped.
SucceededActions (integer) --
Total number of Actions that have succeeded.
RunningActions (integer) --
Total number Actions in running state.
Graph (dict) --
The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
Nodes (list) --
A list of the the Glue components belong to the workflow represented as nodes.
(dict) --
A node represents an Glue component (trigger, crawler, or job) on a workflow graph.
Type (string) --
The type of Glue component represented by the node.
Name (string) --
The name of the Glue component represented by the node.
UniqueId (string) --
The unique Id assigned to the node within the workflow.
TriggerDetails (dict) --
Details of the Trigger when the node represents a Trigger.
Trigger (dict) --
The information of the trigger represented by the trigger node.
Name (string) --
The name of the trigger.
WorkflowName (string) --
The name of the workflow associated with the trigger.
Id (string) --
Reserved for future use.
Type (string) --
The type of trigger that this is.
State (string) --
The current state of the trigger.
Description (string) --
A description of this trigger.
Schedule (string) --
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
Actions (list) --
The actions initiated by this trigger.
(dict) --
Defines an action to be initiated by a trigger.
JobName (string) --
The name of a job to be run.
Arguments (dict) --
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this action.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
CrawlerName (string) --
The name of the crawler to be used with this action.
Predicate (dict) --
The predicate of this trigger, which defines when it will fire.
Logical (string) --
An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
Conditions (list) --
A list of the conditions that determine when the trigger will fire.
(dict) --
Defines a condition under which a trigger fires.
LogicalOperator (string) --
A logical operator.
JobName (string) --
The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
State (string) --
The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .
CrawlerName (string) --
The name of the crawler to which this condition applies.
CrawlState (string) --
The state of the crawler to which this condition applies.
EventBatchingCondition (dict) --
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize (integer) --
Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow (integer) --
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
JobDetails (dict) --
Details of the Job when the node represents a Job.
JobRuns (list) --
The information for the job runs represented by the job node.
(dict) --
Contains information about a job run.
Id (string) --
The ID of this job run.
Attempt (integer) --
The number of the attempt to run this job.
PreviousRunId (string) --
The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.
TriggerName (string) --
The name of the trigger that started this job run.
JobName (string) --
The name of the job definition being used in this run.
StartedOn (datetime) --
The date and time at which this job run was started.
LastModifiedOn (datetime) --
The last time that this job run was modified.
CompletedOn (datetime) --
The date and time that this job run completed.
JobRunState (string) --
The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses .
Arguments (dict) --
The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
ErrorMessage (string) --
An error message associated with this job run.
PredecessorRuns (list) --
A list of predecessors to this job run.
(dict) --
A job run that was used in the predicate of a conditional trigger that triggered this job run.
JobName (string) --
The name of the job definition used by the predecessor job run.
RunId (string) --
The job-run ID of the predecessor job run.
AllocatedCapacity (integer) --
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
ExecutionTime (integer) --
The amount of time (in seconds) that the job run consumed resources.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
MaxCapacity (float) --
The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Do not set Max Capacity if using WorkerType and NumberOfWorkers .
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:
WorkerType (string) --
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
NumberOfWorkers (integer) --
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this job run.
LogGroupName (string) --
The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
GlueVersion (string) --
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
CrawlerDetails (dict) --
Details of the crawler when the node represents a crawler.
Crawls (list) --
A list of crawls represented by the crawl node.
(dict) --
The details of a crawl in the workflow.
State (string) --
The state of the crawler.
StartedOn (datetime) --
The date and time on which the crawl started.
CompletedOn (datetime) --
The date and time on which the crawl completed.
ErrorMessage (string) --
The error message associated with the crawl.
LogGroup (string) --
The log group associated with the crawl.
LogStream (string) --
The log stream associated with the crawl.
Edges (list) --
A list of all the directed connections between the nodes belonging to the workflow.
(dict) --
An edge represents a directed connection between two components on a workflow graph.
SourceId (string) --
The unique of the node within the workflow where the edge starts.
DestinationId (string) --
The unique of the node within the workflow where the edge ends.
StartingEventBatchCondition (dict) --
The batch condition that started the workflow run.
BatchSize (integer) --
Number of events in the batch.
BatchWindow (integer) --
Duration of the batch window in seconds.
Graph (dict) --
The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
Nodes (list) --
A list of the the Glue components belong to the workflow represented as nodes.
(dict) --
A node represents an Glue component (trigger, crawler, or job) on a workflow graph.
Type (string) --
The type of Glue component represented by the node.
Name (string) --
The name of the Glue component represented by the node.
UniqueId (string) --
The unique Id assigned to the node within the workflow.
TriggerDetails (dict) --
Details of the Trigger when the node represents a Trigger.
Trigger (dict) --
The information of the trigger represented by the trigger node.
Name (string) --
The name of the trigger.
WorkflowName (string) --
The name of the workflow associated with the trigger.
Id (string) --
Reserved for future use.
Type (string) --
The type of trigger that this is.
State (string) --
The current state of the trigger.
Description (string) --
A description of this trigger.
Schedule (string) --
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
Actions (list) --
The actions initiated by this trigger.
(dict) --
Defines an action to be initiated by a trigger.
JobName (string) --
The name of a job to be run.
Arguments (dict) --
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this action.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
CrawlerName (string) --
The name of the crawler to be used with this action.
Predicate (dict) --
The predicate of this trigger, which defines when it will fire.
Logical (string) --
An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
Conditions (list) --
A list of the conditions that determine when the trigger will fire.
(dict) --
Defines a condition under which a trigger fires.
LogicalOperator (string) --
A logical operator.
JobName (string) --
The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
State (string) --
The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .
CrawlerName (string) --
The name of the crawler to which this condition applies.
CrawlState (string) --
The state of the crawler to which this condition applies.
EventBatchingCondition (dict) --
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize (integer) --
Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow (integer) --
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
JobDetails (dict) --
Details of the Job when the node represents a Job.
JobRuns (list) --
The information for the job runs represented by the job node.
(dict) --
Contains information about a job run.
Id (string) --
The ID of this job run.
Attempt (integer) --
The number of the attempt to run this job.
PreviousRunId (string) --
The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.
TriggerName (string) --
The name of the trigger that started this job run.
JobName (string) --
The name of the job definition being used in this run.
StartedOn (datetime) --
The date and time at which this job run was started.
LastModifiedOn (datetime) --
The last time that this job run was modified.
CompletedOn (datetime) --
The date and time that this job run completed.
JobRunState (string) --
The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses .
Arguments (dict) --
The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
ErrorMessage (string) --
An error message associated with this job run.
PredecessorRuns (list) --
A list of predecessors to this job run.
(dict) --
A job run that was used in the predicate of a conditional trigger that triggered this job run.
JobName (string) --
The name of the job definition used by the predecessor job run.
RunId (string) --
The job-run ID of the predecessor job run.
AllocatedCapacity (integer) --
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
ExecutionTime (integer) --
The amount of time (in seconds) that the job run consumed resources.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
MaxCapacity (float) --
The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Do not set Max Capacity if using WorkerType and NumberOfWorkers .
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:
WorkerType (string) --
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
NumberOfWorkers (integer) --
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this job run.
LogGroupName (string) --
The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
GlueVersion (string) --
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
CrawlerDetails (dict) --
Details of the crawler when the node represents a crawler.
Crawls (list) --
A list of crawls represented by the crawl node.
(dict) --
The details of a crawl in the workflow.
State (string) --
The state of the crawler.
StartedOn (datetime) --
The date and time on which the crawl started.
CompletedOn (datetime) --
The date and time on which the crawl completed.
ErrorMessage (string) --
The error message associated with the crawl.
LogGroup (string) --
The log group associated with the crawl.
LogStream (string) --
The log stream associated with the crawl.
Edges (list) --
A list of all the directed connections between the nodes belonging to the workflow.
(dict) --
An edge represents a directed connection between two components on a workflow graph.
SourceId (string) --
The unique of the node within the workflow where the edge starts.
DestinationId (string) --
The unique of the node within the workflow where the edge ends.
MaxConcurrentRuns (integer) --
You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
BlueprintDetails (dict) --
This structure indicates the details of the blueprint that this particular workflow is created from.
BlueprintName (string) --
The name of the blueprint.
RunId (string) --
The run ID for this blueprint.
Exceptions
Retrieves the metadata for a given workflow run.
See also: AWS API Documentation
Request Syntax
response = client.get_workflow_run(
Name='string',
RunId='string',
IncludeGraph=True|False
)
[REQUIRED]
Name of the workflow being run.
[REQUIRED]
The ID of the workflow run.
dict
Response Syntax
{
'Run': {
'Name': 'string',
'WorkflowRunId': 'string',
'PreviousRunId': 'string',
'WorkflowRunProperties': {
'string': 'string'
},
'StartedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'Status': 'RUNNING'|'COMPLETED'|'STOPPING'|'STOPPED'|'ERROR',
'ErrorMessage': 'string',
'Statistics': {
'TotalActions': 123,
'TimeoutActions': 123,
'FailedActions': 123,
'StoppedActions': 123,
'SucceededActions': 123,
'RunningActions': 123
},
'Graph': {
'Nodes': [
{
'Type': 'CRAWLER'|'JOB'|'TRIGGER',
'Name': 'string',
'UniqueId': 'string',
'TriggerDetails': {
'Trigger': {
'Name': 'string',
'WorkflowName': 'string',
'Id': 'string',
'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND'|'EVENT',
'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
'Description': 'string',
'Schedule': 'string',
'Actions': [
{
'JobName': 'string',
'Arguments': {
'string': 'string'
},
'Timeout': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'CrawlerName': 'string'
},
],
'Predicate': {
'Logical': 'AND'|'ANY',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'CrawlerName': 'string',
'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'
},
]
},
'EventBatchingCondition': {
'BatchSize': 123,
'BatchWindow': 123
}
}
},
'JobDetails': {
'JobRuns': [
{
'Id': 'string',
'Attempt': 123,
'PreviousRunId': 'string',
'TriggerName': 'string',
'JobName': 'string',
'StartedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'Arguments': {
'string': 'string'
},
'ErrorMessage': 'string',
'PredecessorRuns': [
{
'JobName': 'string',
'RunId': 'string'
},
],
'AllocatedCapacity': 123,
'ExecutionTime': 123,
'Timeout': 123,
'MaxCapacity': 123.0,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'NumberOfWorkers': 123,
'SecurityConfiguration': 'string',
'LogGroupName': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'GlueVersion': 'string'
},
]
},
'CrawlerDetails': {
'Crawls': [
{
'State': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED',
'StartedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'ErrorMessage': 'string',
'LogGroup': 'string',
'LogStream': 'string'
},
]
}
},
],
'Edges': [
{
'SourceId': 'string',
'DestinationId': 'string'
},
]
},
'StartingEventBatchCondition': {
'BatchSize': 123,
'BatchWindow': 123
}
}
}
Response Structure
(dict) --
Run (dict) --
The requested workflow run metadata.
Name (string) --
Name of the workflow that was run.
WorkflowRunId (string) --
The ID of this workflow run.
PreviousRunId (string) --
The ID of the previous workflow run.
WorkflowRunProperties (dict) --
The workflow run properties which were set during the run.
StartedOn (datetime) --
The date and time when the workflow run was started.
CompletedOn (datetime) --
The date and time when the workflow run completed.
Status (string) --
The status of the workflow run.
ErrorMessage (string) --
This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo ."
Statistics (dict) --
The statistics of the run.
TotalActions (integer) --
Total number of Actions in the workflow run.
TimeoutActions (integer) --
Total number of Actions that timed out.
FailedActions (integer) --
Total number of Actions that have failed.
StoppedActions (integer) --
Total number of Actions that have stopped.
SucceededActions (integer) --
Total number of Actions that have succeeded.
RunningActions (integer) --
Total number Actions in running state.
Graph (dict) --
The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
Nodes (list) --
A list of the the Glue components belong to the workflow represented as nodes.
(dict) --
A node represents an Glue component (trigger, crawler, or job) on a workflow graph.
Type (string) --
The type of Glue component represented by the node.
Name (string) --
The name of the Glue component represented by the node.
UniqueId (string) --
The unique Id assigned to the node within the workflow.
TriggerDetails (dict) --
Details of the Trigger when the node represents a Trigger.
Trigger (dict) --
The information of the trigger represented by the trigger node.
Name (string) --
The name of the trigger.
WorkflowName (string) --
The name of the workflow associated with the trigger.
Id (string) --
Reserved for future use.
Type (string) --
The type of trigger that this is.
State (string) --
The current state of the trigger.
Description (string) --
A description of this trigger.
Schedule (string) --
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
Actions (list) --
The actions initiated by this trigger.
(dict) --
Defines an action to be initiated by a trigger.
JobName (string) --
The name of a job to be run.
Arguments (dict) --
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this action.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
CrawlerName (string) --
The name of the crawler to be used with this action.
Predicate (dict) --
The predicate of this trigger, which defines when it will fire.
Logical (string) --
An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
Conditions (list) --
A list of the conditions that determine when the trigger will fire.
(dict) --
Defines a condition under which a trigger fires.
LogicalOperator (string) --
A logical operator.
JobName (string) --
The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
State (string) --
The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .
CrawlerName (string) --
The name of the crawler to which this condition applies.
CrawlState (string) --
The state of the crawler to which this condition applies.
EventBatchingCondition (dict) --
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize (integer) --
Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow (integer) --
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
JobDetails (dict) --
Details of the Job when the node represents a Job.
JobRuns (list) --
The information for the job runs represented by the job node.
(dict) --
Contains information about a job run.
Id (string) --
The ID of this job run.
Attempt (integer) --
The number of the attempt to run this job.
PreviousRunId (string) --
The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.
TriggerName (string) --
The name of the trigger that started this job run.
JobName (string) --
The name of the job definition being used in this run.
StartedOn (datetime) --
The date and time at which this job run was started.
LastModifiedOn (datetime) --
The last time that this job run was modified.
CompletedOn (datetime) --
The date and time that this job run completed.
JobRunState (string) --
The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses .
Arguments (dict) --
The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
ErrorMessage (string) --
An error message associated with this job run.
PredecessorRuns (list) --
A list of predecessors to this job run.
(dict) --
A job run that was used in the predicate of a conditional trigger that triggered this job run.
JobName (string) --
The name of the job definition used by the predecessor job run.
RunId (string) --
The job-run ID of the predecessor job run.
AllocatedCapacity (integer) --
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
ExecutionTime (integer) --
The amount of time (in seconds) that the job run consumed resources.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
MaxCapacity (float) --
The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Do not set Max Capacity if using WorkerType and NumberOfWorkers .
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:
WorkerType (string) --
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
NumberOfWorkers (integer) --
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this job run.
LogGroupName (string) --
The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
GlueVersion (string) --
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
CrawlerDetails (dict) --
Details of the crawler when the node represents a crawler.
Crawls (list) --
A list of crawls represented by the crawl node.
(dict) --
The details of a crawl in the workflow.
State (string) --
The state of the crawler.
StartedOn (datetime) --
The date and time on which the crawl started.
CompletedOn (datetime) --
The date and time on which the crawl completed.
ErrorMessage (string) --
The error message associated with the crawl.
LogGroup (string) --
The log group associated with the crawl.
LogStream (string) --
The log stream associated with the crawl.
Edges (list) --
A list of all the directed connections between the nodes belonging to the workflow.
(dict) --
An edge represents a directed connection between two components on a workflow graph.
SourceId (string) --
The unique of the node within the workflow where the edge starts.
DestinationId (string) --
The unique of the node within the workflow where the edge ends.
StartingEventBatchCondition (dict) --
The batch condition that started the workflow run.
BatchSize (integer) --
Number of events in the batch.
BatchWindow (integer) --
Duration of the batch window in seconds.
Exceptions
Retrieves the workflow run properties which were set during the run.
See also: AWS API Documentation
Request Syntax
response = client.get_workflow_run_properties(
Name='string',
RunId='string'
)
[REQUIRED]
Name of the workflow which was run.
[REQUIRED]
The ID of the workflow run whose run properties should be returned.
dict
Response Syntax
{
'RunProperties': {
'string': 'string'
}
}
Response Structure
(dict) --
RunProperties (dict) --
The workflow run properties which were set during the specified run.
Exceptions
Retrieves metadata for all runs of a given workflow.
See also: AWS API Documentation
Request Syntax
response = client.get_workflow_runs(
Name='string',
IncludeGraph=True|False,
NextToken='string',
MaxResults=123
)
[REQUIRED]
Name of the workflow whose metadata of runs should be returned.
dict
Response Syntax
{
'Runs': [
{
'Name': 'string',
'WorkflowRunId': 'string',
'PreviousRunId': 'string',
'WorkflowRunProperties': {
'string': 'string'
},
'StartedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'Status': 'RUNNING'|'COMPLETED'|'STOPPING'|'STOPPED'|'ERROR',
'ErrorMessage': 'string',
'Statistics': {
'TotalActions': 123,
'TimeoutActions': 123,
'FailedActions': 123,
'StoppedActions': 123,
'SucceededActions': 123,
'RunningActions': 123
},
'Graph': {
'Nodes': [
{
'Type': 'CRAWLER'|'JOB'|'TRIGGER',
'Name': 'string',
'UniqueId': 'string',
'TriggerDetails': {
'Trigger': {
'Name': 'string',
'WorkflowName': 'string',
'Id': 'string',
'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND'|'EVENT',
'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
'Description': 'string',
'Schedule': 'string',
'Actions': [
{
'JobName': 'string',
'Arguments': {
'string': 'string'
},
'Timeout': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'CrawlerName': 'string'
},
],
'Predicate': {
'Logical': 'AND'|'ANY',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'CrawlerName': 'string',
'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'
},
]
},
'EventBatchingCondition': {
'BatchSize': 123,
'BatchWindow': 123
}
}
},
'JobDetails': {
'JobRuns': [
{
'Id': 'string',
'Attempt': 123,
'PreviousRunId': 'string',
'TriggerName': 'string',
'JobName': 'string',
'StartedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'Arguments': {
'string': 'string'
},
'ErrorMessage': 'string',
'PredecessorRuns': [
{
'JobName': 'string',
'RunId': 'string'
},
],
'AllocatedCapacity': 123,
'ExecutionTime': 123,
'Timeout': 123,
'MaxCapacity': 123.0,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'NumberOfWorkers': 123,
'SecurityConfiguration': 'string',
'LogGroupName': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'GlueVersion': 'string'
},
]
},
'CrawlerDetails': {
'Crawls': [
{
'State': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED',
'StartedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'ErrorMessage': 'string',
'LogGroup': 'string',
'LogStream': 'string'
},
]
}
},
],
'Edges': [
{
'SourceId': 'string',
'DestinationId': 'string'
},
]
},
'StartingEventBatchCondition': {
'BatchSize': 123,
'BatchWindow': 123
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Runs (list) --
A list of workflow run metadata objects.
(dict) --
A workflow run is an execution of a workflow providing all the runtime information.
Name (string) --
Name of the workflow that was run.
WorkflowRunId (string) --
The ID of this workflow run.
PreviousRunId (string) --
The ID of the previous workflow run.
WorkflowRunProperties (dict) --
The workflow run properties which were set during the run.
StartedOn (datetime) --
The date and time when the workflow run was started.
CompletedOn (datetime) --
The date and time when the workflow run completed.
Status (string) --
The status of the workflow run.
ErrorMessage (string) --
This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo ."
Statistics (dict) --
The statistics of the run.
TotalActions (integer) --
Total number of Actions in the workflow run.
TimeoutActions (integer) --
Total number of Actions that timed out.
FailedActions (integer) --
Total number of Actions that have failed.
StoppedActions (integer) --
Total number of Actions that have stopped.
SucceededActions (integer) --
Total number of Actions that have succeeded.
RunningActions (integer) --
Total number Actions in running state.
Graph (dict) --
The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
Nodes (list) --
A list of the the Glue components belong to the workflow represented as nodes.
(dict) --
A node represents an Glue component (trigger, crawler, or job) on a workflow graph.
Type (string) --
The type of Glue component represented by the node.
Name (string) --
The name of the Glue component represented by the node.
UniqueId (string) --
The unique Id assigned to the node within the workflow.
TriggerDetails (dict) --
Details of the Trigger when the node represents a Trigger.
Trigger (dict) --
The information of the trigger represented by the trigger node.
Name (string) --
The name of the trigger.
WorkflowName (string) --
The name of the workflow associated with the trigger.
Id (string) --
Reserved for future use.
Type (string) --
The type of trigger that this is.
State (string) --
The current state of the trigger.
Description (string) --
A description of this trigger.
Schedule (string) --
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
Actions (list) --
The actions initiated by this trigger.
(dict) --
Defines an action to be initiated by a trigger.
JobName (string) --
The name of a job to be run.
Arguments (dict) --
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this action.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
CrawlerName (string) --
The name of the crawler to be used with this action.
Predicate (dict) --
The predicate of this trigger, which defines when it will fire.
Logical (string) --
An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
Conditions (list) --
A list of the conditions that determine when the trigger will fire.
(dict) --
Defines a condition under which a trigger fires.
LogicalOperator (string) --
A logical operator.
JobName (string) --
The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
State (string) --
The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .
CrawlerName (string) --
The name of the crawler to which this condition applies.
CrawlState (string) --
The state of the crawler to which this condition applies.
EventBatchingCondition (dict) --
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize (integer) --
Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow (integer) --
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
JobDetails (dict) --
Details of the Job when the node represents a Job.
JobRuns (list) --
The information for the job runs represented by the job node.
(dict) --
Contains information about a job run.
Id (string) --
The ID of this job run.
Attempt (integer) --
The number of the attempt to run this job.
PreviousRunId (string) --
The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.
TriggerName (string) --
The name of the trigger that started this job run.
JobName (string) --
The name of the job definition being used in this run.
StartedOn (datetime) --
The date and time at which this job run was started.
LastModifiedOn (datetime) --
The last time that this job run was modified.
CompletedOn (datetime) --
The date and time that this job run completed.
JobRunState (string) --
The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses .
Arguments (dict) --
The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
ErrorMessage (string) --
An error message associated with this job run.
PredecessorRuns (list) --
A list of predecessors to this job run.
(dict) --
A job run that was used in the predicate of a conditional trigger that triggered this job run.
JobName (string) --
The name of the job definition used by the predecessor job run.
RunId (string) --
The job-run ID of the predecessor job run.
AllocatedCapacity (integer) --
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
ExecutionTime (integer) --
The amount of time (in seconds) that the job run consumed resources.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
MaxCapacity (float) --
The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Do not set Max Capacity if using WorkerType and NumberOfWorkers .
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:
WorkerType (string) --
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
NumberOfWorkers (integer) --
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this job run.
LogGroupName (string) --
The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
GlueVersion (string) --
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
CrawlerDetails (dict) --
Details of the crawler when the node represents a crawler.
Crawls (list) --
A list of crawls represented by the crawl node.
(dict) --
The details of a crawl in the workflow.
State (string) --
The state of the crawler.
StartedOn (datetime) --
The date and time on which the crawl started.
CompletedOn (datetime) --
The date and time on which the crawl completed.
ErrorMessage (string) --
The error message associated with the crawl.
LogGroup (string) --
The log group associated with the crawl.
LogStream (string) --
The log stream associated with the crawl.
Edges (list) --
A list of all the directed connections between the nodes belonging to the workflow.
(dict) --
An edge represents a directed connection between two components on a workflow graph.
SourceId (string) --
The unique of the node within the workflow where the edge starts.
DestinationId (string) --
The unique of the node within the workflow where the edge ends.
StartingEventBatchCondition (dict) --
The batch condition that started the workflow run.
BatchSize (integer) --
Number of events in the batch.
BatchWindow (integer) --
Duration of the batch window in seconds.
NextToken (string) --
A continuation token, if not all requested workflow runs have been returned.
Exceptions
Imports an existing Amazon Athena Data Catalog to Glue.
See also: AWS API Documentation
Request Syntax
response = client.import_catalog_to_glue(
CatalogId='string'
)
{}
Response Structure
Exceptions
Lists all the blueprint names in an account.
See also: AWS API Documentation
Request Syntax
response = client.list_blueprints(
NextToken='string',
MaxResults=123,
Tags={
'string': 'string'
}
)
Filters the list by an Amazon Web Services resource tag.
dict
Response Syntax
{
'Blueprints': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
Blueprints (list) --
List of names of blueprints in the account.
NextToken (string) --
A continuation token, if not all blueprint names have been returned.
Exceptions
Retrieves the names of all crawler resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
See also: AWS API Documentation
Request Syntax
response = client.list_crawlers(
MaxResults=123,
NextToken='string',
Tags={
'string': 'string'
}
)
Specifies to return only these tagged resources.
dict
Response Syntax
{
'CrawlerNames': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
CrawlerNames (list) --
The names of all crawlers in the account, or the crawlers with the specified tags.
NextToken (string) --
A continuation token, if the returned list does not contain the last metric available.
Exceptions
Retrieves the names of all DevEndpoint resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
See also: AWS API Documentation
Request Syntax
response = client.list_dev_endpoints(
NextToken='string',
MaxResults=123,
Tags={
'string': 'string'
}
)
Specifies to return only these tagged resources.
dict
Response Syntax
{
'DevEndpointNames': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
DevEndpointNames (list) --
The names of all the DevEndpoint s in the account, or the DevEndpoint s with the specified tags.
NextToken (string) --
A continuation token, if the returned list does not contain the last metric available.
Exceptions
Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
See also: AWS API Documentation
Request Syntax
response = client.list_jobs(
NextToken='string',
MaxResults=123,
Tags={
'string': 'string'
}
)
Specifies to return only these tagged resources.
dict
Response Syntax
{
'JobNames': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
JobNames (list) --
The names of all jobs in the account, or the jobs with the specified tags.
NextToken (string) --
A continuation token, if the returned list does not contain the last metric available.
Exceptions
Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag. This operation takes the optional Tags field, which you can use as a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag filtering, only resources with the tags are retrieved.
See also: AWS API Documentation
Request Syntax
response = client.list_ml_transforms(
NextToken='string',
MaxResults=123,
Filter={
'Name': 'string',
'TransformType': 'FIND_MATCHES',
'Status': 'NOT_READY'|'READY'|'DELETING',
'GlueVersion': 'string',
'CreatedBefore': datetime(2015, 1, 1),
'CreatedAfter': datetime(2015, 1, 1),
'LastModifiedBefore': datetime(2015, 1, 1),
'LastModifiedAfter': datetime(2015, 1, 1),
'Schema': [
{
'Name': 'string',
'DataType': 'string'
},
]
},
Sort={
'Column': 'NAME'|'TRANSFORM_TYPE'|'STATUS'|'CREATED'|'LAST_MODIFIED',
'SortDirection': 'DESCENDING'|'ASCENDING'
},
Tags={
'string': 'string'
}
)
A TransformFilterCriteria used to filter the machine learning transforms.
A unique transform name that is used to filter the machine learning transforms.
The type of machine learning transform that is used to filter the machine learning transforms.
Filters the list of machine learning transforms by the last known status of the transforms (to indicate whether a transform can be used or not). One of "NOT_READY", "READY", or "DELETING".
This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
The time and date before which the transforms were created.
The time and date after which the transforms were created.
Filter on transforms last modified before this date.
Filter on transforms last modified after this date.
Filters on datasets with a specific schema. The Map<Column, Type> object is an array of key-value pairs representing the schema this transform accepts, where Column is the name of a column, and Type is the type of the data such as an integer or string. Has an upper bound of 100 columns.
A key-value pair representing a column and data type that this transform can run against. The Schema parameter of the MLTransform may contain up to 100 of these structures.
The name of the column.
The type of data in the column.
A TransformSortCriteria used to sort the machine learning transforms.
The column to be used in the sorting criteria that are associated with the machine learning transform.
The sort direction to be used in the sorting criteria that are associated with the machine learning transform.
Specifies to return only these tagged resources.
dict
Response Syntax
{
'TransformIds': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransformIds (list) --
The identifiers of all the machine learning transforms in the account, or the machine learning transforms with the specified tags.
NextToken (string) --
A continuation token, if the returned list does not contain the last metric available.
Exceptions
Returns a list of registries that you have created, with minimal registry information. Registries in the Deleting status will not be included in the results. Empty results will be returned if there are no registries available.
See also: AWS API Documentation
Request Syntax
response = client.list_registries(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'Registries': [
{
'RegistryName': 'string',
'RegistryArn': 'string',
'Description': 'string',
'Status': 'AVAILABLE'|'DELETING',
'CreatedTime': 'string',
'UpdatedTime': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Registries (list) --
An array of RegistryDetailedListItem objects containing minimal details of each registry.
(dict) --
A structure containing the details for a registry.
RegistryName (string) --
The name of the registry.
RegistryArn (string) --
The Amazon Resource Name (ARN) of the registry.
Description (string) --
A description of the registry.
Status (string) --
The status of the registry.
CreatedTime (string) --
The data the registry was created.
UpdatedTime (string) --
The date the registry was updated.
NextToken (string) --
A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
Exceptions
Returns a list of schema versions that you have created, with minimal information. Schema versions in Deleted status will not be included in the results. Empty results will be returned if there are no schema versions available.
See also: AWS API Documentation
Request Syntax
response = client.list_schema_versions(
SchemaId={
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
MaxResults=123,
NextToken='string'
)
[REQUIRED]
This is a wrapper structure to contain schema identity fields. The structure contains:
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
dict
Response Syntax
{
'Schemas': [
{
'SchemaArn': 'string',
'SchemaVersionId': 'string',
'VersionNumber': 123,
'Status': 'AVAILABLE'|'PENDING'|'FAILURE'|'DELETING',
'CreatedTime': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Schemas (list) --
An array of SchemaVersionList objects containing details of each schema version.
(dict) --
An object containing the details about a schema version.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema.
SchemaVersionId (string) --
The unique identifier of the schema version.
VersionNumber (integer) --
The version number of the schema.
Status (string) --
The status of the schema version.
CreatedTime (string) --
The date and time the schema version was created.
NextToken (string) --
A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
Exceptions
Returns a list of schemas with minimal details. Schemas in Deleting status will not be included in the results. Empty results will be returned if there are no schemas available.
When the RegistryId is not provided, all the schemas across registries will be part of the API response.
See also: AWS API Documentation
Request Syntax
response = client.list_schemas(
RegistryId={
'RegistryName': 'string',
'RegistryArn': 'string'
},
MaxResults=123,
NextToken='string'
)
A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
Name of the registry. Used only for lookup. One of RegistryArn or RegistryName has to be provided.
Arn of the registry to be updated. One of RegistryArn or RegistryName has to be provided.
dict
Response Syntax
{
'Schemas': [
{
'RegistryName': 'string',
'SchemaName': 'string',
'SchemaArn': 'string',
'Description': 'string',
'SchemaStatus': 'AVAILABLE'|'PENDING'|'DELETING',
'CreatedTime': 'string',
'UpdatedTime': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Schemas (list) --
An array of SchemaListItem objects containing details of each schema.
(dict) --
An object that contains minimal details for a schema.
RegistryName (string) --
the name of the registry where the schema resides.
SchemaName (string) --
The name of the schema.
SchemaArn (string) --
The Amazon Resource Name (ARN) for the schema.
Description (string) --
A description for the schema.
SchemaStatus (string) --
The status of the schema.
CreatedTime (string) --
The date and time that a schema was created.
UpdatedTime (string) --
The date and time that a schema was updated.
NextToken (string) --
A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
Exceptions
Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
See also: AWS API Documentation
Request Syntax
response = client.list_triggers(
NextToken='string',
DependentJobName='string',
MaxResults=123,
Tags={
'string': 'string'
}
)
Specifies to return only these tagged resources.
dict
Response Syntax
{
'TriggerNames': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
TriggerNames (list) --
The names of all triggers in the account, or the triggers with the specified tags.
NextToken (string) --
A continuation token, if the returned list does not contain the last metric available.
Exceptions
Lists names of workflows created in the account.
See also: AWS API Documentation
Request Syntax
response = client.list_workflows(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Workflows': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
Workflows (list) --
List of names of workflows in the account.
NextToken (string) --
A continuation token, if not all workflow names have been returned.
Exceptions
Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter.
See also: AWS API Documentation
Request Syntax
response = client.put_data_catalog_encryption_settings(
CatalogId='string',
DataCatalogEncryptionSettings={
'EncryptionAtRest': {
'CatalogEncryptionMode': 'DISABLED'|'SSE-KMS',
'SseAwsKmsKeyId': 'string'
},
'ConnectionPasswordEncryption': {
'ReturnConnectionPasswordEncrypted': True|False,
'AwsKmsKeyId': 'string'
}
}
)
[REQUIRED]
The security configuration to set.
Specifies the encryption-at-rest configuration for the Data Catalog.
The encryption-at-rest mode for encrypting Data Catalog data.
The ID of the KMS key to use for encryption at rest.
When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption.
When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords remain encrypted in the responses of GetConnection and GetConnections . This encryption takes effect independently from catalog encryption.
An KMS key that is used to encrypt the connection password.
If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified KMS key, to encrypt passwords before storing them in the Data Catalog.
You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.
dict
Response Syntax
{}
Response Structure
Exceptions
Sets the Data Catalog resource policy for access control.
See also: AWS API Documentation
Request Syntax
response = client.put_resource_policy(
PolicyInJson='string',
ResourceArn='string',
PolicyHashCondition='string',
PolicyExistsCondition='MUST_EXIST'|'NOT_EXIST'|'NONE',
EnableHybrid='TRUE'|'FALSE'
)
[REQUIRED]
Contains the policy document to set, in JSON format.
If 'TRUE' , indicates that you are using both methods to grant cross-account access to Data Catalog resources:
Must be set to 'TRUE' if you have already used the Management Console to grant cross-account access, otherwise the call fails. Default is 'FALSE'.
dict
Response Syntax
{
'PolicyHash': 'string'
}
Response Structure
(dict) --
PolicyHash (string) --
A hash of the policy that has just been set. This must be included in a subsequent call that overwrites or updates this policy.
Exceptions
Puts the metadata key value pair for a specified schema version ID. A maximum of 10 key value pairs will be allowed per schema version. They can be added over one or more calls.
See also: AWS API Documentation
Request Syntax
response = client.put_schema_version_metadata(
SchemaId={
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
SchemaVersionNumber={
'LatestVersion': True|False,
'VersionNumber': 123
},
SchemaVersionId='string',
MetadataKeyValue={
'MetadataKey': 'string',
'MetadataValue': 'string'
}
)
The unique ID for the schema.
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
The version number of the schema.
The latest version available for the schema.
The version number of the schema.
[REQUIRED]
The metadata key's corresponding value.
A metadata key.
A metadata key’s corresponding value.
dict
Response Syntax
{
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string',
'LatestVersion': True|False,
'VersionNumber': 123,
'SchemaVersionId': 'string',
'MetadataKey': 'string',
'MetadataValue': 'string'
}
Response Structure
(dict) --
SchemaArn (string) --
The Amazon Resource Name (ARN) for the schema.
SchemaName (string) --
The name for the schema.
RegistryName (string) --
The name for the registry.
LatestVersion (boolean) --
The latest version of the schema.
VersionNumber (integer) --
The version number of the schema.
SchemaVersionId (string) --
The unique version ID of the schema version.
MetadataKey (string) --
The metadata key.
MetadataValue (string) --
The value of the metadata key.
Exceptions
Puts the specified workflow run properties for the given workflow run. If a property already exists for the specified run, then it overrides the value otherwise adds the property to existing properties.
See also: AWS API Documentation
Request Syntax
response = client.put_workflow_run_properties(
Name='string',
RunId='string',
RunProperties={
'string': 'string'
}
)
[REQUIRED]
Name of the workflow which was run.
[REQUIRED]
The ID of the workflow run for which the run properties should be updated.
[REQUIRED]
The properties to put for the specified run.
dict
Response Syntax
{}
Response Structure
Exceptions
Queries for the schema version metadata information.
See also: AWS API Documentation
Request Syntax
response = client.query_schema_version_metadata(
SchemaId={
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
SchemaVersionNumber={
'LatestVersion': True|False,
'VersionNumber': 123
},
SchemaVersionId='string',
MetadataList=[
{
'MetadataKey': 'string',
'MetadataValue': 'string'
},
],
MaxResults=123,
NextToken='string'
)
A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
The version number of the schema.
The latest version available for the schema.
The version number of the schema.
Search key-value pairs for metadata, if they are not provided all the metadata information will be fetched.
A structure containing a key value pair for metadata.
A metadata key.
A metadata key’s corresponding value.
dict
Response Syntax
{
'MetadataInfoMap': {
'string': {
'MetadataValue': 'string',
'CreatedTime': 'string',
'OtherMetadataValueList': [
{
'MetadataValue': 'string',
'CreatedTime': 'string'
},
]
}
},
'SchemaVersionId': 'string',
'NextToken': 'string'
}
Response Structure
(dict) --
MetadataInfoMap (dict) --
A map of a metadata key and associated values.
(string) --
(dict) --
A structure containing metadata information for a schema version.
MetadataValue (string) --
The metadata key’s corresponding value.
CreatedTime (string) --
The time at which the entry was created.
OtherMetadataValueList (list) --
Other metadata belonging to the same metadata key.
(dict) --
A structure containing other metadata for a schema version belonging to the same metadata key.
MetadataValue (string) --
The metadata key’s corresponding value for the other metadata belonging to the same metadata key.
CreatedTime (string) --
The time at which the entry was created.
SchemaVersionId (string) --
The unique version ID of the schema version.
NextToken (string) --
A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
Exceptions
Adds a new version to the existing schema. Returns an error if new version of schema does not meet the compatibility requirements of the schema set. This API will not create a new schema set and will return a 404 error if the schema set is not already present in the Schema Registry.
If this is the first schema definition to be registered in the Schema Registry, this API will store the schema version and return immediately. Otherwise, this call has the potential to run longer than other operations due to compatibility modes. You can call the GetSchemaVersion API with the SchemaVersionId to check compatibility modes.
If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller.
See also: AWS API Documentation
Request Syntax
response = client.register_schema_version(
SchemaId={
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
SchemaDefinition='string'
)
[REQUIRED]
This is a wrapper structure to contain schema identity fields. The structure contains:
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
[REQUIRED]
The schema definition using the DataFormat setting for the SchemaName .
dict
Response Syntax
{
'SchemaVersionId': 'string',
'VersionNumber': 123,
'Status': 'AVAILABLE'|'PENDING'|'FAILURE'|'DELETING'
}
Response Structure
(dict) --
SchemaVersionId (string) --
The unique ID that represents the version of this schema.
VersionNumber (integer) --
The version of this schema (for sync flow only, in case this is the first version).
Status (string) --
The status of the schema version.
Exceptions
Removes a key value pair from the schema version metadata for the specified schema version ID.
See also: AWS API Documentation
Request Syntax
response = client.remove_schema_version_metadata(
SchemaId={
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
SchemaVersionNumber={
'LatestVersion': True|False,
'VersionNumber': 123
},
SchemaVersionId='string',
MetadataKeyValue={
'MetadataKey': 'string',
'MetadataValue': 'string'
}
)
A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
The version number of the schema.
The latest version available for the schema.
The version number of the schema.
[REQUIRED]
The value of the metadata key.
A metadata key.
A metadata key’s corresponding value.
dict
Response Syntax
{
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string',
'LatestVersion': True|False,
'VersionNumber': 123,
'SchemaVersionId': 'string',
'MetadataKey': 'string',
'MetadataValue': 'string'
}
Response Structure
(dict) --
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema.
SchemaName (string) --
The name of the schema.
RegistryName (string) --
The name of the registry.
LatestVersion (boolean) --
The latest version of the schema.
VersionNumber (integer) --
The version number of the schema.
SchemaVersionId (string) --
The version ID for the schema version.
MetadataKey (string) --
The metadata key.
MetadataValue (string) --
The value of the metadata key.
Exceptions
Resets a bookmark entry.
See also: AWS API Documentation
Request Syntax
response = client.reset_job_bookmark(
JobName='string',
RunId='string'
)
[REQUIRED]
The name of the job in question.
dict
Response Syntax
{
'JobBookmarkEntry': {
'JobName': 'string',
'Version': 123,
'Run': 123,
'Attempt': 123,
'PreviousRunId': 'string',
'RunId': 'string',
'JobBookmark': 'string'
}
}
Response Structure
(dict) --
JobBookmarkEntry (dict) --
The reset bookmark entry.
JobName (string) --
The name of the job in question.
Version (integer) --
The version of the job.
Run (integer) --
The run ID number.
Attempt (integer) --
The attempt ID number.
PreviousRunId (string) --
The unique run identifier associated with the previous job run.
RunId (string) --
The run ID number.
JobBookmark (string) --
The bookmark itself.
Exceptions
Restarts selected nodes of a previous partially completed workflow run and resumes the workflow run. The selected nodes and all nodes that are downstream from the selected nodes are run.
See also: AWS API Documentation
Request Syntax
response = client.resume_workflow_run(
Name='string',
RunId='string',
NodeIds=[
'string',
]
)
[REQUIRED]
The name of the workflow to resume.
[REQUIRED]
The ID of the workflow run to resume.
[REQUIRED]
A list of the node IDs for the nodes you want to restart. The nodes that are to be restarted must have a run attempt in the original run.
dict
Response Syntax
{
'RunId': 'string',
'NodeIds': [
'string',
]
}
Response Structure
(dict) --
RunId (string) --
The new ID assigned to the resumed workflow run. Each resume of a workflow run will have a new run ID.
NodeIds (list) --
A list of the node IDs for the nodes that were actually restarted.
Exceptions
Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions.
You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.
See also: AWS API Documentation
Request Syntax
response = client.search_tables(
CatalogId='string',
NextToken='string',
Filters=[
{
'Key': 'string',
'Value': 'string',
'Comparator': 'EQUALS'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_EQUALS'|'LESS_THAN_EQUALS'
},
],
SearchText='string',
SortCriteria=[
{
'FieldName': 'string',
'Sort': 'ASC'|'DESC'
},
],
MaxResults=123,
ResourceShareType='FOREIGN'|'ALL'
)
A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name , a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate . For example, if Key=Name and Value=link , tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.
Defines a property predicate.
The key of the property.
The value of the property.
The comparator used to compare this property to others.
A string used for a text search.
Specifying a value in quotes filters based on an exact match to the value.
A list of criteria for sorting the results by a field name, in an ascending or descending order.
Specifies a field to sort by and a sort order.
The name of the field on which to sort.
An ascending or descending sort.
Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL .
dict
Response Syntax
{
'NextToken': 'string',
'TableList': [
{
'Name': 'string',
'DatabaseName': 'string',
'Description': 'string',
'Owner': 'string',
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'CreatedBy': 'string',
'IsRegisteredWithLakeFormation': True|False,
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string'
},
'CatalogId': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
A continuation token, present if the current list segment is not the last.
TableList (list) --
A list of the requested Table objects. The SearchTables response returns only the tables that you have access to.
(dict) --
Represents a collection of related data organized in columns and rows.
Name (string) --
The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName (string) --
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description (string) --
A description of the table.
Owner (string) --
The owner of the table.
CreateTime (datetime) --
The time when the table definition was created in the Data Catalog.
UpdateTime (datetime) --
The last time that the table was updated.
LastAccessTime (datetime) --
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime (datetime) --
The last time that column statistics were computed for this table.
Retention (integer) --
The retention time for this table.
StorageDescriptor (dict) --
A storage descriptor containing information about the physical storage of this table.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
Parameters (dict) --
The user-supplied properties in key-value form.
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
PartitionKeys (list) --
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": []
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
ViewOriginalText (string) --
If the table is a view, the original text of the view; otherwise null .
ViewExpandedText (string) --
If the table is a view, the expanded text of the view; otherwise null .
TableType (string) --
The type of this table (EXTERNAL_TABLE , VIRTUAL_VIEW , etc.).
Parameters (dict) --
These key-value pairs define properties associated with the table.
CreatedBy (string) --
The person or entity who created the table.
IsRegisteredWithLakeFormation (boolean) --
Indicates whether the table has been registered with Lake Formation.
TargetTable (dict) --
A TableIdentifier structure that describes a target table for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
DatabaseName (string) --
The name of the catalog database that contains the target table.
Name (string) --
The name of the target table.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
Exceptions
Starts a new run of the specified blueprint.
See also: AWS API Documentation
Request Syntax
response = client.start_blueprint_run(
BlueprintName='string',
Parameters='string',
RoleArn='string'
)
[REQUIRED]
The name of the blueprint.
[REQUIRED]
Specifies the IAM role used to create the workflow.
dict
Response Syntax
{
'RunId': 'string'
}
Response Structure
(dict) --
RunId (string) --
The run ID for this blueprint run.
Exceptions
Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException .
See also: AWS API Documentation
Request Syntax
response = client.start_crawler(
Name='string'
)
[REQUIRED]
Name of the crawler to start.
{}
Response Structure
Exceptions
Changes the schedule state of the specified crawler to SCHEDULED , unless the crawler is already running or the schedule state is already SCHEDULED .
See also: AWS API Documentation
Request Syntax
response = client.start_crawler_schedule(
CrawlerName='string'
)
[REQUIRED]
Name of the crawler to schedule.
{}
Response Structure
Exceptions
Begins an asynchronous task to export all labeled data for a particular transform. This task is the only label-related API call that is not part of the typical active learning workflow. You typically use StartExportLabelsTaskRun when you want to work with all of your existing labels at the same time, such as when you want to remove or change labels that were previously submitted as truth. This API operation accepts the TransformId whose labels you want to export and an Amazon Simple Storage Service (Amazon S3) path to export the labels to. The operation returns a TaskRunId . You can check on the status of your task run by calling the GetMLTaskRun API.
See also: AWS API Documentation
Request Syntax
response = client.start_export_labels_task_run(
TransformId='string',
OutputS3Path='string'
)
[REQUIRED]
The unique identifier of the machine learning transform.
[REQUIRED]
The Amazon S3 path where you export the labels.
dict
Response Syntax
{
'TaskRunId': 'string'
}
Response Structure
(dict) --
TaskRunId (string) --
The unique identifier for the task run.
Exceptions
Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality. This API operation is generally used as part of the active learning workflow that starts with the StartMLLabelingSetGenerationTaskRun call and that ultimately results in improving the quality of your machine learning transform.
After the StartMLLabelingSetGenerationTaskRun finishes, Glue machine learning will have generated a series of questions for humans to answer. (Answering these questions is often called 'labeling' in the machine learning workflows). In the case of the FindMatches transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?” After the labeling process is finished, users upload their answers/labels with a call to StartImportLabelsTaskRun . After StartImportLabelsTaskRun finishes, all future runs of the machine learning transform use the new and improved labels and perform a higher-quality transformation.
By default, StartMLLabelingSetGenerationTaskRun continually learns from and combines all labels that you upload unless you set Replace to true. If you set Replace to true, StartImportLabelsTaskRun deletes and forgets all previously uploaded labels and learns only from the exact set that you upload. Replacing labels can be helpful if you realize that you previously uploaded incorrect labels, and you believe that they are having a negative effect on your transform quality.
You can check on the status of your task run by calling the GetMLTaskRun operation.
See also: AWS API Documentation
Request Syntax
response = client.start_import_labels_task_run(
TransformId='string',
InputS3Path='string',
ReplaceAllLabels=True|False
)
[REQUIRED]
The unique identifier of the machine learning transform.
[REQUIRED]
The Amazon Simple Storage Service (Amazon S3) path from where you import the labels.
dict
Response Syntax
{
'TaskRunId': 'string'
}
Response Structure
(dict) --
TaskRunId (string) --
The unique identifier for the task run.
Exceptions
Starts a job run using a job definition.
See also: AWS API Documentation
Request Syntax
response = client.start_job_run(
JobName='string',
JobRunId='string',
Arguments={
'string': 'string'
},
AllocatedCapacity=123,
Timeout=123,
MaxCapacity=123.0,
SecurityConfiguration='string',
NotificationProperty={
'NotifyDelayAfter': 123
},
WorkerType='Standard'|'G.1X'|'G.2X',
NumberOfWorkers=123
)
[REQUIRED]
The name of the job definition to use.
The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Do not set Max Capacity if using WorkerType and NumberOfWorkers .
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, or an Apache Spark ETL job:
Specifies configuration properties of a job run notification.
After a job run starts, the number of minutes to wait before sending a job run delay notification.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
dict
Response Syntax
{
'JobRunId': 'string'
}
Response Structure
(dict) --
JobRunId (string) --
The ID assigned to this job run.
Exceptions
Starts a task to estimate the quality of the transform.
When you provide label sets as examples of truth, Glue machine learning uses some of those examples to learn from them. The rest of the labels are used as a test to estimate quality.
Returns a unique identifier for the run. You can call GetMLTaskRun to get more information about the stats of the EvaluationTaskRun .
See also: AWS API Documentation
Request Syntax
response = client.start_ml_evaluation_task_run(
TransformId='string'
)
[REQUIRED]
The unique identifier of the machine learning transform.
{
'TaskRunId': 'string'
}
Response Structure
The unique identifier associated with this run.
Exceptions
Starts the active learning workflow for your machine learning transform to improve the transform's quality by generating label sets and adding labels.
When the StartMLLabelingSetGenerationTaskRun finishes, Glue will have generated a "labeling set" or a set of questions for humans to answer.
In the case of the FindMatches transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?”
After the labeling process is finished, you can upload your labels with a call to StartImportLabelsTaskRun . After StartImportLabelsTaskRun finishes, all future runs of the machine learning transform will use the new and improved labels and perform a higher-quality transformation.
See also: AWS API Documentation
Request Syntax
response = client.start_ml_labeling_set_generation_task_run(
TransformId='string',
OutputS3Path='string'
)
[REQUIRED]
The unique identifier of the machine learning transform.
[REQUIRED]
The Amazon Simple Storage Service (Amazon S3) path where you generate the labeling set.
dict
Response Syntax
{
'TaskRunId': 'string'
}
Response Structure
(dict) --
TaskRunId (string) --
The unique run identifier that is associated with this task run.
Exceptions
Starts an existing trigger. See Triggering Jobs for information about how different types of trigger are started.
See also: AWS API Documentation
Request Syntax
response = client.start_trigger(
Name='string'
)
[REQUIRED]
The name of the trigger to start.
{
'Name': 'string'
}
Response Structure
The name of the trigger that was started.
Exceptions
Starts a new run of the specified workflow.
See also: AWS API Documentation
Request Syntax
response = client.start_workflow_run(
Name='string'
)
[REQUIRED]
The name of the workflow to start.
{
'RunId': 'string'
}
Response Structure
An Id for the new run.
Exceptions
If the specified crawler is running, stops the crawl.
See also: AWS API Documentation
Request Syntax
response = client.stop_crawler(
Name='string'
)
[REQUIRED]
Name of the crawler to stop.
{}
Response Structure
Exceptions
Sets the schedule state of the specified crawler to NOT_SCHEDULED , but does not stop the crawler if it is already running.
See also: AWS API Documentation
Request Syntax
response = client.stop_crawler_schedule(
CrawlerName='string'
)
[REQUIRED]
Name of the crawler whose schedule state to set.
{}
Response Structure
Exceptions
Stops a specified trigger.
See also: AWS API Documentation
Request Syntax
response = client.stop_trigger(
Name='string'
)
[REQUIRED]
The name of the trigger to stop.
{
'Name': 'string'
}
Response Structure
The name of the trigger that was stopped.
Exceptions
Stops the execution of the specified workflow run.
See also: AWS API Documentation
Request Syntax
response = client.stop_workflow_run(
Name='string',
RunId='string'
)
[REQUIRED]
The name of the workflow to stop.
[REQUIRED]
The ID of the workflow run to stop.
dict
Response Syntax
{}
Response Structure
Exceptions
Adds tags to a resource. A tag is a label you can assign to an Amazon Web Services resource. In Glue, you can tag only certain resources. For information about what resources you can tag, see Amazon Web Services Tags in Glue .
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
TagsToAdd={
'string': 'string'
}
)
[REQUIRED]
The ARN of the Glue resource to which to add the tags. For more information about Glue resource ARNs, see the Glue ARN string pattern .
[REQUIRED]
Tags to add to this resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes tags from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagsToRemove=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource from which to remove the tags.
[REQUIRED]
Tags to remove from this resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates a registered blueprint.
See also: AWS API Documentation
Request Syntax
response = client.update_blueprint(
Name='string',
Description='string',
BlueprintLocation='string'
)
[REQUIRED]
The name of the blueprint.
[REQUIRED]
Specifies a path in Amazon S3 where the blueprint is published.
dict
Response Syntax
{
'Name': 'string'
}
Response Structure
(dict) --
Name (string) --
Returns the name of the blueprint that was updated.
Exceptions
Modifies an existing classifier (a GrokClassifier , an XMLClassifier , a JsonClassifier , or a CsvClassifier , depending on which field is present).
See also: AWS API Documentation
Request Syntax
response = client.update_classifier(
GrokClassifier={
'Name': 'string',
'Classification': 'string',
'GrokPattern': 'string',
'CustomPatterns': 'string'
},
XMLClassifier={
'Name': 'string',
'Classification': 'string',
'RowTag': 'string'
},
JsonClassifier={
'Name': 'string',
'JsonPath': 'string'
},
CsvClassifier={
'Name': 'string',
'Delimiter': 'string',
'QuoteSymbol': 'string',
'ContainsHeader': 'UNKNOWN'|'PRESENT'|'ABSENT',
'Header': [
'string',
],
'DisableValueTrimming': True|False,
'AllowSingleColumn': True|False
}
)
A GrokClassifier object with updated fields.
The name of the GrokClassifier .
An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.
The grok pattern used by this classifier.
Optional custom grok patterns used by this classifier.
An XMLClassifier object with updated fields.
The name of the classifier.
An identifier of the data format that the classifier matches.
The XML tag designating the element that contains each record in an XML document being parsed. This cannot identify a self-closing element (closed by /> ). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).
A JsonClassifier object with updated fields.
The name of the classifier.
A JsonPath string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers .
A CsvClassifier object with updated fields.
The name of the classifier.
A custom symbol to denote what separates each column entry in the row.
A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
Indicates whether the CSV file contains a header.
A list of strings representing column names.
Specifies not to trim values before identifying the type of column values. The default value is true.
Enables the processing of files that contain only one column.
dict
Response Syntax
{}
Response Structure
Exceptions
Creates or updates partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is UpdatePartition .
See also: AWS API Documentation
Request Syntax
response = client.update_column_statistics_for_partition(
CatalogId='string',
DatabaseName='string',
TableName='string',
PartitionValues=[
'string',
],
ColumnStatisticsList=[
{
'ColumnName': 'string',
'ColumnType': 'string',
'AnalyzedTime': datetime(2015, 1, 1),
'StatisticsData': {
'Type': 'BOOLEAN'|'DATE'|'DECIMAL'|'DOUBLE'|'LONG'|'STRING'|'BINARY',
'BooleanColumnStatisticsData': {
'NumberOfTrues': 123,
'NumberOfFalses': 123,
'NumberOfNulls': 123
},
'DateColumnStatisticsData': {
'MinimumValue': datetime(2015, 1, 1),
'MaximumValue': datetime(2015, 1, 1),
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'DecimalColumnStatisticsData': {
'MinimumValue': {
'UnscaledValue': b'bytes',
'Scale': 123
},
'MaximumValue': {
'UnscaledValue': b'bytes',
'Scale': 123
},
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'DoubleColumnStatisticsData': {
'MinimumValue': 123.0,
'MaximumValue': 123.0,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'LongColumnStatisticsData': {
'MinimumValue': 123,
'MaximumValue': 123,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'StringColumnStatisticsData': {
'MaximumLength': 123,
'AverageLength': 123.0,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'BinaryColumnStatisticsData': {
'MaximumLength': 123,
'AverageLength': 123.0,
'NumberOfNulls': 123
}
}
},
]
)
[REQUIRED]
The name of the catalog database where the partitions reside.
[REQUIRED]
The name of the partitions' table.
[REQUIRED]
A list of partition values identifying the partition.
[REQUIRED]
A list of the column statistics.
Represents the generated column-level statistics for a table or partition.
Name of column which statistics belong to.
The data type of the column.
The timestamp of when column statistics were generated.
A ColumnStatisticData object that contains the statistics data values.
The type of column statistics data.
Boolean column statistics data.
The number of true values in the column.
The number of false values in the column.
The number of null values in the column.
Date column statistics data.
The lowest value in the column.
The highest value in the column.
The number of null values in the column.
The number of distinct values in a column.
Decimal column statistics data.
The lowest value in the column.
The unscaled numeric value.
The scale that determines where the decimal point falls in the unscaled value.
The highest value in the column.
The unscaled numeric value.
The scale that determines where the decimal point falls in the unscaled value.
The number of null values in the column.
The number of distinct values in a column.
Double column statistics data.
The lowest value in the column.
The highest value in the column.
The number of null values in the column.
The number of distinct values in a column.
Long column statistics data.
The lowest value in the column.
The highest value in the column.
The number of null values in the column.
The number of distinct values in a column.
String column statistics data.
The size of the longest string in the column.
The average string length in the column.
The number of null values in the column.
The number of distinct values in a column.
Binary column statistics data.
The size of the longest bit sequence in the column.
The average bit sequence length in the column.
The number of null values in the column.
dict
Response Syntax
{
'Errors': [
{
'ColumnStatistics': {
'ColumnName': 'string',
'ColumnType': 'string',
'AnalyzedTime': datetime(2015, 1, 1),
'StatisticsData': {
'Type': 'BOOLEAN'|'DATE'|'DECIMAL'|'DOUBLE'|'LONG'|'STRING'|'BINARY',
'BooleanColumnStatisticsData': {
'NumberOfTrues': 123,
'NumberOfFalses': 123,
'NumberOfNulls': 123
},
'DateColumnStatisticsData': {
'MinimumValue': datetime(2015, 1, 1),
'MaximumValue': datetime(2015, 1, 1),
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'DecimalColumnStatisticsData': {
'MinimumValue': {
'UnscaledValue': b'bytes',
'Scale': 123
},
'MaximumValue': {
'UnscaledValue': b'bytes',
'Scale': 123
},
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'DoubleColumnStatisticsData': {
'MinimumValue': 123.0,
'MaximumValue': 123.0,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'LongColumnStatisticsData': {
'MinimumValue': 123,
'MaximumValue': 123,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'StringColumnStatisticsData': {
'MaximumLength': 123,
'AverageLength': 123.0,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'BinaryColumnStatisticsData': {
'MaximumLength': 123,
'AverageLength': 123.0,
'NumberOfNulls': 123
}
}
},
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
Errors (list) --
Error occurred during updating column statistics data.
(dict) --
Encapsulates a ColumnStatistics object that failed and the reason for failure.
ColumnStatistics (dict) --
The ColumnStatistics of the column.
ColumnName (string) --
Name of column which statistics belong to.
ColumnType (string) --
The data type of the column.
AnalyzedTime (datetime) --
The timestamp of when column statistics were generated.
StatisticsData (dict) --
A ColumnStatisticData object that contains the statistics data values.
Type (string) --
The type of column statistics data.
BooleanColumnStatisticsData (dict) --
Boolean column statistics data.
NumberOfTrues (integer) --
The number of true values in the column.
NumberOfFalses (integer) --
The number of false values in the column.
NumberOfNulls (integer) --
The number of null values in the column.
DateColumnStatisticsData (dict) --
Date column statistics data.
MinimumValue (datetime) --
The lowest value in the column.
MaximumValue (datetime) --
The highest value in the column.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
DecimalColumnStatisticsData (dict) --
Decimal column statistics data.
MinimumValue (dict) --
The lowest value in the column.
UnscaledValue (bytes) --
The unscaled numeric value.
Scale (integer) --
The scale that determines where the decimal point falls in the unscaled value.
MaximumValue (dict) --
The highest value in the column.
UnscaledValue (bytes) --
The unscaled numeric value.
Scale (integer) --
The scale that determines where the decimal point falls in the unscaled value.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
DoubleColumnStatisticsData (dict) --
Double column statistics data.
MinimumValue (float) --
The lowest value in the column.
MaximumValue (float) --
The highest value in the column.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
LongColumnStatisticsData (dict) --
Long column statistics data.
MinimumValue (integer) --
The lowest value in the column.
MaximumValue (integer) --
The highest value in the column.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
StringColumnStatisticsData (dict) --
String column statistics data.
MaximumLength (integer) --
The size of the longest string in the column.
AverageLength (float) --
The average string length in the column.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
BinaryColumnStatisticsData (dict) --
Binary column statistics data.
MaximumLength (integer) --
The size of the longest bit sequence in the column.
AverageLength (float) --
The average bit sequence length in the column.
NumberOfNulls (integer) --
The number of null values in the column.
Error (dict) --
An error message with the reason for the failure of an operation.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Exceptions
Creates or updates table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is UpdateTable .
See also: AWS API Documentation
Request Syntax
response = client.update_column_statistics_for_table(
CatalogId='string',
DatabaseName='string',
TableName='string',
ColumnStatisticsList=[
{
'ColumnName': 'string',
'ColumnType': 'string',
'AnalyzedTime': datetime(2015, 1, 1),
'StatisticsData': {
'Type': 'BOOLEAN'|'DATE'|'DECIMAL'|'DOUBLE'|'LONG'|'STRING'|'BINARY',
'BooleanColumnStatisticsData': {
'NumberOfTrues': 123,
'NumberOfFalses': 123,
'NumberOfNulls': 123
},
'DateColumnStatisticsData': {
'MinimumValue': datetime(2015, 1, 1),
'MaximumValue': datetime(2015, 1, 1),
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'DecimalColumnStatisticsData': {
'MinimumValue': {
'UnscaledValue': b'bytes',
'Scale': 123
},
'MaximumValue': {
'UnscaledValue': b'bytes',
'Scale': 123
},
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'DoubleColumnStatisticsData': {
'MinimumValue': 123.0,
'MaximumValue': 123.0,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'LongColumnStatisticsData': {
'MinimumValue': 123,
'MaximumValue': 123,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'StringColumnStatisticsData': {
'MaximumLength': 123,
'AverageLength': 123.0,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'BinaryColumnStatisticsData': {
'MaximumLength': 123,
'AverageLength': 123.0,
'NumberOfNulls': 123
}
}
},
]
)
[REQUIRED]
The name of the catalog database where the partitions reside.
[REQUIRED]
The name of the partitions' table.
[REQUIRED]
A list of the column statistics.
Represents the generated column-level statistics for a table or partition.
Name of column which statistics belong to.
The data type of the column.
The timestamp of when column statistics were generated.
A ColumnStatisticData object that contains the statistics data values.
The type of column statistics data.
Boolean column statistics data.
The number of true values in the column.
The number of false values in the column.
The number of null values in the column.
Date column statistics data.
The lowest value in the column.
The highest value in the column.
The number of null values in the column.
The number of distinct values in a column.
Decimal column statistics data.
The lowest value in the column.
The unscaled numeric value.
The scale that determines where the decimal point falls in the unscaled value.
The highest value in the column.
The unscaled numeric value.
The scale that determines where the decimal point falls in the unscaled value.
The number of null values in the column.
The number of distinct values in a column.
Double column statistics data.
The lowest value in the column.
The highest value in the column.
The number of null values in the column.
The number of distinct values in a column.
Long column statistics data.
The lowest value in the column.
The highest value in the column.
The number of null values in the column.
The number of distinct values in a column.
String column statistics data.
The size of the longest string in the column.
The average string length in the column.
The number of null values in the column.
The number of distinct values in a column.
Binary column statistics data.
The size of the longest bit sequence in the column.
The average bit sequence length in the column.
The number of null values in the column.
dict
Response Syntax
{
'Errors': [
{
'ColumnStatistics': {
'ColumnName': 'string',
'ColumnType': 'string',
'AnalyzedTime': datetime(2015, 1, 1),
'StatisticsData': {
'Type': 'BOOLEAN'|'DATE'|'DECIMAL'|'DOUBLE'|'LONG'|'STRING'|'BINARY',
'BooleanColumnStatisticsData': {
'NumberOfTrues': 123,
'NumberOfFalses': 123,
'NumberOfNulls': 123
},
'DateColumnStatisticsData': {
'MinimumValue': datetime(2015, 1, 1),
'MaximumValue': datetime(2015, 1, 1),
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'DecimalColumnStatisticsData': {
'MinimumValue': {
'UnscaledValue': b'bytes',
'Scale': 123
},
'MaximumValue': {
'UnscaledValue': b'bytes',
'Scale': 123
},
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'DoubleColumnStatisticsData': {
'MinimumValue': 123.0,
'MaximumValue': 123.0,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'LongColumnStatisticsData': {
'MinimumValue': 123,
'MaximumValue': 123,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'StringColumnStatisticsData': {
'MaximumLength': 123,
'AverageLength': 123.0,
'NumberOfNulls': 123,
'NumberOfDistinctValues': 123
},
'BinaryColumnStatisticsData': {
'MaximumLength': 123,
'AverageLength': 123.0,
'NumberOfNulls': 123
}
}
},
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
Errors (list) --
List of ColumnStatisticsErrors.
(dict) --
Encapsulates a ColumnStatistics object that failed and the reason for failure.
ColumnStatistics (dict) --
The ColumnStatistics of the column.
ColumnName (string) --
Name of column which statistics belong to.
ColumnType (string) --
The data type of the column.
AnalyzedTime (datetime) --
The timestamp of when column statistics were generated.
StatisticsData (dict) --
A ColumnStatisticData object that contains the statistics data values.
Type (string) --
The type of column statistics data.
BooleanColumnStatisticsData (dict) --
Boolean column statistics data.
NumberOfTrues (integer) --
The number of true values in the column.
NumberOfFalses (integer) --
The number of false values in the column.
NumberOfNulls (integer) --
The number of null values in the column.
DateColumnStatisticsData (dict) --
Date column statistics data.
MinimumValue (datetime) --
The lowest value in the column.
MaximumValue (datetime) --
The highest value in the column.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
DecimalColumnStatisticsData (dict) --
Decimal column statistics data.
MinimumValue (dict) --
The lowest value in the column.
UnscaledValue (bytes) --
The unscaled numeric value.
Scale (integer) --
The scale that determines where the decimal point falls in the unscaled value.
MaximumValue (dict) --
The highest value in the column.
UnscaledValue (bytes) --
The unscaled numeric value.
Scale (integer) --
The scale that determines where the decimal point falls in the unscaled value.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
DoubleColumnStatisticsData (dict) --
Double column statistics data.
MinimumValue (float) --
The lowest value in the column.
MaximumValue (float) --
The highest value in the column.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
LongColumnStatisticsData (dict) --
Long column statistics data.
MinimumValue (integer) --
The lowest value in the column.
MaximumValue (integer) --
The highest value in the column.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
StringColumnStatisticsData (dict) --
String column statistics data.
MaximumLength (integer) --
The size of the longest string in the column.
AverageLength (float) --
The average string length in the column.
NumberOfNulls (integer) --
The number of null values in the column.
NumberOfDistinctValues (integer) --
The number of distinct values in a column.
BinaryColumnStatisticsData (dict) --
Binary column statistics data.
MaximumLength (integer) --
The size of the longest bit sequence in the column.
AverageLength (float) --
The average bit sequence length in the column.
NumberOfNulls (integer) --
The number of null values in the column.
Error (dict) --
An error message with the reason for the failure of an operation.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Exceptions
Updates a connection definition in the Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.update_connection(
CatalogId='string',
Name='string',
ConnectionInput={
'Name': 'string',
'Description': 'string',
'ConnectionType': 'JDBC'|'SFTP'|'MONGODB'|'KAFKA'|'NETWORK'|'MARKETPLACE'|'CUSTOM',
'MatchCriteria': [
'string',
],
'ConnectionProperties': {
'string': 'string'
},
'PhysicalConnectionRequirements': {
'SubnetId': 'string',
'SecurityGroupIdList': [
'string',
],
'AvailabilityZone': 'string'
}
}
)
[REQUIRED]
The name of the connection definition to update.
[REQUIRED]
A ConnectionInput object that redefines the connection in question.
The name of the connection.
The description of the connection.
The type of the connection. Currently, these types are supported:
SFTP is not supported.
A list of criteria that can be used in selecting this connection.
These key-value pairs define parameters for the connection.
A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to successfully make this connection.
The subnet ID used by the connection.
The security group ID list used by the connection.
The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates a crawler. If a crawler is running, you must stop it using StopCrawler before updating it.
See also: AWS API Documentation
Request Syntax
response = client.update_crawler(
Name='string',
Role='string',
DatabaseName='string',
Description='string',
Targets={
'S3Targets': [
{
'Path': 'string',
'Exclusions': [
'string',
],
'ConnectionName': 'string',
'SampleSize': 123,
'EventQueueArn': 'string',
'DlqEventQueueArn': 'string'
},
],
'JdbcTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'Exclusions': [
'string',
]
},
],
'MongoDBTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'ScanAll': True|False
},
],
'DynamoDBTargets': [
{
'Path': 'string',
'scanAll': True|False,
'scanRate': 123.0
},
],
'CatalogTargets': [
{
'DatabaseName': 'string',
'Tables': [
'string',
]
},
]
},
Schedule='string',
Classifiers=[
'string',
],
TablePrefix='string',
SchemaChangePolicy={
'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
},
RecrawlPolicy={
'RecrawlBehavior': 'CRAWL_EVERYTHING'|'CRAWL_NEW_FOLDERS_ONLY'|'CRAWL_EVENT_MODE'
},
LineageConfiguration={
'CrawlerLineageSettings': 'ENABLE'|'DISABLE'
},
Configuration='string',
CrawlerSecurityConfiguration='string'
)
[REQUIRED]
Name of the new crawler.
A list of targets to crawl.
Specifies Amazon Simple Storage Service (Amazon S3) targets.
Specifies a data store in Amazon Simple Storage Service (Amazon S3).
The path to the Amazon S3 target.
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .
The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs .
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue .
Specifies JDBC targets.
Specifies a JDBC data store to crawl.
The name of the connection to use to connect to the JDBC target.
The path of the JDBC target.
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .
Specifies Amazon DocumentDB or MongoDB targets.
Specifies an Amazon DocumentDB or MongoDB data store to crawl.
The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
The path of the Amazon DocumentDB or MongoDB target (database/collection).
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .
Specifies Amazon DynamoDB targets.
Specifies an Amazon DynamoDB table to crawl.
The name of the DynamoDB table to crawl.
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .
The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
Specifies Glue Data Catalog targets.
Specifies an Glue Data Catalog target.
The name of the database to be synchronized.
A list of the tables to be synchronized.
A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
The policy for the crawler's update and deletion behavior.
The update behavior when the crawler finds a changed schema.
The deletion behavior when the crawler finds a deleted object.
A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.
A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
Specifies data lineage configuration settings for the crawler.
Specifies whether data lineage is enabled for the crawler. Valid values are:
dict
Response Syntax
{}
Response Structure
Exceptions
Updates the schedule of a crawler using a cron expression.
See also: AWS API Documentation
Request Syntax
response = client.update_crawler_schedule(
CrawlerName='string',
Schedule='string'
)
[REQUIRED]
The name of the crawler whose schedule to update.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates an existing database definition in a Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.update_database(
CatalogId='string',
Name='string',
DatabaseInput={
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'Parameters': {
'string': 'string'
},
'CreateTableDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'TargetDatabase': {
'CatalogId': 'string',
'DatabaseName': 'string'
}
}
)
[REQUIRED]
The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.
[REQUIRED]
A DatabaseInput object specifying the new definition of the metadata database in the catalog.
The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
A description of the database.
The location of the database (for example, an HDFS path).
These key-value pairs define parameters and properties of the database.
These key-value pairs define parameters and properties of the database.
Creates a set of default permissions on the table for principals.
Permissions granted to a principal.
The principal who is granted permissions.
An identifier for the Lake Formation principal.
The permissions that are granted to the principal.
A DatabaseIdentifier structure that describes a target database for resource linking.
The ID of the Data Catalog in which the database resides.
The name of the catalog database.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates a specified development endpoint.
See also: AWS API Documentation
Request Syntax
response = client.update_dev_endpoint(
EndpointName='string',
PublicKey='string',
AddPublicKeys=[
'string',
],
DeletePublicKeys=[
'string',
],
CustomLibraries={
'ExtraPythonLibsS3Path': 'string',
'ExtraJarsS3Path': 'string'
},
UpdateEtlLibraries=True|False,
DeleteArguments=[
'string',
],
AddArguments={
'string': 'string'
}
)
[REQUIRED]
The name of the DevEndpoint to be updated.
The list of public keys for the DevEndpoint to use.
The list of public keys to be deleted from the DevEndpoint .
Custom Python or Java libraries to be loaded in the DevEndpoint .
The paths to one or more Python libraries in an Amazon Simple Storage Service (Amazon S3) bucket that should be loaded in your DevEndpoint . Multiple values must be complete paths separated by a comma.
Note
You can only use pure Python libraries with a DevEndpoint . Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.
The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint .
Note
You can only use pure Java/Scala libraries with a DevEndpoint .
The list of argument keys to be deleted from the map of arguments used to configure the DevEndpoint .
The map of arguments to add the map of arguments used to configure the DevEndpoint .
Valid arguments are:
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates an existing job definition.
See also: AWS API Documentation
Request Syntax
response = client.update_job(
JobName='string',
JobUpdate={
'Description': 'string',
'LogUri': 'string',
'Role': 'string',
'ExecutionProperty': {
'MaxConcurrentRuns': 123
},
'Command': {
'Name': 'string',
'ScriptLocation': 'string',
'PythonVersion': 'string'
},
'DefaultArguments': {
'string': 'string'
},
'NonOverridableArguments': {
'string': 'string'
},
'Connections': {
'Connections': [
'string',
]
},
'MaxRetries': 123,
'AllocatedCapacity': 123,
'Timeout': 123,
'MaxCapacity': 123.0,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'NumberOfWorkers': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'GlueVersion': 'string'
}
)
[REQUIRED]
The name of the job definition to update.
[REQUIRED]
Specifies the values with which to update the job definition.
Description of the job being defined.
This field is reserved for future use.
The name or Amazon Resource Name (ARN) of the IAM role associated with this job (required).
An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.
The JobCommand that runs this job (required).
The name of the job command. For an Apache Spark ETL job, this must be glueetl . For a Python shell job, it must be pythonshell . For an Apache Spark streaming ETL job, this must be gluestreaming .
Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.
The Python version being used to run a Python shell job. Allowed values are 2 or 3.
The default arguments for this job.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
Non-overridable arguments for this job, specified as name-value pairs.
The connections used for this job.
A list of connections used by the job.
The maximum number of times to retry this job if it fails.
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this job. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Do not set Max Capacity if using WorkerType and NumberOfWorkers .
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity . Instead, you should specify a Worker type and the Number of workers .
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
The name of the SecurityConfiguration structure to be used with this job.
Specifies the configuration properties of a job notification.
After a job run starts, the number of minutes to wait before sending a job run delay notification.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
dict
Response Syntax
{
'JobName': 'string'
}
Response Structure
(dict) --
JobName (string) --
Returns the name of the updated job definition.
Exceptions
Updates an existing machine learning transform. Call this operation to tune the algorithm parameters to achieve better results.
After calling this operation, you can call the StartMLEvaluationTaskRun operation to assess how well your new parameters achieved your goals (such as improving the quality of your machine learning transform, or making it more cost-effective).
See also: AWS API Documentation
Request Syntax
response = client.update_ml_transform(
TransformId='string',
Name='string',
Description='string',
Parameters={
'TransformType': 'FIND_MATCHES',
'FindMatchesParameters': {
'PrimaryKeyColumnName': 'string',
'PrecisionRecallTradeoff': 123.0,
'AccuracyCostTradeoff': 123.0,
'EnforceProvidedLabels': True|False
}
},
Role='string',
GlueVersion='string',
MaxCapacity=123.0,
WorkerType='Standard'|'G.1X'|'G.2X',
NumberOfWorkers=123,
Timeout=123,
MaxRetries=123
)
[REQUIRED]
A unique identifier that was generated when the transform was created.
The configuration parameters that are specific to the transform type (algorithm) used. Conditionally dependent on the transform type.
The type of machine learning transform.
For information about the types of machine learning transforms, see Creating Machine Learning Transforms .
The parameters for the find matches algorithm.
The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.
The precision metric indicates how often your model is correct when it predicts a match.
The recall metric indicates that for an actual match, how often your model predicts the match.
The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate FindMatches transform, sometimes with unacceptable accuracy.
Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
Cost measures how many compute resources, and thus money, are consumed to run the transform.
The value to switch on or off to force the output to match the provided labels from users. If the value is True , the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False , the find matches transform does not ensure all the labels provided are respected, and the results rely on the trained model.
Note that setting this value to true may increase the conflation execution time.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
When the WorkerType field is set to a value other than Standard , the MaxCapacity field is set automatically and becomes read-only.
The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
dict
Response Syntax
{
'TransformId': 'string'
}
Response Structure
(dict) --
TransformId (string) --
The unique identifier for the transform that was updated.
Exceptions
Updates a partition.
See also: AWS API Documentation
Request Syntax
response = client.update_partition(
CatalogId='string',
DatabaseName='string',
TableName='string',
PartitionValueList=[
'string',
],
PartitionInput={
'Values': [
'string',
],
'LastAccessTime': datetime(2015, 1, 1),
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'Parameters': {
'string': 'string'
},
'LastAnalyzedTime': datetime(2015, 1, 1)
}
)
[REQUIRED]
The name of the catalog database in which the table in question resides.
[REQUIRED]
The name of the table in which the partition to be updated is located.
[REQUIRED]
List of partition key values that define the partition to update.
[REQUIRED]
The new partition object to update the partition to.
The Values property can't be changed. If you want to change the partition key values for a partition, delete and recreate the partition.
The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.
The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.
The last time at which the partition was accessed.
Provides information about the physical location where the partition is stored.
A list of the Columns in the table.
A column in a Table .
The name of the Column .
The data type of the Column .
A free-form text comment.
These key-value pairs define properties associated with the column.
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
True if the data in the table is compressed, or False if not.
Must be specified if the table contains any dimension columns.
The serialization/deserialization (SerDe) information.
Name of the SerDe.
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
These key-value pairs define initialization parameters for the SerDe.
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
A list specifying the sort order of each bucket in the table.
Specifies the sort order of a sorted column.
The name of the column.
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
The user-supplied properties in key-value form.
The information about values that appear frequently in a column (skewed values).
A list of names of columns that contain skewed values.
A list of values that appear so frequently as to be considered skewed.
A mapping of skewed values to the columns that contain them.
True if the table data is stored in subdirectories, or False if not.
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
The version number of the schema.
These key-value pairs define partition parameters.
The last time at which column statistics were computed for this partition.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates an existing registry which is used to hold a collection of schemas. The updated properties relate to the registry, and do not modify any of the schemas within the registry.
See also: AWS API Documentation
Request Syntax
response = client.update_registry(
RegistryId={
'RegistryName': 'string',
'RegistryArn': 'string'
},
Description='string'
)
[REQUIRED]
This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
Name of the registry. Used only for lookup. One of RegistryArn or RegistryName has to be provided.
Arn of the registry to be updated. One of RegistryArn or RegistryName has to be provided.
[REQUIRED]
A description of the registry. If description is not provided, this field will not be updated.
dict
Response Syntax
{
'RegistryName': 'string',
'RegistryArn': 'string'
}
Response Structure
(dict) --
RegistryName (string) --
The name of the updated registry.
RegistryArn (string) --
The Amazon Resource name (ARN) of the updated registry.
Exceptions
Updates the description, compatibility setting, or version checkpoint for a schema set.
For updating the compatibility setting, the call will not validate compatibility for the entire set of schema versions with the new compatibility setting. If the value for Compatibility is provided, the VersionNumber (a checkpoint) is also required. The API will validate the checkpoint version number for consistency.
If the value for the VersionNumber (checkpoint) is provided, Compatibility is optional and this can be used to set/reset a checkpoint for the schema.
This update will happen only if the schema is in the AVAILABLE state.
See also: AWS API Documentation
Request Syntax
response = client.update_schema(
SchemaId={
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
SchemaVersionNumber={
'LatestVersion': True|False,
'VersionNumber': 123
},
Compatibility='NONE'|'DISABLED'|'BACKWARD'|'BACKWARD_ALL'|'FORWARD'|'FORWARD_ALL'|'FULL'|'FULL_ALL',
Description='string'
)
[REQUIRED]
This is a wrapper structure to contain schema identity fields. The structure contains:
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
Version number required for check pointing. One of VersionNumber or Compatibility has to be provided.
The latest version available for the schema.
The version number of the schema.
dict
Response Syntax
{
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
}
Response Structure
(dict) --
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema.
SchemaName (string) --
The name of the schema.
RegistryName (string) --
The name of the registry that contains the schema.
Exceptions
Updates a metadata table in the Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.update_table(
CatalogId='string',
DatabaseName='string',
TableInput={
'Name': 'string',
'Description': 'string',
'Owner': 'string',
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string'
}
},
SkipArchive=True|False
)
[REQUIRED]
The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.
[REQUIRED]
An updated TableInput object to define the metadata table in the catalog.
The table name. For Hive compatibility, this is folded to lowercase when it is stored.
A description of the table.
The table owner.
The last time that the table was accessed.
The last time that column statistics were computed for this table.
The retention time for this table.
A storage descriptor containing information about the physical storage of this table.
A list of the Columns in the table.
A column in a Table .
The name of the Column .
The data type of the Column .
A free-form text comment.
These key-value pairs define properties associated with the column.
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
True if the data in the table is compressed, or False if not.
Must be specified if the table contains any dimension columns.
The serialization/deserialization (SerDe) information.
Name of the SerDe.
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
These key-value pairs define initialization parameters for the SerDe.
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
A list specifying the sort order of each bucket in the table.
Specifies the sort order of a sorted column.
The name of the column.
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
The user-supplied properties in key-value form.
The information about values that appear frequently in a column (skewed values).
A list of names of columns that contain skewed values.
A list of values that appear so frequently as to be considered skewed.
A mapping of skewed values to the columns that contain them.
True if the table data is stored in subdirectories, or False if not.
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
The version number of the schema.
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": []
A column in a Table .
The name of the Column .
The data type of the Column .
A free-form text comment.
These key-value pairs define properties associated with the column.
If the table is a view, the original text of the view; otherwise null .
If the table is a view, the expanded text of the view; otherwise null .
The type of this table (EXTERNAL_TABLE , VIRTUAL_VIEW , etc.).
These key-value pairs define properties associated with the table.
A TableIdentifier structure that describes a target table for resource linking.
The ID of the Data Catalog in which the table resides.
The name of the catalog database that contains the target table.
The name of the target table.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates a trigger definition.
See also: AWS API Documentation
Request Syntax
response = client.update_trigger(
Name='string',
TriggerUpdate={
'Name': 'string',
'Description': 'string',
'Schedule': 'string',
'Actions': [
{
'JobName': 'string',
'Arguments': {
'string': 'string'
},
'Timeout': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'CrawlerName': 'string'
},
],
'Predicate': {
'Logical': 'AND'|'ANY',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'CrawlerName': 'string',
'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'
},
]
},
'EventBatchingCondition': {
'BatchSize': 123,
'BatchWindow': 123
}
}
)
[REQUIRED]
The name of the trigger to update.
[REQUIRED]
The new values with which to update the trigger.
Reserved for future use.
A description of this trigger.
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
The actions initiated by this trigger.
Defines an action to be initiated by a trigger.
The name of a job to be run.
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
The name of the SecurityConfiguration structure to be used with this action.
Specifies configuration properties of a job run notification.
After a job run starts, the number of minutes to wait before sending a job run delay notification.
The name of the crawler to be used with this action.
The predicate of this trigger, which defines when it will fire.
An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
A list of the conditions that determine when the trigger will fire.
Defines a condition under which a trigger fires.
A logical operator.
The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .
The name of the crawler to which this condition applies.
The state of the crawler to which this condition applies.
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
dict
Response Syntax
{
'Trigger': {
'Name': 'string',
'WorkflowName': 'string',
'Id': 'string',
'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND'|'EVENT',
'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
'Description': 'string',
'Schedule': 'string',
'Actions': [
{
'JobName': 'string',
'Arguments': {
'string': 'string'
},
'Timeout': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'CrawlerName': 'string'
},
],
'Predicate': {
'Logical': 'AND'|'ANY',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'CrawlerName': 'string',
'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'
},
]
},
'EventBatchingCondition': {
'BatchSize': 123,
'BatchWindow': 123
}
}
}
Response Structure
(dict) --
Trigger (dict) --
The resulting trigger definition.
Name (string) --
The name of the trigger.
WorkflowName (string) --
The name of the workflow associated with the trigger.
Id (string) --
Reserved for future use.
Type (string) --
The type of trigger that this is.
State (string) --
The current state of the trigger.
Description (string) --
A description of this trigger.
Schedule (string) --
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
Actions (list) --
The actions initiated by this trigger.
(dict) --
Defines an action to be initiated by a trigger.
JobName (string) --
The name of a job to be run.
Arguments (dict) --
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this action.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
CrawlerName (string) --
The name of the crawler to be used with this action.
Predicate (dict) --
The predicate of this trigger, which defines when it will fire.
Logical (string) --
An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
Conditions (list) --
A list of the conditions that determine when the trigger will fire.
(dict) --
Defines a condition under which a trigger fires.
LogicalOperator (string) --
A logical operator.
JobName (string) --
The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
State (string) --
The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .
CrawlerName (string) --
The name of the crawler to which this condition applies.
CrawlState (string) --
The state of the crawler to which this condition applies.
EventBatchingCondition (dict) --
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize (integer) --
Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow (integer) --
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
Exceptions
Updates an existing function definition in the Data Catalog.
See also: AWS API Documentation
Request Syntax
response = client.update_user_defined_function(
CatalogId='string',
DatabaseName='string',
FunctionName='string',
FunctionInput={
'FunctionName': 'string',
'ClassName': 'string',
'OwnerName': 'string',
'OwnerType': 'USER'|'ROLE'|'GROUP',
'ResourceUris': [
{
'ResourceType': 'JAR'|'FILE'|'ARCHIVE',
'Uri': 'string'
},
]
}
)
[REQUIRED]
The name of the catalog database where the function to be updated is located.
[REQUIRED]
The name of the function.
[REQUIRED]
A FunctionInput object that redefines the function in the Data Catalog.
The name of the function.
The Java class that contains the function code.
The owner of the function.
The owner type.
The resource URIs for the function.
The URIs for function resources.
The type of the resource.
The URI for accessing the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates an existing workflow.
See also: AWS API Documentation
Request Syntax
response = client.update_workflow(
Name='string',
Description='string',
DefaultRunProperties={
'string': 'string'
},
MaxConcurrentRuns=123
)
[REQUIRED]
Name of the workflow to be updated.
A collection of properties to be used as part of each execution of the workflow.
dict
Response Syntax
{
'Name': 'string'
}
Response Structure
(dict) --
Name (string) --
The name of the workflow which was specified in input.
Exceptions
The available paginators are:
paginator = client.get_paginator('get_classifiers')
Creates an iterator that will paginate through responses from Glue.Client.get_classifiers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Classifiers': [
{
'GrokClassifier': {
'Name': 'string',
'Classification': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Version': 123,
'GrokPattern': 'string',
'CustomPatterns': 'string'
},
'XMLClassifier': {
'Name': 'string',
'Classification': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Version': 123,
'RowTag': 'string'
},
'JsonClassifier': {
'Name': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Version': 123,
'JsonPath': 'string'
},
'CsvClassifier': {
'Name': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Version': 123,
'Delimiter': 'string',
'QuoteSymbol': 'string',
'ContainsHeader': 'UNKNOWN'|'PRESENT'|'ABSENT',
'Header': [
'string',
],
'DisableValueTrimming': True|False,
'AllowSingleColumn': True|False
}
},
],
}
Response Structure
The requested list of classifier objects.
Classifiers are triggered during a crawl task. A classifier checks whether a given file is in a format it can handle. If it is, the classifier creates a schema in the form of a StructType object that matches that data format.
You can use the standard classifiers that Glue provides, or you can write your own classifiers to best categorize your data sources and specify the appropriate schemas to use for them. A classifier can be a grok classifier, an XML classifier, a JSON classifier, or a custom CSV classifier, as specified in one of the fields in the Classifier object.
A classifier that uses grok .
The name of the classifier.
An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.
The time that this classifier was registered.
The time that this classifier was last updated.
The version of this classifier.
The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers .
Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers .
A classifier for XML content.
The name of the classifier.
An identifier of the data format that the classifier matches.
The time that this classifier was registered.
The time that this classifier was last updated.
The version of this classifier.
The XML tag designating the element that contains each record in an XML document being parsed. This can't identify a self-closing element (closed by /> ). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).
A classifier for JSON content.
The name of the classifier.
The time that this classifier was registered.
The time that this classifier was last updated.
The version of this classifier.
A JsonPath string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers .
A classifier for comma-separated values (CSV).
The name of the classifier.
The time that this classifier was registered.
The time that this classifier was last updated.
The version of this classifier.
A custom symbol to denote what separates each column entry in the row.
A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
Indicates whether the CSV file contains a header.
A list of strings representing column names.
Specifies not to trim values before identifying the type of column values. The default value is true .
Enables the processing of files that contain only one column.
paginator = client.get_paginator('get_connections')
Creates an iterator that will paginate through responses from Glue.Client.get_connections().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CatalogId='string',
Filter={
'MatchCriteria': [
'string',
],
'ConnectionType': 'JDBC'|'SFTP'|'MONGODB'|'KAFKA'|'NETWORK'|'MARKETPLACE'|'CUSTOM'
},
HidePassword=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A filter that controls which connections are returned.
A criteria string that must match the criteria recorded in the connection definition for that connection definition to be returned.
The type of connections to return. Currently, SFTP is not supported.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ConnectionList': [
{
'Name': 'string',
'Description': 'string',
'ConnectionType': 'JDBC'|'SFTP'|'MONGODB'|'KAFKA'|'NETWORK'|'MARKETPLACE'|'CUSTOM',
'MatchCriteria': [
'string',
],
'ConnectionProperties': {
'string': 'string'
},
'PhysicalConnectionRequirements': {
'SubnetId': 'string',
'SecurityGroupIdList': [
'string',
],
'AvailabilityZone': 'string'
},
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'LastUpdatedBy': 'string'
},
],
}
Response Structure
(dict) --
ConnectionList (list) --
A list of requested connection definitions.
(dict) --
Defines a connection to a data source.
Name (string) --
The name of the connection definition.
Description (string) --
The description of the connection.
ConnectionType (string) --
The type of the connection. Currently, SFTP is not supported.
MatchCriteria (list) --
A list of criteria that can be used in selecting this connection.
ConnectionProperties (dict) --
These key-value pairs define parameters for the connection:
PhysicalConnectionRequirements (dict) --
A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to make this connection successfully.
SubnetId (string) --
The subnet ID used by the connection.
SecurityGroupIdList (list) --
The security group ID list used by the connection.
AvailabilityZone (string) --
The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.
CreationTime (datetime) --
The time that this connection definition was created.
LastUpdatedTime (datetime) --
The last time that this connection definition was updated.
LastUpdatedBy (string) --
The user, group, or role that last updated this connection definition.
paginator = client.get_paginator('get_crawler_metrics')
Creates an iterator that will paginate through responses from Glue.Client.get_crawler_metrics().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CrawlerNameList=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A list of the names of crawlers about which to retrieve metrics.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'CrawlerMetricsList': [
{
'CrawlerName': 'string',
'TimeLeftSeconds': 123.0,
'StillEstimating': True|False,
'LastRuntimeSeconds': 123.0,
'MedianRuntimeSeconds': 123.0,
'TablesCreated': 123,
'TablesUpdated': 123,
'TablesDeleted': 123
},
],
}
Response Structure
(dict) --
CrawlerMetricsList (list) --
A list of metrics for the specified crawler.
(dict) --
Metrics for a specified crawler.
CrawlerName (string) --
The name of the crawler.
TimeLeftSeconds (float) --
The estimated time left to complete a running crawl.
StillEstimating (boolean) --
True if the crawler is still estimating how long it will take to complete this run.
LastRuntimeSeconds (float) --
The duration of the crawler's most recent run, in seconds.
MedianRuntimeSeconds (float) --
The median duration of this crawler's runs, in seconds.
TablesCreated (integer) --
The number of tables created by this crawler.
TablesUpdated (integer) --
The number of tables updated by this crawler.
TablesDeleted (integer) --
The number of tables deleted by this crawler.
paginator = client.get_paginator('get_crawlers')
Creates an iterator that will paginate through responses from Glue.Client.get_crawlers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Crawlers': [
{
'Name': 'string',
'Role': 'string',
'Targets': {
'S3Targets': [
{
'Path': 'string',
'Exclusions': [
'string',
],
'ConnectionName': 'string',
'SampleSize': 123,
'EventQueueArn': 'string',
'DlqEventQueueArn': 'string'
},
],
'JdbcTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'Exclusions': [
'string',
]
},
],
'MongoDBTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'ScanAll': True|False
},
],
'DynamoDBTargets': [
{
'Path': 'string',
'scanAll': True|False,
'scanRate': 123.0
},
],
'CatalogTargets': [
{
'DatabaseName': 'string',
'Tables': [
'string',
]
},
]
},
'DatabaseName': 'string',
'Description': 'string',
'Classifiers': [
'string',
],
'RecrawlPolicy': {
'RecrawlBehavior': 'CRAWL_EVERYTHING'|'CRAWL_NEW_FOLDERS_ONLY'|'CRAWL_EVENT_MODE'
},
'SchemaChangePolicy': {
'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
},
'LineageConfiguration': {
'CrawlerLineageSettings': 'ENABLE'|'DISABLE'
},
'State': 'READY'|'RUNNING'|'STOPPING',
'TablePrefix': 'string',
'Schedule': {
'ScheduleExpression': 'string',
'State': 'SCHEDULED'|'NOT_SCHEDULED'|'TRANSITIONING'
},
'CrawlElapsedTime': 123,
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'LastCrawl': {
'Status': 'SUCCEEDED'|'CANCELLED'|'FAILED',
'ErrorMessage': 'string',
'LogGroup': 'string',
'LogStream': 'string',
'MessagePrefix': 'string',
'StartTime': datetime(2015, 1, 1)
},
'Version': 123,
'Configuration': 'string',
'CrawlerSecurityConfiguration': 'string'
},
],
}
Response Structure
A list of crawler metadata.
Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source in the Glue Data Catalog.
The name of the crawler.
The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
A collection of targets to crawl.
Specifies Amazon Simple Storage Service (Amazon S3) targets.
Specifies a data store in Amazon Simple Storage Service (Amazon S3).
The path to the Amazon S3 target.
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .
The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs .
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue .
Specifies JDBC targets.
Specifies a JDBC data store to crawl.
The name of the connection to use to connect to the JDBC target.
The path of the JDBC target.
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .
Specifies Amazon DocumentDB or MongoDB targets.
Specifies an Amazon DocumentDB or MongoDB data store to crawl.
The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
The path of the Amazon DocumentDB or MongoDB target (database/collection).
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .
Specifies Amazon DynamoDB targets.
Specifies an Amazon DynamoDB table to crawl.
The name of the DynamoDB table to crawl.
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .
The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
Specifies Glue Data Catalog targets.
Specifies an Glue Data Catalog target.
The name of the database to be synchronized.
A list of the tables to be synchronized.
The name of the database in which the crawler's output is stored.
A description of the crawler.
A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.
A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
The policy that specifies update and delete behaviors for the crawler.
The update behavior when the crawler finds a changed schema.
The deletion behavior when the crawler finds a deleted object.
A configuration that specifies whether data lineage is enabled for the crawler.
Specifies whether data lineage is enabled for the crawler. Valid values are:
Indicates whether the crawler is running, or whether a run is pending.
The prefix added to the names of tables that are created.
For scheduled crawlers, the schedule when the crawler runs.
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
The state of the schedule.
If the crawler is running, contains the total time elapsed since the last crawl began.
The time that the crawler was created.
The time that the crawler was last updated.
The status of the last crawl, and potentially error information if an error occurred.
Status of the last crawl.
If an error occurred, the error information about the last crawl.
The log group for the last crawl.
The log stream for the last crawl.
The prefix for a message about this crawl.
The time at which the crawl started.
The version of the crawler.
Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Include and Exclude Patterns .
The name of the SecurityConfiguration structure to be used by this crawler.
paginator = client.get_paginator('get_databases')
Creates an iterator that will paginate through responses from Glue.Client.get_databases().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CatalogId='string',
ResourceShareType='FOREIGN'|'ALL',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Allows you to specify that you want to list the databases shared with your account. The allowable values are FOREIGN or ALL .
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DatabaseList': [
{
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'Parameters': {
'string': 'string'
},
'CreateTime': datetime(2015, 1, 1),
'CreateTableDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'TargetDatabase': {
'CatalogId': 'string',
'DatabaseName': 'string'
},
'CatalogId': 'string'
},
],
}
Response Structure
(dict) --
DatabaseList (list) --
A list of Database objects from the specified catalog.
(dict) --
The Database object represents a logical grouping of tables that might reside in a Hive metastore or an RDBMS.
Name (string) --
The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
Description (string) --
A description of the database.
LocationUri (string) --
The location of the database (for example, an HDFS path).
Parameters (dict) --
These key-value pairs define parameters and properties of the database.
CreateTime (datetime) --
The time at which the metadata database was created in the catalog.
CreateTableDefaultPermissions (list) --
Creates a set of default permissions on the table for principals.
(dict) --
Permissions granted to a principal.
Principal (dict) --
The principal who is granted permissions.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
Permissions (list) --
The permissions that are granted to the principal.
TargetDatabase (dict) --
A DatabaseIdentifier structure that describes a target database for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the database resides.
DatabaseName (string) --
The name of the catalog database.
CatalogId (string) --
The ID of the Data Catalog in which the database resides.
paginator = client.get_paginator('get_dev_endpoints')
Creates an iterator that will paginate through responses from Glue.Client.get_dev_endpoints().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'DevEndpoints': [
{
'EndpointName': 'string',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string',
'YarnEndpointAddress': 'string',
'PrivateAddress': 'string',
'ZeppelinRemoteSparkInterpreterPort': 123,
'PublicAddress': 'string',
'Status': 'string',
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'GlueVersion': 'string',
'NumberOfWorkers': 123,
'NumberOfNodes': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'ExtraPythonLibsS3Path': 'string',
'ExtraJarsS3Path': 'string',
'FailureReason': 'string',
'LastUpdateStatus': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastModifiedTimestamp': datetime(2015, 1, 1),
'PublicKey': 'string',
'PublicKeys': [
'string',
],
'SecurityConfiguration': 'string',
'Arguments': {
'string': 'string'
}
},
],
}
Response Structure
A list of DevEndpoint definitions.
A development endpoint where a developer can remotely debug extract, transform, and load (ETL) scripts.
The name of the DevEndpoint .
The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint .
A list of security group identifiers used in this DevEndpoint .
The subnet ID for this DevEndpoint .
The YARN endpoint address used by this DevEndpoint .
A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your VPC.
The Apache Zeppelin port for the remote Apache Spark interpreter.
The public IP address used by this DevEndpoint . The PublicAddress field is present only when you create a non-virtual private cloud (VPC) DevEndpoint .
The current status of this DevEndpoint .
The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
The number of workers of a defined workerType that are allocated to the development endpoint.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint .
The AWS Availability Zone where this DevEndpoint is located.
The ID of the virtual private cloud (VPC) used by this DevEndpoint .
The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint . Multiple values must be complete paths separated by a comma.
Note
You can only use pure Python libraries with a DevEndpoint . Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.
The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint .
Note
You can only use pure Java/Scala libraries with a DevEndpoint .
The reason for a current failure in this DevEndpoint .
The status of the last update.
The point in time at which this DevEndpoint was created.
The point in time at which this DevEndpoint was last modified.
The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.
A list of public keys to be used by the DevEndpoints for authentication. Using this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.
Note
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint API operation with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
The name of the SecurityConfiguration structure to be used with this DevEndpoint .
A map of arguments used to configure the DevEndpoint .
Valid arguments are:
You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
paginator = client.get_paginator('get_job_runs')
Creates an iterator that will paginate through responses from Glue.Client.get_job_runs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
JobName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the job definition for which to retrieve all job runs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'JobRuns': [
{
'Id': 'string',
'Attempt': 123,
'PreviousRunId': 'string',
'TriggerName': 'string',
'JobName': 'string',
'StartedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'Arguments': {
'string': 'string'
},
'ErrorMessage': 'string',
'PredecessorRuns': [
{
'JobName': 'string',
'RunId': 'string'
},
],
'AllocatedCapacity': 123,
'ExecutionTime': 123,
'Timeout': 123,
'MaxCapacity': 123.0,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'NumberOfWorkers': 123,
'SecurityConfiguration': 'string',
'LogGroupName': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'GlueVersion': 'string'
},
],
}
Response Structure
(dict) --
JobRuns (list) --
A list of job-run metadata objects.
(dict) --
Contains information about a job run.
Id (string) --
The ID of this job run.
Attempt (integer) --
The number of the attempt to run this job.
PreviousRunId (string) --
The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.
TriggerName (string) --
The name of the trigger that started this job run.
JobName (string) --
The name of the job definition being used in this run.
StartedOn (datetime) --
The date and time at which this job run was started.
LastModifiedOn (datetime) --
The last time that this job run was modified.
CompletedOn (datetime) --
The date and time that this job run completed.
JobRunState (string) --
The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses .
Arguments (dict) --
The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
ErrorMessage (string) --
An error message associated with this job run.
PredecessorRuns (list) --
A list of predecessors to this job run.
(dict) --
A job run that was used in the predicate of a conditional trigger that triggered this job run.
JobName (string) --
The name of the job definition used by the predecessor job run.
RunId (string) --
The job-run ID of the predecessor job run.
AllocatedCapacity (integer) --
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
ExecutionTime (integer) --
The amount of time (in seconds) that the job run consumed resources.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
MaxCapacity (float) --
The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Do not set Max Capacity if using WorkerType and NumberOfWorkers .
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:
WorkerType (string) --
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
NumberOfWorkers (integer) --
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this job run.
LogGroupName (string) --
The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
GlueVersion (string) --
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
paginator = client.get_paginator('get_jobs')
Creates an iterator that will paginate through responses from Glue.Client.get_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Jobs': [
{
'Name': 'string',
'Description': 'string',
'LogUri': 'string',
'Role': 'string',
'CreatedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'ExecutionProperty': {
'MaxConcurrentRuns': 123
},
'Command': {
'Name': 'string',
'ScriptLocation': 'string',
'PythonVersion': 'string'
},
'DefaultArguments': {
'string': 'string'
},
'NonOverridableArguments': {
'string': 'string'
},
'Connections': {
'Connections': [
'string',
]
},
'MaxRetries': 123,
'AllocatedCapacity': 123,
'Timeout': 123,
'MaxCapacity': 123.0,
'WorkerType': 'Standard'|'G.1X'|'G.2X',
'NumberOfWorkers': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'GlueVersion': 'string'
},
],
}
Response Structure
A list of job definitions.
Specifies a job definition.
The name you assign to this job definition.
A description of the job.
This field is reserved for future use.
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
The time and date that this job definition was created.
The last point in time when this job definition was modified.
An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.
The JobCommand that runs this job.
The name of the job command. For an Apache Spark ETL job, this must be glueetl . For a Python shell job, it must be pythonshell . For an Apache Spark streaming ETL job, this must be gluestreaming .
Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.
The Python version being used to run a Python shell job. Allowed values are 2 or 3.
The default arguments for this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
Non-overridable arguments for this job, specified as name-value pairs.
The connections used for this job.
A list of connections used by the job.
The maximum number of times to retry this job after a JobRun fails.
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .
Do not set Max Capacity if using WorkerType and NumberOfWorkers .
The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity . Instead, you should specify a Worker type and the Number of workers .
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
The name of the SecurityConfiguration structure to be used with this job.
Specifies configuration properties of a job notification.
After a job run starts, the number of minutes to wait before sending a job run delay notification.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
paginator = client.get_paginator('get_partition_indexes')
Creates an iterator that will paginate through responses from Glue.Client.get_partition_indexes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CatalogId='string',
DatabaseName='string',
TableName='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
Specifies the name of a database from which you want to retrieve partition indexes.
[REQUIRED]
Specifies the name of a table for which you want to retrieve the partition indexes.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PartitionIndexDescriptorList': [
{
'IndexName': 'string',
'Keys': [
{
'Name': 'string',
'Type': 'string'
},
],
'IndexStatus': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
'BackfillErrors': [
{
'Code': 'ENCRYPTED_PARTITION_ERROR'|'INTERNAL_ERROR'|'INVALID_PARTITION_TYPE_DATA_ERROR'|'MISSING_PARTITION_VALUE_ERROR'|'UNSUPPORTED_PARTITION_CHARACTER_ERROR',
'Partitions': [
{
'Values': [
'string',
]
},
]
},
]
},
],
}
Response Structure
(dict) --
PartitionIndexDescriptorList (list) --
A list of index descriptors.
(dict) --
A descriptor for a partition index in a table.
IndexName (string) --
The name of the partition index.
Keys (list) --
A list of one or more keys, as KeySchemaElement structures, for the partition index.
(dict) --
A partition key pair consisting of a name and a type.
Name (string) --
The name of a partition key.
Type (string) --
The type of a partition key.
IndexStatus (string) --
The status of the partition index.
The possible statuses are:
BackfillErrors (list) --
A list of errors that can occur when registering partition indexes for an existing table.
(dict) --
A list of errors that can occur when registering partition indexes for an existing table.
These errors give the details about why an index registration failed and provide a limited number of partitions in the response, so that you can fix the partitions at fault and try registering the index again. The most common set of errors that can occur are categorized as follows:
Code (string) --
The error code for an error that occurred when registering partition indexes for an existing table.
Partitions (list) --
A list of a limited number of partitions in the response.
(dict) --
Contains a list of values defining partitions.
Values (list) --
The list of values.
paginator = client.get_paginator('get_partitions')
Creates an iterator that will paginate through responses from Glue.Client.get_partitions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CatalogId='string',
DatabaseName='string',
TableName='string',
Expression='string',
Segment={
'SegmentNumber': 123,
'TotalSegments': 123
},
ExcludeColumnSchema=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the catalog database where the partitions reside.
[REQUIRED]
The name of the partitions' table.
An expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser JSQLParser parses the expression.
Operators : The following are the operators that you can use in the Expression API call:=
Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume 'variable a' holds 10 and 'variable b' holds 20.
(a = b) is not true.
< >
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
>
Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
<
Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
>=
Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a >= b) is not true.
<=
Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a <= b) is true.
AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL
Logical operators.
Supported Partition Key Types : The following are the supported partition keys.
If an type is encountered that is not valid, an exception is thrown.
The following list shows the valid operators on each type. When you define a crawler, the partitionKey type is created as a STRING , to be compatible with the catalog partitions.
Sample API Call :
The segment of the table's partitions to scan in this request.
The zero-based index number of the segment. For example, if the total number of segments is 4, SegmentNumber values range from 0 through 3.
The total number of segments.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Partitions': [
{
'Values': [
'string',
],
'DatabaseName': 'string',
'TableName': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'Parameters': {
'string': 'string'
},
'LastAnalyzedTime': datetime(2015, 1, 1),
'CatalogId': 'string'
},
],
}
Response Structure
(dict) --
Partitions (list) --
A list of requested partitions.
(dict) --
Represents a slice of table data.
Values (list) --
The values of the partition.
DatabaseName (string) --
The name of the catalog database in which to create the partition.
TableName (string) --
The name of the database table in which to create the partition.
CreationTime (datetime) --
The time at which the partition was created.
LastAccessTime (datetime) --
The last time at which the partition was accessed.
StorageDescriptor (dict) --
Provides information about the physical location where the partition is stored.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
Parameters (dict) --
The user-supplied properties in key-value form.
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
Parameters (dict) --
These key-value pairs define partition parameters.
LastAnalyzedTime (datetime) --
The last time at which column statistics were computed for this partition.
CatalogId (string) --
The ID of the Data Catalog in which the partition resides.
paginator = client.get_paginator('get_resource_policies')
Creates an iterator that will paginate through responses from Glue.Client.get_resource_policies().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'GetResourcePoliciesResponseList': [
{
'PolicyInJson': 'string',
'PolicyHash': 'string',
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1)
},
],
}
Response Structure
A list of the individual resource policies and the account-level resource policy.
A structure for returning a resource policy.
Contains the requested policy document, in JSON format.
Contains the hash value associated with this policy.
The date and time at which the policy was created.
The date and time at which the policy was last updated.
paginator = client.get_paginator('get_security_configurations')
Creates an iterator that will paginate through responses from Glue.Client.get_security_configurations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'SecurityConfigurations': [
{
'Name': 'string',
'CreatedTimeStamp': datetime(2015, 1, 1),
'EncryptionConfiguration': {
'S3Encryption': [
{
'S3EncryptionMode': 'DISABLED'|'SSE-KMS'|'SSE-S3',
'KmsKeyArn': 'string'
},
],
'CloudWatchEncryption': {
'CloudWatchEncryptionMode': 'DISABLED'|'SSE-KMS',
'KmsKeyArn': 'string'
},
'JobBookmarksEncryption': {
'JobBookmarksEncryptionMode': 'DISABLED'|'CSE-KMS',
'KmsKeyArn': 'string'
}
}
},
],
}
Response Structure
A list of security configurations.
Specifies a security configuration.
The name of the security configuration.
The time at which this security configuration was created.
The encryption configuration associated with this security configuration.
The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.
Specifies how Amazon Simple Storage Service (Amazon S3) data should be encrypted.
The encryption mode to use for Amazon S3 data.
The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
The encryption configuration for Amazon CloudWatch.
The encryption mode to use for CloudWatch data.
The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
The encryption configuration for job bookmarks.
The encryption mode to use for job bookmarks data.
The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
paginator = client.get_paginator('get_table_versions')
Creates an iterator that will paginate through responses from Glue.Client.get_table_versions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CatalogId='string',
DatabaseName='string',
TableName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
[REQUIRED]
The name of the table. For Hive compatibility, this name is entirely lowercase.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TableVersions': [
{
'Table': {
'Name': 'string',
'DatabaseName': 'string',
'Description': 'string',
'Owner': 'string',
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'CreatedBy': 'string',
'IsRegisteredWithLakeFormation': True|False,
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string'
},
'CatalogId': 'string'
},
'VersionId': 'string'
},
],
}
Response Structure
(dict) --
TableVersions (list) --
A list of strings identifying available versions of the specified table.
(dict) --
Specifies a version of a table.
Table (dict) --
The table in question.
Name (string) --
The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName (string) --
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description (string) --
A description of the table.
Owner (string) --
The owner of the table.
CreateTime (datetime) --
The time when the table definition was created in the Data Catalog.
UpdateTime (datetime) --
The last time that the table was updated.
LastAccessTime (datetime) --
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime (datetime) --
The last time that column statistics were computed for this table.
Retention (integer) --
The retention time for this table.
StorageDescriptor (dict) --
A storage descriptor containing information about the physical storage of this table.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
Parameters (dict) --
The user-supplied properties in key-value form.
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
PartitionKeys (list) --
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": []
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
ViewOriginalText (string) --
If the table is a view, the original text of the view; otherwise null .
ViewExpandedText (string) --
If the table is a view, the expanded text of the view; otherwise null .
TableType (string) --
The type of this table (EXTERNAL_TABLE , VIRTUAL_VIEW , etc.).
Parameters (dict) --
These key-value pairs define properties associated with the table.
CreatedBy (string) --
The person or entity who created the table.
IsRegisteredWithLakeFormation (boolean) --
Indicates whether the table has been registered with Lake Formation.
TargetTable (dict) --
A TableIdentifier structure that describes a target table for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
DatabaseName (string) --
The name of the catalog database that contains the target table.
Name (string) --
The name of the target table.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
VersionId (string) --
The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1.
paginator = client.get_paginator('get_tables')
Creates an iterator that will paginate through responses from Glue.Client.get_tables().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CatalogId='string',
DatabaseName='string',
Expression='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TableList': [
{
'Name': 'string',
'DatabaseName': 'string',
'Description': 'string',
'Owner': 'string',
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'CreatedBy': 'string',
'IsRegisteredWithLakeFormation': True|False,
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string'
},
'CatalogId': 'string'
},
],
}
Response Structure
(dict) --
TableList (list) --
A list of the requested Table objects.
(dict) --
Represents a collection of related data organized in columns and rows.
Name (string) --
The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName (string) --
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description (string) --
A description of the table.
Owner (string) --
The owner of the table.
CreateTime (datetime) --
The time when the table definition was created in the Data Catalog.
UpdateTime (datetime) --
The last time that the table was updated.
LastAccessTime (datetime) --
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime (datetime) --
The last time that column statistics were computed for this table.
Retention (integer) --
The retention time for this table.
StorageDescriptor (dict) --
A storage descriptor containing information about the physical storage of this table.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).
Parameters (dict) --
The user-supplied properties in key-value form.
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
PartitionKeys (list) --
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": []
(dict) --
A column in a Table .
Name (string) --
The name of the Column .
Type (string) --
The data type of the Column .
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
ViewOriginalText (string) --
If the table is a view, the original text of the view; otherwise null .
ViewExpandedText (string) --
If the table is a view, the expanded text of the view; otherwise null .
TableType (string) --
The type of this table (EXTERNAL_TABLE , VIRTUAL_VIEW , etc.).
Parameters (dict) --
These key-value pairs define properties associated with the table.
CreatedBy (string) --
The person or entity who created the table.
IsRegisteredWithLakeFormation (boolean) --
Indicates whether the table has been registered with Lake Formation.
TargetTable (dict) --
A TableIdentifier structure that describes a target table for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
DatabaseName (string) --
The name of the catalog database that contains the target table.
Name (string) --
The name of the target table.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
paginator = client.get_paginator('get_triggers')
Creates an iterator that will paginate through responses from Glue.Client.get_triggers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DependentJobName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Triggers': [
{
'Name': 'string',
'WorkflowName': 'string',
'Id': 'string',
'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND'|'EVENT',
'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
'Description': 'string',
'Schedule': 'string',
'Actions': [
{
'JobName': 'string',
'Arguments': {
'string': 'string'
},
'Timeout': 123,
'SecurityConfiguration': 'string',
'NotificationProperty': {
'NotifyDelayAfter': 123
},
'CrawlerName': 'string'
},
],
'Predicate': {
'Logical': 'AND'|'ANY',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
'CrawlerName': 'string',
'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'
},
]
},
'EventBatchingCondition': {
'BatchSize': 123,
'BatchWindow': 123
}
},
],
}
Response Structure
(dict) --
Triggers (list) --
A list of triggers for the specified job.
(dict) --
Information about a specific trigger.
Name (string) --
The name of the trigger.
WorkflowName (string) --
The name of the workflow associated with the trigger.
Id (string) --
Reserved for future use.
Type (string) --
The type of trigger that this is.
State (string) --
The current state of the trigger.
Description (string) --
A description of this trigger.
Schedule (string) --
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .
Actions (list) --
The actions initiated by this trigger.
(dict) --
Defines an action to be initiated by a trigger.
JobName (string) --
The name of a job to be run.
Arguments (dict) --
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
Timeout (integer) --
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
SecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used with this action.
NotificationProperty (dict) --
Specifies configuration properties of a job run notification.
NotifyDelayAfter (integer) --
After a job run starts, the number of minutes to wait before sending a job run delay notification.
CrawlerName (string) --
The name of the crawler to be used with this action.
Predicate (dict) --
The predicate of this trigger, which defines when it will fire.
Logical (string) --
An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
Conditions (list) --
A list of the conditions that determine when the trigger will fire.
(dict) --
Defines a condition under which a trigger fires.
LogicalOperator (string) --
A logical operator.
JobName (string) --
The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
State (string) --
The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .
CrawlerName (string) --
The name of the crawler to which this condition applies.
CrawlState (string) --
The state of the crawler to which this condition applies.
EventBatchingCondition (dict) --
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize (integer) --
Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow (integer) --
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
paginator = client.get_paginator('get_user_defined_functions')
Creates an iterator that will paginate through responses from Glue.Client.get_user_defined_functions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CatalogId='string',
DatabaseName='string',
Pattern='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
An optional function-name pattern string that filters the function definitions returned.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'UserDefinedFunctions': [
{
'FunctionName': 'string',
'DatabaseName': 'string',
'ClassName': 'string',
'OwnerName': 'string',
'OwnerType': 'USER'|'ROLE'|'GROUP',
'CreateTime': datetime(2015, 1, 1),
'ResourceUris': [
{
'ResourceType': 'JAR'|'FILE'|'ARCHIVE',
'Uri': 'string'
},
],
'CatalogId': 'string'
},
],
}
Response Structure
(dict) --
UserDefinedFunctions (list) --
A list of requested function definitions.
(dict) --
Represents the equivalent of a Hive user-defined function (UDF ) definition.
FunctionName (string) --
The name of the function.
DatabaseName (string) --
The name of the catalog database that contains the function.
ClassName (string) --
The Java class that contains the function code.
OwnerName (string) --
The owner of the function.
OwnerType (string) --
The owner type.
CreateTime (datetime) --
The time at which the function was created.
ResourceUris (list) --
The resource URIs for the function.
(dict) --
The URIs for function resources.
ResourceType (string) --
The type of the resource.
Uri (string) --
The URI for accessing the resource.
CatalogId (string) --
The ID of the Data Catalog in which the function resides.
paginator = client.get_paginator('list_registries')
Creates an iterator that will paginate through responses from Glue.Client.list_registries().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Registries': [
{
'RegistryName': 'string',
'RegistryArn': 'string',
'Description': 'string',
'Status': 'AVAILABLE'|'DELETING',
'CreatedTime': 'string',
'UpdatedTime': 'string'
},
],
}
Response Structure
An array of RegistryDetailedListItem objects containing minimal details of each registry.
A structure containing the details for a registry.
The name of the registry.
The Amazon Resource Name (ARN) of the registry.
A description of the registry.
The status of the registry.
The data the registry was created.
The date the registry was updated.
paginator = client.get_paginator('list_schema_versions')
Creates an iterator that will paginate through responses from Glue.Client.list_schema_versions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SchemaId={
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
This is a wrapper structure to contain schema identity fields. The structure contains:
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema. One of SchemaArn or SchemaName has to be provided.
The name of the schema registry that contains the schema.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Schemas': [
{
'SchemaArn': 'string',
'SchemaVersionId': 'string',
'VersionNumber': 123,
'Status': 'AVAILABLE'|'PENDING'|'FAILURE'|'DELETING',
'CreatedTime': 'string'
},
],
}
Response Structure
(dict) --
Schemas (list) --
An array of SchemaVersionList objects containing details of each schema version.
(dict) --
An object containing the details about a schema version.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema.
SchemaVersionId (string) --
The unique identifier of the schema version.
VersionNumber (integer) --
The version number of the schema.
Status (string) --
The status of the schema version.
CreatedTime (string) --
The date and time the schema version was created.
paginator = client.get_paginator('list_schemas')
Creates an iterator that will paginate through responses from Glue.Client.list_schemas().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
RegistryId={
'RegistryName': 'string',
'RegistryArn': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
Name of the registry. Used only for lookup. One of RegistryArn or RegistryName has to be provided.
Arn of the registry to be updated. One of RegistryArn or RegistryName has to be provided.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Schemas': [
{
'RegistryName': 'string',
'SchemaName': 'string',
'SchemaArn': 'string',
'Description': 'string',
'SchemaStatus': 'AVAILABLE'|'PENDING'|'DELETING',
'CreatedTime': 'string',
'UpdatedTime': 'string'
},
],
}
Response Structure
(dict) --
Schemas (list) --
An array of SchemaListItem objects containing details of each schema.
(dict) --
An object that contains minimal details for a schema.
RegistryName (string) --
the name of the registry where the schema resides.
SchemaName (string) --
The name of the schema.
SchemaArn (string) --
The Amazon Resource Name (ARN) for the schema.
Description (string) --
A description for the schema.
SchemaStatus (string) --
The status of the schema.
CreatedTime (string) --
The date and time that a schema was created.
UpdatedTime (string) --
The date and time that a schema was updated.