2017/08/14 - AWS Glue - 74 new api methods
Changes Update glue client to latest version
Retrieves the metadata for a given job run.
See also: AWS API Documentation
Request Syntax
client.get_job_run(
JobName='string',
RunId='string',
PredecessorsIncluded=True|False
)
string
[REQUIRED]
Name of the job being run.
string
[REQUIRED]
The ID of the job run.
boolean
A list of the predecessor runs to return as well.
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',
'Arguments': {
'string': 'string'
},
'ErrorMessage': 'string',
'PredecessorRuns': [
{
'JobName': 'string',
'RunId': 'string'
},
],
'AllocatedCapacity': 123
}
}
Response Structure
(dict) --
JobRun (dict) --
The requested job-run metadata.
Id (string) --
The ID of this job run.
Attempt (integer) --
The number or the attempt to run this job.
PreviousRunId (string) --
The ID of the previous run of this job.
TriggerName (string) --
The name of the trigger for this job run.
JobName (string) --
The name of the job being run.
StartedOn (datetime) --
The date and time at which this job run was started.
LastModifiedOn (datetime) --
The last time this job run was modified.
CompletedOn (datetime) --
The date and time this job run completed.
JobRunState (string) --
The current state of the job run.
Arguments (dict) --
The job arguments associated with this run.
(string) --
(string) --
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 preceded this one.
JobName (string) --
The name of the predecessor job.
RunId (string) --
The job-run ID of the precessor job run.
AllocatedCapacity (integer) --
The amount of infrastructure capacity allocated to this job run.
Creates a Classifier in the user's account.
See also: AWS API Documentation
Request Syntax
client.create_classifier(
GrokClassifier={
'Classification': 'string',
'Name': 'string',
'GrokPattern': 'string',
'CustomPatterns': 'string'
}
)
dict
A grok classifier to create.
Classification (string) -- [REQUIRED]
The type of result that the classifier matches, such as Twitter Json, Omniture logs, Cloudwatch logs, and so forth.
Name (string) -- [REQUIRED]
The name of the new Classifier.
GrokPattern (string) -- [REQUIRED]
The grok pattern used by this classifier.
CustomPatterns (string) --
Custom grok patterns used by this classifier.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a new job.
See also: AWS API Documentation
Request Syntax
client.create_job(
Name='string',
Description='string',
LogUri='string',
Role='string',
ExecutionProperty={
'MaxConcurrentRuns': 123
},
Command={
'Name': 'string',
'ScriptLocation': 'string'
},
DefaultArguments={
'string': 'string'
},
Connections={
'Connections': [
'string',
]
},
MaxRetries=123,
AllocatedCapacity=123
)
string
[REQUIRED]
The name you assign to this job.
string
Description of the job.
string
Location of the logs for this job.
string
[REQUIRED]
The role associated with this job.
dict
An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
MaxConcurrentRuns (integer) --
The maximum number of concurrent runs allowed for a job.
dict
[REQUIRED]
The JobCommand that executes this job.
Name (string) --
The name of this job command.
ScriptLocation (string) --
Specifies the location of a script that executes a job.
dict
The default parameters for this job.
(string) --
(string) --
dict
The connections used for this job.
Connections (list) --
A list of connections used by the job.
(string) --
integer
The maximum number of times to retry this job if it fails.
integer
The number of capacity units allocated to this job.
dict
Response Syntax
{
'Name': 'string'
}
Response Structure
(dict) --
Name (string) --
The unique name of the new job that has been created.
Lists all Classifier objects in the metadata store.
See also: AWS API Documentation
Request Syntax
client.get_classifiers(
MaxResults=123,
NextToken='string'
)
integer
Size of the list to return (optional).
string
An optional continuation token.
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'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Classifiers (list) --
The requested list of Classifier objects.
(dict) --
Classifiers are written in Python and triggered during a Crawl Task. You can write your own Classifiers to best categorize your data sources and specify the appropriate schemas to use for them. A Classifier first checks whether a given file is in a format it can handle, and then, if so, creates a schema in the form of a StructType object that matches that data format.
GrokClassifier (dict) --
A GrokClassifier object.
Name (string) --
The name of the classifier.
Classification (string) --
The data form that the classifier matches, such as Twitter, JSON, Omniture Logs, and so forth.
CreationTime (datetime) --
The time this classifier was registered.
LastUpdated (datetime) --
The time this classifier was last updated.
Version (integer) --
The version of this classifier.
GrokPattern (string) --
The grok pattern used by this classifier.
CustomPatterns (string) --
Custom grok patterns used by this classifier.
NextToken (string) --
A continuation token.
Retrieves a specified function definition from the Data Catalog.
See also: AWS API Documentation
Request Syntax
client.get_user_defined_function(
CatalogId='string',
DatabaseName='string',
FunctionName='string'
)
string
The ID of the Data Catalog where the function to be retrieved is located. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the catalog database where the function is located.
string
[REQUIRED]
The name of the function.
dict
Response Syntax
{
'UserDefinedFunction': {
'FunctionName': 'string',
'ClassName': 'string',
'OwnerName': 'string',
'OwnerType': 'USER'|'ROLE'|'GROUP',
'CreateTime': datetime(2015, 1, 1),
'ResourceUris': [
{
'ResourceType': 'JAR'|'FILE'|'ARCHIVE',
'Uri': 'string'
},
]
}
}
Response Structure
(dict) --
UserDefinedFunction (dict) --
The requested function definition.
FunctionName (string) --
The name of 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) --
URIs for function resources.
ResourceType (string) --
The type of the resource.
Uri (string) --
The URI for accessing the resource.
Removes a table definition from the Data Catalog.
See also: AWS API Documentation
Request Syntax
client.delete_table(
CatalogId='string',
DatabaseName='string',
Name='string'
)
string
The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the catalog database in which the table resides.
string
[REQUIRED]
The name of the table to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Starts a crawl using the specified Crawler, regardless of what is scheduled. If the Crawler is already running, does nothing.
See also: AWS API Documentation
Request Syntax
client.start_crawler(
Name='string'
)
string
[REQUIRED]
Name of the Crawler to start.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a list of connection definitions from the Data Catalog.
See also: AWS API Documentation
Request Syntax
client.get_connections(
CatalogId='string',
Filter={
'MatchCriteria': [
'string',
],
'ConnectionType': 'JDBC'|'SFTP'
},
NextToken='string',
MaxResults=123
)
string
The ID of the Data Catalog in which the connections reside. If none is supplied, the AWS account ID is used by default.
dict
A filter that controls which connections will be returned.
MatchCriteria (list) --
A criteria string that must match the criteria recorded in the connection definition for that connection definition to be returned.
(string) --
ConnectionType (string) --
The type of connections to return.
string
A continuation token, if this is a continuation call.
integer
The maximum number of connections to return in one response.
dict
Response Syntax
{
'ConnectionList': [
{
'Name': 'string',
'Description': 'string',
'ConnectionType': 'JDBC'|'SFTP',
'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) --
Description of the connection.
ConnectionType (string) --
The type of the connection.
MatchCriteria (list) --
A list of criteria that can be used in selecting this connection.
(string) --
ConnectionProperties (dict) --
A list of key-value pairs used as parameters for this connection.
(string) --
(string) --
PhysicalConnectionRequirements (dict) --
A map of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection successfully.
SubnetId (string) --
The subnet ID used by the connection.
SecurityGroupIdList (list) --
The security group ID list used by the connection.
(string) --
AvailabilityZone (string) --
The connection's availability zone.
CreationTime (datetime) --
The time this connection definition was created.
LastUpdatedTime (datetime) --
The last time 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.
Runs a job.
See also: AWS API Documentation
Request Syntax
client.start_job_run(
JobName='string',
JobRunId='string',
Arguments={
'string': 'string'
},
AllocatedCapacity=123
)
string
[REQUIRED]
The name of the job to start.
string
The ID of the job run to start.
dict
Specific arguments for this job run.
(string) --
(string) --
integer
The infrastructure capacity to allocate to this job.
dict
Response Syntax
{
'JobRunId': 'string'
}
Response Structure
(dict) --
JobRunId (string) --
The ID assigned to this job run.
Creates a connection definition in the Data Catalog.
See also: AWS API Documentation
Request Syntax
client.create_connection(
CatalogId='string',
ConnectionInput={
'Name': 'string',
'Description': 'string',
'ConnectionType': 'JDBC'|'SFTP',
'MatchCriteria': [
'string',
],
'ConnectionProperties': {
'string': 'string'
},
'PhysicalConnectionRequirements': {
'SubnetId': 'string',
'SecurityGroupIdList': [
'string',
],
'AvailabilityZone': 'string'
}
}
)
string
The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.
dict
[REQUIRED]
A ConnectionInput object defining the connection to create.
Name (string) --
The name of the connection.
Description (string) --
Description of the connection.
ConnectionType (string) --
The type of the connection.
MatchCriteria (list) --
A list of criteria that can be used in selecting this connection.
(string) --
ConnectionProperties (dict) --
A list of key-value pairs used as parameters for this connection.
(string) --
(string) --
PhysicalConnectionRequirements (dict) --
A map of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection successfully.
SubnetId (string) --
The subnet ID used by the connection.
SecurityGroupIdList (list) --
The security group ID list used by the connection.
(string) --
AvailabilityZone (string) --
The connection's availability zone.
dict
Response Syntax
{}
Response Structure
(dict) --
Starts an existing trigger.
See also: AWS API Documentation
Request Syntax
client.start_trigger(
Name='string'
)
string
[REQUIRED]
The name of the trigger to start.
dict
Response Syntax
{
'Name': 'string'
}
Response Structure
(dict) --
Name (string) --
The name of the trigger that was started.
Retrieves information about the partitions in a table.
See also: AWS API Documentation
Request Syntax
client.get_partitions(
CatalogId='string',
DatabaseName='string',
TableName='string',
Expression='string',
NextToken='string',
Segment={
'SegmentNumber': 123,
'TotalSegments': 123
},
MaxResults=123
)
string
The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the catalog database where the partitions reside.
string
[REQUIRED]
The name of the partitions' table.
string
An expression filtering the partitions to be returned.
string
A continuation token, if this is not the first call to retrieve these partitions.
dict
The segment of the table's partitions to scan in this request.
SegmentNumber (integer) -- [REQUIRED]
The zero-based index number of the this segment. For example, if the total number of segments is 4, SegmentNumber values will range from zero through three.
TotalSegments (integer) -- [REQUIRED]
The total numer of segments.
integer
The maximum number of partitions to return in a single 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'
},
],
'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
},
'Parameters': {
'string': 'string'
},
'LastAnalyzedTime': datetime(2015, 1, 1)
},
],
'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.
(string) --
DatabaseName (string) --
The name of the catalog database where the table in question is located.
TableName (string) --
The name of the table in question.
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 datatype of data in the Column.
Comment (string) --
Free-form text comment.
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) --
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) --
A list of initialization parameters for the SerDe, in key-value form.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
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) --
User-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
Information about values that appear very frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
Parameters (dict) --
Partition parameters, in the form of a list of key-value pairs.
(string) --
(string) --
LastAnalyzedTime (datetime) --
The last time at which column statistics were computed for this partition.
NextToken (string) --
A continuation token, if the returned list of partitions does not does not include the last one.
Retrieves an existing job definition.
See also: AWS API Documentation
Request Syntax
client.get_job(
JobName='string'
)
string
[REQUIRED]
The name of the job to retrieve.
dict
Response Syntax
{
'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'
},
'DefaultArguments': {
'string': 'string'
},
'Connections': {
'Connections': [
'string',
]
},
'MaxRetries': 123,
'AllocatedCapacity': 123
}
}
Response Structure
(dict) --
Job (dict) --
The requested job definition.
Name (string) --
The name you assign to this job.
Description (string) --
Description of this job.
LogUri (string) --
Location of the logs for this job.
Role (string) --
The role associated with this job.
CreatedOn (datetime) --
The time and date that this job specification was created.
LastModifiedOn (datetime) --
The last point in time when this job specification 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 a job.
Command (dict) --
The JobCommand that executes this job.
Name (string) --
The name of this job command.
ScriptLocation (string) --
Specifies the location of a script that executes a job.
DefaultArguments (dict) --
The default parameters for this job.
(string) --
(string) --
Connections (dict) --
The connections used for this job.
Connections (list) --
A list of connections used by the job.
(string) --
MaxRetries (integer) --
The maximum number of times to retry this job if it fails.
AllocatedCapacity (integer) --
The number of capacity units allocated to this job.
Creates mappings.
See also: AWS API Documentation
Request Syntax
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
},
]
}
)
dict
[REQUIRED]
Specifies the source table.
DatabaseName (string) -- [REQUIRED]
The database in which the table metadata resides.
TableName (string) -- [REQUIRED]
The name of the table in question.
list
A list of target tables.
(dict) --
Specifies a table definition in the Data Catalog.
DatabaseName (string) -- [REQUIRED]
The database in which the table metadata resides.
TableName (string) -- [REQUIRED]
The name of the table in question.
dict
Parameters for the mapping.
Jdbc (list) --
A JDBC location.
(dict) --
An argument or property of a node.
Name (string) -- [REQUIRED]
The name of the argument or property.
Value (string) -- [REQUIRED]
The value of the argument or property.
Param (boolean) --
True if the value is used as a parameter.
S3 (list) --
An AWS S3 location.
(dict) --
An argument or property of a node.
Name (string) -- [REQUIRED]
The name of the argument or property.
Value (string) -- [REQUIRED]
The value of the argument or property.
Param (boolean) --
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.
Removes a specified Crawler from the metadata store, unless the Crawler state is RUNNING.
See also: AWS API Documentation
Request Syntax
client.delete_crawler(
Name='string'
)
string
[REQUIRED]
Name of the Crawler to remove.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a specified partition.
See also: AWS API Documentation
Request Syntax
client.delete_partition(
CatalogId='string',
DatabaseName='string',
TableName='string',
PartitionValues=[
'string',
]
)
string
The ID of the Data Catalog where the partition to be deleted resides. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the catalog database in which the table in question resides.
string
[REQUIRED]
The name of the table where the partition to be deleted is located.
list
[REQUIRED]
The values that define the partition.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves information about a specified partition.
See also: AWS API Documentation
Request Syntax
client.get_partition(
CatalogId='string',
DatabaseName='string',
TableName='string',
PartitionValues=[
'string',
]
)
string
The ID of the Data Catalog where the partition in question resides. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the catalog database where the partition resides.
string
[REQUIRED]
The name of the partition's table.
list
[REQUIRED]
The values that define the partition.
(string) --
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'
},
],
'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
},
'Parameters': {
'string': 'string'
},
'LastAnalyzedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Partition (dict) --
The requested information, in the form of a Partition object.
Values (list) --
The values of the partition.
(string) --
DatabaseName (string) --
The name of the catalog database where the table in question is located.
TableName (string) --
The name of the table in question.
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 datatype of data in the Column.
Comment (string) --
Free-form text comment.
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) --
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) --
A list of initialization parameters for the SerDe, in key-value form.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
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) --
User-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
Information about values that appear very frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
Parameters (dict) --
Partition parameters, in the form of a list of key-value pairs.
(string) --
(string) --
LastAnalyzedTime (datetime) --
The last time at which column statistics were computed for this partition.
Retrieves a multiple function definitions from the Data Catalog.
See also: AWS API Documentation
Request Syntax
client.get_user_defined_functions(
CatalogId='string',
DatabaseName='string',
Pattern='string',
NextToken='string',
MaxResults=123
)
string
The ID of the Data Catalog where the functions to be retrieved are located. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the catalog database where the functions are located.
string
[REQUIRED]
An optional function-name pattern string that filters the function definitions returned.
string
A continuation token, if this is a continuation call.
integer
The maximum number of functions to return in one response.
dict
Response Syntax
{
'UserDefinedFunctions': [
{
'FunctionName': 'string',
'ClassName': 'string',
'OwnerName': 'string',
'OwnerType': 'USER'|'ROLE'|'GROUP',
'CreateTime': datetime(2015, 1, 1),
'ResourceUris': [
{
'ResourceType': 'JAR'|'FILE'|'ARCHIVE',
'Uri': '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.
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) --
URIs for function resources.
ResourceType (string) --
The type of the resource.
Uri (string) --
The URI for accessing the resource.
NextToken (string) --
A continuation token, if the list of functions returned does not include the last requested function.
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
client.stop_crawler_schedule(
CrawlerName='string'
)
string
[REQUIRED]
Name of the crawler whose schedule state to set.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a new function definition in the Data Catalog.
See also: AWS API Documentation
Request Syntax
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'
},
]
}
)
string
The ID of the Data Catalog in which to create the function. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the catalog database in which to create the function.
dict
[REQUIRED]
A FunctionInput object that defines the function to create in the Data Catalog.
FunctionName (string) --
The name of the function.
ClassName (string) --
The Java class that contains the function code.
OwnerName (string) --
The owner of the function.
OwnerType (string) --
The owner type.
ResourceUris (list) --
The resource URIs for the function.
(dict) --
URIs for function resources.
ResourceType (string) --
The type of the resource.
Uri (string) --
The URI for accessing the resource.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a connection from the Data Catalog.
See also: AWS API Documentation
Request Syntax
client.delete_connection(
CatalogId='string',
ConnectionName='string'
)
string
The ID of the Data Catalog in which the connection resides. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the connection to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves the definition of a trigger.
See also: AWS API Documentation
Request Syntax
client.get_trigger(
Name='string'
)
string
[REQUIRED]
The name of the trigger to retrieve.
dict
Response Syntax
{
'Trigger': {
'Name': 'string',
'Id': 'string',
'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND',
'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
'Description': 'string',
'Schedule': 'string',
'Actions': [
{
'JobName': 'string',
'Arguments': {
'string': 'string'
}
},
],
'Predicate': {
'Logical': 'AND',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'
},
]
}
}
}
Response Structure
(dict) --
Trigger (dict) --
The requested trigger definition.
Name (string) --
Name of the trigger.
Id (string) --
The trigger ID.
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 schedule expression.
Actions (list) --
The actions initiated by this trigger.
(dict) --
JobName (string) --
Arguments (dict) --
(string) --
(string) --
Predicate (dict) --
The predicate of this trigger.
Logical (string) --
Currently "OR" is not supported.
Conditions (list) --
A list of the conditions that determine when the trigger will fire.
(dict) --
LogicalOperator (string) --
JobName (string) --
State (string) --
Creates a new DevEndpoint.
See also: AWS API Documentation
Request Syntax
client.create_dev_endpoint(
EndpointName='string',
RoleArn='string',
SecurityGroupIds=[
'string',
],
SubnetId='string',
PublicKey='string',
NumberOfNodes=123,
ExtraPythonLibsS3Path='string',
ExtraJarsS3Path='string'
)
string
[REQUIRED]
The name to be assigned to the new DevEndpoint.
string
[REQUIRED]
The IAM role for the DevEndpoint.
list
[REQUIRED]
Security group IDs for the security groups to be used by the new DevEndpoint.
(string) --
string
[REQUIRED]
The subnet ID for the new DevEndpoint to use.
string
The public key to use for authentication.
integer
The number of nodes to use.
string
Path to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint.
string
Path to one or more Java Jars in an S3 bucket that should be loaded in your DevEndpoint.
dict
Response Syntax
{
'EndpointName': 'string',
'Status': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string',
'RoleArn': 'string',
'YarnEndpointAddress': 'string',
'NumberOfNodes': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'ExtraPythonLibsS3Path': 'string',
'ExtraJarsS3Path': 'string',
'FailureReason': 'string',
'CreatedTimestamp': datetime(2015, 1, 1)
}
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.
(string) --
SubnetId (string) --
The subnet ID assigned to the new DevEndpoint.
RoleArn (string) --
The AWS ARN of the role assigned to the new DevEndpoint.
YarnEndpointAddress (string) --
The address of the YARN endpoint used by this DevEndpoint.
NumberOfNodes (integer) --
The number of nodes in this DevEndpoint.
AvailabilityZone (string) --
The AWS availability zone where this DevEndpoint is located.
VpcId (string) --
The ID of the VPC used by this DevEndpoint.
ExtraPythonLibsS3Path (string) --
Path 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 Jars in an S3 bucket that will be loaded in your DevEndpoint.
FailureReason (string) --
The reason for a current failure in this DevEndpoint.
CreatedTimestamp (datetime) --
The point in time at which this DevEndpoint was created.
Resets a bookmark entry.
See also: AWS API Documentation
Request Syntax
client.reset_job_bookmark(
JobName='string'
)
string
[REQUIRED]
The name of the job in question.
dict
Response Syntax
{
'JobBookmarkEntry': {
'JobName': 'string',
'Version': 123,
'Run': 123,
'Attempt': 123,
'JobBookmark': 'string'
}
}
Response Structure
(dict) --
JobBookmarkEntry (dict) --
The reset bookmark entry.
JobName (string) --
Name of the job in question.
Version (integer) --
Version of the job.
Run (integer) --
The run ID number.
Attempt (integer) --
The attempt ID number.
JobBookmark (string) --
The bookmark itself.
Gets all the triggers associated with a job.
See also: AWS API Documentation
Request Syntax
client.get_triggers(
NextToken='string',
DependentJobName='string',
MaxResults=123
)
string
A continuation token, if this is a continuation call.
string
The name of the job for which to retrieve triggers.
integer
The maximum size of the response.
dict
Response Syntax
{
'Triggers': [
{
'Name': 'string',
'Id': 'string',
'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND',
'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
'Description': 'string',
'Schedule': 'string',
'Actions': [
{
'JobName': 'string',
'Arguments': {
'string': 'string'
}
},
],
'Predicate': {
'Logical': 'AND',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'
},
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Triggers (list) --
A list of triggers for the specified job.
(dict) --
Information about a specific trigger.
Name (string) --
Name of the trigger.
Id (string) --
The trigger ID.
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 schedule expression.
Actions (list) --
The actions initiated by this trigger.
(dict) --
JobName (string) --
Arguments (dict) --
(string) --
(string) --
Predicate (dict) --
The predicate of this trigger.
Logical (string) --
Currently "OR" is not supported.
Conditions (list) --
A list of the conditions that determine when the trigger will fire.
(dict) --
LogicalOperator (string) --
JobName (string) --
State (string) --
NextToken (string) --
A continuation token, if not all the requested triggers have yet been returned.
Creates a new database in a Data Catalog.
See also: AWS API Documentation
Request Syntax
client.create_database(
CatalogId='string',
DatabaseInput={
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'Parameters': {
'string': 'string'
}
}
)
string
The ID of the Data Catalog in which to create the database. If none is supplied, the AWS account ID is used by default.
dict
[REQUIRED]
A DatabaseInput object defining the metadata database to create in the catalog.
Name (string) -- [REQUIRED]
Name of the database.
Description (string) --
Description of the database
LocationUri (string) --
The location of the database (for example, an HDFS path).
Parameters (dict) --
A list of key-value pairs that define parameters and properties of the database.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves metrics about specified crawlers.
See also: AWS API Documentation
Request Syntax
client.get_crawler_metrics(
CrawlerNameList=[
'string',
],
MaxResults=123,
NextToken='string'
)
list
A list of the names of crawlers about which to retrieve metrics.
(string) --
integer
The maximum size of a list to return.
string
A continuation token, if this is a continuation call.
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 estimating its
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) --
A list of the tables created by this crawler.
TablesUpdated (integer) --
A list of the tables created by this crawler.
TablesDeleted (integer) --
A list of the tables deleted by this crawler.
NextToken (string) --
A continuation token, if the returned list does not contain the last metric available.
Creates a new partition.
See also: AWS API Documentation
Request Syntax
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'
},
],
'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
},
'Parameters': {
'string': 'string'
},
'LastAnalyzedTime': datetime(2015, 1, 1)
}
)
string
The ID of the catalog in which the partion is to be created. Currently, this should be the AWS account ID.
string
[REQUIRED]
The name of the metadata database in which the partition is to be created.
string
[REQUIRED]
The name of the metadata table in which the partition is to be created.
dict
[REQUIRED]
A PartitionInput structure defining the partition to be created.
Values (list) --
The values of the partition.
(string) --
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) -- [REQUIRED]
The name of the Column.
Type (string) --
The datatype of data in the Column.
Comment (string) --
Free-form text comment.
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) --
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) --
A list of initialization parameters for the SerDe, in key-value form.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
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) -- [REQUIRED]
The name of the column.
SortOrder (integer) -- [REQUIRED]
Indicates that the column is sorted in ascending order ( == 1), or in descending order ( ==0).
Parameters (dict) --
User-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
Information about values that appear very frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
Parameters (dict) --
Partition parameters, in the form of a list of key-value pairs.
(string) --
(string) --
LastAnalyzedTime (datetime) --
The last time at which column statistics were computed for this partition.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets a Python script to perform a specified mapping.
See also: AWS API Documentation
Request Syntax
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
},
]
}
)
list
[REQUIRED]
The list of mappings from a source table to target tables.
(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.
dict
[REQUIRED]
The source table.
DatabaseName (string) -- [REQUIRED]
The database in which the table metadata resides.
TableName (string) -- [REQUIRED]
The name of the table in question.
list
The target tables.
(dict) --
Specifies a table definition in the Data Catalog.
DatabaseName (string) -- [REQUIRED]
The database in which the table metadata resides.
TableName (string) -- [REQUIRED]
The name of the table in question.
dict
Parameters for the mapping.
Jdbc (list) --
A JDBC location.
(dict) --
An argument or property of a node.
Name (string) -- [REQUIRED]
The name of the argument or property.
Value (string) -- [REQUIRED]
The value of the argument or property.
Param (boolean) --
True if the value is used as a parameter.
S3 (list) --
An AWS S3 location.
(dict) --
An argument or property of a node.
Name (string) -- [REQUIRED]
The name of the argument or property.
Value (string) -- [REQUIRED]
The value of the argument or property.
Param (boolean) --
True if the value is used as a parameter.
dict
Response Syntax
{
'PythonScript': 'string'
}
Response Structure
(dict) --
PythonScript (string) --
A python script to perform the mapping.
Retrieves information about a specified DevEndpoint.
See also: AWS API Documentation
Request Syntax
client.get_dev_endpoint(
EndpointName='string'
)
string
[REQUIRED]
Name of the DevEndpoint for which to retrieve information.
dict
Response Syntax
{
'DevEndpoint': {
'EndpointName': 'string',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string',
'YarnEndpointAddress': 'string',
'PublicAddress': 'string',
'Status': 'string',
'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'
}
}
Response Structure
(dict) --
DevEndpoint (dict) --
A DevEndpoint definition.
EndpointName (string) --
The name of the DevEndpoint.
RoleArn (string) --
The AWS ARN of the IAM role used in this DevEndpoint.
SecurityGroupIds (list) --
A list of security group identifiers used in this DevEndpoint.
(string) --
SubnetId (string) --
The subnet ID for this DevEndpoint.
YarnEndpointAddress (string) --
The YARN endpoint address used by this DevEndpoint.
PublicAddress (string) --
The public address used by this DevEndpoint.
Status (string) --
The current status of this DevEndpoint.
NumberOfNodes (integer) --
The number of nodes used by 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) --
Path to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint.
ExtraJarsS3Path (string) --
Path to one or more Java Jars in an S3 bucket that should be loaded in your 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.
Removes a Classifier from the metadata store.
See also: AWS API Documentation
Request Syntax
client.delete_classifier(
Name='string'
)
string
[REQUIRED]
Name of the Classifier to remove.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a new Crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in either the s3Targets or the jdbcTargets field.
See also: AWS API Documentation
Request Syntax
client.create_crawler(
Name='string',
Role='string',
DatabaseName='string',
Description='string',
Targets={
'S3Targets': [
{
'Path': 'string',
'Exclusions': [
'string',
]
},
],
'JdbcTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'Exclusions': [
'string',
]
},
]
},
Schedule='string',
Classifiers=[
'string',
],
TablePrefix='string',
SchemaChangePolicy={
'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
}
)
string
[REQUIRED]
Name of the new Crawler.
string
[REQUIRED]
The AWS ARN of the IAM role used by the new Crawler to access customer resources.
string
[REQUIRED]
The Glue Database where results will be stored, such as: arn:aws:daylight:us-east-1::database/sometable/*.
string
A description of the new Crawler.
dict
[REQUIRED]
A list of collection of targets to crawl.
S3Targets (list) --
Specifies targets in AWS S3.
(dict) --
Specifies a crawler target in AWS S3.
Path (string) --
The path to the S3 target.
Exclusions (list) --
A list of S3 objects to exclude from the crawl.
(string) --
JdbcTargets (list) --
Specifies JDBC targets.
(dict) --
Specifies a JDBC target for a crawl.
ConnectionName (string) --
The name of the connection to use for the JDBC target.
Path (string) --
The path of the JDBC target.
Exclusions (list) --
A list of items to exclude from the crawl.
(string) --
string
A cron expression that can be used as a Cloudwatch event (see CloudWatch Schedule Expression Syntax. For example, to run every day at 12:15 UTC, specify: cron(15 12 * * ? *).
list
A list of custom Classifier names that the user has registered. By default, all AWS classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
(string) --
string
The table prefix used for catalog tables created.
dict
Policy for the crawler's update and deletion behavior.
UpdateBehavior (string) --
The update behavior.
DeleteBehavior (string) --
The deletion behavior.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates a trigger definition.
See also: AWS API Documentation
Request Syntax
client.update_trigger(
Name='string',
TriggerUpdate={
'Name': 'string',
'Description': 'string',
'Schedule': 'string',
'Actions': [
{
'JobName': 'string',
'Arguments': {
'string': 'string'
}
},
],
'Predicate': {
'Logical': 'AND',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'
},
]
}
}
)
string
[REQUIRED]
The name of the trigger to update.
dict
[REQUIRED]
The new values with which to update the trigger.
Name (string) --
The name of the trigger.
Description (string) --
A description of this trigger.
Schedule (string) --
A cron expression specifying the schedule.
Actions (list) --
The actions initiated by this trigger.
(dict) --
JobName (string) --
Arguments (dict) --
(string) --
(string) --
Predicate (dict) --
The predicate of this trigger, which defines when it will fire.
Logical (string) --
Currently "OR" is not supported.
Conditions (list) --
A list of the conditions that determine when the trigger will fire.
(dict) --
LogicalOperator (string) --
JobName (string) --
State (string) --
dict
Response Syntax
{
'Trigger': {
'Name': 'string',
'Id': 'string',
'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND',
'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
'Description': 'string',
'Schedule': 'string',
'Actions': [
{
'JobName': 'string',
'Arguments': {
'string': 'string'
}
},
],
'Predicate': {
'Logical': 'AND',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'
},
]
}
}
}
Response Structure
(dict) --
Trigger (dict) --
The resulting trigger definition.
Name (string) --
Name of the trigger.
Id (string) --
The trigger ID.
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 schedule expression.
Actions (list) --
The actions initiated by this trigger.
(dict) --
JobName (string) --
Arguments (dict) --
(string) --
(string) --
Predicate (dict) --
The predicate of this trigger.
Logical (string) --
Currently "OR" is not supported.
Conditions (list) --
A list of the conditions that determine when the trigger will fire.
(dict) --
LogicalOperator (string) --
JobName (string) --
State (string) --
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
client.start_crawler_schedule(
CrawlerName='string'
)
string
[REQUIRED]
Name of the crawler to schedule.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates a partition.
See also: AWS API Documentation
Request Syntax
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'
},
],
'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
},
'Parameters': {
'string': 'string'
},
'LastAnalyzedTime': datetime(2015, 1, 1)
}
)
string
The ID of the Data Catalog where the partition to be updated resides. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the catalog database in which the table in question resides.
string
[REQUIRED]
The name of the table where the partition to be updated is located.
list
[REQUIRED]
A list of the values defining the partition.
(string) --
dict
[REQUIRED]
The new partition object to which to update the partition.
Values (list) --
The values of the partition.
(string) --
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) -- [REQUIRED]
The name of the Column.
Type (string) --
The datatype of data in the Column.
Comment (string) --
Free-form text comment.
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) --
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) --
A list of initialization parameters for the SerDe, in key-value form.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
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) -- [REQUIRED]
The name of the column.
SortOrder (integer) -- [REQUIRED]
Indicates that the column is sorted in ascending order ( == 1), or in descending order ( ==0).
Parameters (dict) --
User-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
Information about values that appear very frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
Parameters (dict) --
Partition parameters, in the form of a list of key-value pairs.
(string) --
(string) --
LastAnalyzedTime (datetime) --
The last time at which column statistics were computed for this partition.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a specified DevEndpoint.
See also: AWS API Documentation
Request Syntax
client.delete_dev_endpoint(
EndpointName='string'
)
string
[REQUIRED]
The name of the DevEndpoint.
dict
Response Syntax
{}
Response Structure
(dict) --
Modifies an existing Classifier.
See also: AWS API Documentation
Request Syntax
client.update_classifier(
GrokClassifier={
'Name': 'string',
'Classification': 'string',
'GrokPattern': 'string',
'CustomPatterns': 'string'
}
)
dict
A GrokClassifier object with updated fields.
Name (string) -- [REQUIRED]
The name of the GrokClassifier.
Classification (string) --
The type of result that the classifier matches, such as Twitter Json, Omniture logs, Cloudwatch logs, and so forth.
GrokPattern (string) --
The grok pattern used by this classifier.
CustomPatterns (string) --
Custom grok patterns used by this classifier.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates an existing database definition in a Data Catalog.
See also: AWS API Documentation
Request Syntax
client.update_database(
CatalogId='string',
Name='string',
DatabaseInput={
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'Parameters': {
'string': 'string'
}
}
)
string
The ID of the Data Catalog in which the metadata database resides. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the metadata database to update in the catalog.
dict
[REQUIRED]
A DatabaseInput object specifying the new definition of the metadata database in the catalog.
Name (string) -- [REQUIRED]
Name of the database.
Description (string) --
Description of the database
LocationUri (string) --
The location of the database (for example, an HDFS path).
Parameters (dict) --
A list of key-value pairs that define parameters and properties of the database.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Stops a specified trigger.
See also: AWS API Documentation
Request Syntax
client.stop_trigger(
Name='string'
)
string
[REQUIRED]
The name of the trigger to stop.
dict
Response Syntax
{
'Name': 'string'
}
Response Structure
(dict) --
Name (string) --
The name of the trigger that was stopped.
Retrieves all current jobs.
See also: AWS API Documentation
Request Syntax
client.get_jobs(
NextToken='string',
MaxResults=123
)
string
A continuation token, if this is a continuation call.
integer
The maximum size of the response.
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'
},
'DefaultArguments': {
'string': 'string'
},
'Connections': {
'Connections': [
'string',
]
},
'MaxRetries': 123,
'AllocatedCapacity': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Jobs (list) --
A list of jobs.
(dict) --
Specifies a job in the Data Catalog.
Name (string) --
The name you assign to this job.
Description (string) --
Description of this job.
LogUri (string) --
Location of the logs for this job.
Role (string) --
The role associated with this job.
CreatedOn (datetime) --
The time and date that this job specification was created.
LastModifiedOn (datetime) --
The last point in time when this job specification 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 a job.
Command (dict) --
The JobCommand that executes this job.
Name (string) --
The name of this job command.
ScriptLocation (string) --
Specifies the location of a script that executes a job.
DefaultArguments (dict) --
The default parameters for this job.
(string) --
(string) --
Connections (dict) --
The connections used for this job.
Connections (list) --
A list of connections used by the job.
(string) --
MaxRetries (integer) --
The maximum number of times to retry this job if it fails.
AllocatedCapacity (integer) --
The number of capacity units allocated to this job.
NextToken (string) --
A continuation token, if not all jobs have yet been returned.
Creates a new trigger.
See also: AWS API Documentation
Request Syntax
client.create_trigger(
Name='string',
Type='SCHEDULED'|'CONDITIONAL'|'ON_DEMAND',
Schedule='string',
Predicate={
'Logical': 'AND',
'Conditions': [
{
'LogicalOperator': 'EQUALS',
'JobName': 'string',
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'
},
]
},
Actions=[
{
'JobName': 'string',
'Arguments': {
'string': 'string'
}
},
],
Description='string'
)
string
[REQUIRED]
The name to assign to the new trigger.
string
[REQUIRED]
The type of the new trigger.
string
A cron schedule expression for the new trigger.
dict
A predicate to specify when the new trigger should fire.
Logical (string) --
Currently "OR" is not supported.
Conditions (list) --
A list of the conditions that determine when the trigger will fire.
(dict) --
LogicalOperator (string) --
JobName (string) --
State (string) --
list
[REQUIRED]
The actions initiated by this trigger when it fires.
(dict) --
JobName (string) --
Arguments (dict) --
(string) --
(string) --
string
A description of the new trigger.
dict
Response Syntax
{
'Name': 'string'
}
Response Structure
(dict) --
Name (string) --
The name assigned to the new trigger.
Imports an existing Athena Data Catalog to AWS Glue
See also: AWS API Documentation
Request Syntax
client.import_catalog_to_glue(
CatalogId='string'
)
string
The ID of the catalog to import. Currently, this should be the AWS account ID.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a connection definition from the Data Catalog.
See also: AWS API Documentation
Request Syntax
client.get_connection(
CatalogId='string',
Name='string'
)
string
The ID of the Data Catalog in which the connection resides. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the connection definition to retrieve.
dict
Response Syntax
{
'Connection': {
'Name': 'string',
'Description': 'string',
'ConnectionType': 'JDBC'|'SFTP',
'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) --
Description of the connection.
ConnectionType (string) --
The type of the connection.
MatchCriteria (list) --
A list of criteria that can be used in selecting this connection.
(string) --
ConnectionProperties (dict) --
A list of key-value pairs used as parameters for this connection.
(string) --
(string) --
PhysicalConnectionRequirements (dict) --
A map of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection successfully.
SubnetId (string) --
The subnet ID used by the connection.
SecurityGroupIdList (list) --
The security group ID list used by the connection.
(string) --
AvailabilityZone (string) --
The connection's availability zone.
CreationTime (datetime) --
The time this connection definition was created.
LastUpdatedTime (datetime) --
The last time this connection definition was updated.
LastUpdatedBy (string) --
The user, group or role that last updated this connection definition.
Retrieves partitions in a batch request.
See also: AWS API Documentation
Request Syntax
client.batch_get_partition(
CatalogId='string',
DatabaseName='string',
TableName='string',
PartitionsToGet=[
{
'Values': [
'string',
]
},
]
)
string
The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the catalog database where the partitions reside.
string
[REQUIRED]
The name of the partitions' table.
list
[REQUIRED]
A list of partition values identifying the partitions to retrieve.
(dict) --
Values (list) -- [REQUIRED]
(string) --
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'
},
],
'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
},
'Parameters': {
'string': 'string'
},
'LastAnalyzedTime': datetime(2015, 1, 1)
},
],
'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.
(string) --
DatabaseName (string) --
The name of the catalog database where the table in question is located.
TableName (string) --
The name of the table in question.
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 datatype of data in the Column.
Comment (string) --
Free-form text comment.
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) --
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) --
A list of initialization parameters for the SerDe, in key-value form.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
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) --
User-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
Information about values that appear very frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
Parameters (dict) --
Partition parameters, in the form of a list of key-value pairs.
(string) --
(string) --
LastAnalyzedTime (datetime) --
The last time at which column statistics were computed for this partition.
UnprocessedKeys (list) --
A list of the partition values in the request for which partions were not returned.
(dict) --
Values (list) --
(string) --
Deletes one or more partitions in a batch operation.
See also: AWS API Documentation
Request Syntax
client.batch_delete_partition(
CatalogId='string',
DatabaseName='string',
TableName='string',
PartitionsToDelete=[
{
'Values': [
'string',
]
},
]
)
string
The ID of the Data Catalog where the partition to be deleted resides. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the catalog database in which the table in question resides.
string
[REQUIRED]
The name of the table where the partitions to be deleted is located.
list
[REQUIRED]
A list of PartitionInput structures that define the partitions to be deleted.
(dict) --
Values (list) -- [REQUIRED]
(string) --
dict
Response Syntax
{
'Errors': [
{
'PartitionValues': [
'string',
],
'ErrorDetail': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
Errors (list) --
Errors encountered when trying to delete the requested partitions.
(dict) --
Contains information about a partition error.
PartitionValues (list) --
The values that define the partition.
(string) --
ErrorDetail (dict) --
Details about the partition error.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Updates a Crawler. If a Crawler is running, you must stop it using StopCrawler before updating it.
See also: AWS API Documentation
Request Syntax
client.update_crawler(
Name='string',
Role='string',
DatabaseName='string',
Description='string',
Targets={
'S3Targets': [
{
'Path': 'string',
'Exclusions': [
'string',
]
},
],
'JdbcTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'Exclusions': [
'string',
]
},
]
},
Schedule='string',
Classifiers=[
'string',
],
TablePrefix='string',
SchemaChangePolicy={
'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
}
)
string
[REQUIRED]
Name of the new Crawler.
string
The AWS ARN of the IAM role used by the new Crawler to access customer resources.
string
The Glue Database where results will be stored, such as: arn:aws:daylight:us-east-1::database/sometable/*.
string
A description of the new Crawler.
dict
A list of collection of targets to crawl.
S3Targets (list) --
Specifies targets in AWS S3.
(dict) --
Specifies a crawler target in AWS S3.
Path (string) --
The path to the S3 target.
Exclusions (list) --
A list of S3 objects to exclude from the crawl.
(string) --
JdbcTargets (list) --
Specifies JDBC targets.
(dict) --
Specifies a JDBC target for a crawl.
ConnectionName (string) --
The name of the connection to use for the JDBC target.
Path (string) --
The path of the JDBC target.
Exclusions (list) --
A list of items to exclude from the crawl.
(string) --
string
A cron expression that can be used as a Cloudwatch event (see CloudWatch Schedule Expression Syntax. For example, to run every day at 12:15 UTC, specify: cron(15 12 * * ? *).
list
A list of custom Classifier names that the user has registered. By default, all AWS classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
(string) --
string
The table prefix used for catalog tables created.
dict
Policy for the crawler's update and deletion behavior.
UpdateBehavior (string) --
The update behavior.
DeleteBehavior (string) --
The deletion behavior.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a list of connection definitions from the Data Catalog.
See also: AWS API Documentation
Request Syntax
client.batch_delete_connection(
CatalogId='string',
ConnectionNameList=[
'string',
]
)
string
The ID of the Data Catalog in which the connections reside. If none is supplied, the AWS account ID is used by default.
list
[REQUIRED]
A list of names of the connections to delete.
(string) --
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.
(string) --
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.
Deletes a specified trigger.
See also: AWS API Documentation
Request Syntax
client.delete_trigger(
Name='string'
)
string
[REQUIRED]
The name of the trigger to delete.
dict
Response Syntax
{
'Name': 'string'
}
Response Structure
(dict) --
Name (string) --
The name of the trigger that was deleted.
Deletes multiple tables at once.
See also: AWS API Documentation
Request Syntax
client.batch_delete_table(
CatalogId='string',
DatabaseName='string',
TablesToDelete=[
'string',
]
)
string
The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the catalog database where the tables to delete reside.
list
[REQUIRED]
A list of the table to delete.
(string) --
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) --
Name of the table.
ErrorDetail (dict) --
Detail about the error.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Transforms a Python script into a directed acyclic graph (DAG).
See also: AWS API Documentation
Request Syntax
client.get_dataflow_graph(
PythonScript='string'
)
string
The Python script to transform.
dict
Response Syntax
{
'DagNodes': [
{
'Id': 'string',
'NodeType': 'string',
'Args': [
{
'Name': 'string',
'Value': 'string',
'Param': True|False
},
],
'LineNumber': 123
},
],
'DagEdges': [
{
'Source': 'string',
'Target': 'string',
'TargetParameter': 'string'
},
]
}
Response Structure
(dict) --
DagNodes (list) --
A list of the nodes in the resulting DAG.
(dict) --
Represents a node in a directed acyclic graph (DAG)
Id (string) --
A node identifier that is unique within the node's graph.
NodeType (string) --
The type of node this is.
Args (list) --
Properties of the node, in the form of name-value pairs.
(dict) --
An argument or property of a node.
Name (string) --
The name of the argument or property.
Value (string) --
The value of the argument or property.
Param (boolean) --
True if the value is used as a parameter.
LineNumber (integer) --
The line number of the node.
DagEdges (list) --
A list of the edges in the resulting DAG.
(dict) --
Represents a directional edge in a directed acyclic graph (DAG).
Source (string) --
The ID of the node at which the edge starts.
Target (string) --
The ID of the node at which the edge ends.
TargetParameter (string) --
The target of the edge.
Retrieves the definition of a specified database.
See also: AWS API Documentation
Request Syntax
client.get_database(
CatalogId='string',
Name='string'
)
string
The ID of the Data Catalog in which the database resides. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the database to retrieve.
dict
Response Syntax
{
'Database': {
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'Parameters': {
'string': 'string'
},
'CreateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Database (dict) --
The definition of the specified database in the catalog.
Name (string) --
Name of the database.
Description (string) --
Description of the database.
LocationUri (string) --
The location of the database (for example, an HDFS path).
Parameters (dict) --
A list of key-value pairs that define parameters and properties of the database.
(string) --
(string) --
CreateTime (datetime) --
The time at which the metadata database was created in the catalog.
If the specified Crawler is running, stops the crawl.
See also: AWS API Documentation
Request Syntax
client.stop_crawler(
Name='string'
)
string
[REQUIRED]
Name of the Crawler to stop.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates an existing job definition.
See also: AWS API Documentation
Request Syntax
client.update_job(
JobName='string',
JobUpdate={
'Description': 'string',
'LogUri': 'string',
'Role': 'string',
'ExecutionProperty': {
'MaxConcurrentRuns': 123
},
'Command': {
'Name': 'string',
'ScriptLocation': 'string'
},
'DefaultArguments': {
'string': 'string'
},
'Connections': {
'Connections': [
'string',
]
},
'MaxRetries': 123,
'AllocatedCapacity': 123
}
)
string
[REQUIRED]
Name of the job definition to update.
dict
[REQUIRED]
Specifies the values with which to update the job.
Description (string) --
Description of the job.
LogUri (string) --
Location of the logs for this job.
Role (string) --
The role associated with this job.
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 a job.
Command (dict) --
The JobCommand that executes this job.
Name (string) --
The name of this job command.
ScriptLocation (string) --
Specifies the location of a script that executes a job.
DefaultArguments (dict) --
The default parameters for this job.
(string) --
(string) --
Connections (dict) --
The connections used for this job.
Connections (list) --
A list of connections used by the job.
(string) --
MaxRetries (integer) --
The maximum number of times to retry this job if it fails.
AllocatedCapacity (integer) --
The number of capacity units allocated to this job.
dict
Response Syntax
{
'JobName': 'string'
}
Response Structure
(dict) --
JobName (string) --
Returns the name of the updated job.
Updates a metadata table in the Data Catalog.
See also: AWS API Documentation
Request Syntax
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'
},
],
'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
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string'
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
}
}
)
string
The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the catalog database in which the table resides.
dict
[REQUIRED]
An updated TableInput object to define the metadata table in the catalog.
Name (string) -- [REQUIRED]
Name of the table.
Description (string) --
Description of the table.
Owner (string) --
Owner of the table.
LastAccessTime (datetime) --
Last time the table was accessed.
LastAnalyzedTime (datetime) --
Last time column statistics were computed for this table.
Retention (integer) --
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) -- [REQUIRED]
The name of the Column.
Type (string) --
The datatype of data in the Column.
Comment (string) --
Free-form text comment.
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) --
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) --
A list of initialization parameters for the SerDe, in key-value form.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
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) -- [REQUIRED]
The name of the column.
SortOrder (integer) -- [REQUIRED]
Indicates that the column is sorted in ascending order ( == 1), or in descending order ( ==0).
Parameters (dict) --
User-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
Information about values that appear very frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
PartitionKeys (list) --
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
(dict) --
A column in a Table.
Name (string) -- [REQUIRED]
The name of the Column.
Type (string) --
The datatype of data in the Column.
Comment (string) --
Free-form text comment.
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) --
Properties associated with this table, as a list of key-value pairs.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Updates an existing function definition in the Data Catalog.
See also: AWS API Documentation
Request Syntax
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'
},
]
}
)
string
The ID of the Data Catalog where the function to be updated is located. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the catalog database where the function to be updated is located.
string
[REQUIRED]
The name of the function.
dict
[REQUIRED]
A FunctionInput object that re-defines the function in the Data Catalog.
FunctionName (string) --
The name of the function.
ClassName (string) --
The Java class that contains the function code.
OwnerName (string) --
The owner of the function.
OwnerType (string) --
The owner type.
ResourceUris (list) --
The resource URIs for the function.
(dict) --
URIs for function resources.
ResourceType (string) --
The type of the resource.
Uri (string) --
The URI for accessing the resource.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves metadata for all runs of a given job.
See also: AWS API Documentation
Request Syntax
client.get_job_runs(
JobName='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The name of the job for which to retrieve all job runs.
string
A continuation token, if this is a continuation call.
integer
The maximum size of the 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',
'Arguments': {
'string': 'string'
},
'ErrorMessage': 'string',
'PredecessorRuns': [
{
'JobName': 'string',
'RunId': 'string'
},
],
'AllocatedCapacity': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
JobRuns (list) --
A list of job-run metatdata objects.
(dict) --
Contains information about a job run.
Id (string) --
The ID of this job run.
Attempt (integer) --
The number or the attempt to run this job.
PreviousRunId (string) --
The ID of the previous run of this job.
TriggerName (string) --
The name of the trigger for this job run.
JobName (string) --
The name of the job being run.
StartedOn (datetime) --
The date and time at which this job run was started.
LastModifiedOn (datetime) --
The last time this job run was modified.
CompletedOn (datetime) --
The date and time this job run completed.
JobRunState (string) --
The current state of the job run.
Arguments (dict) --
The job arguments associated with this run.
(string) --
(string) --
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 preceded this one.
JobName (string) --
The name of the predecessor job.
RunId (string) --
The job-run ID of the precessor job run.
AllocatedCapacity (integer) --
The amount of infrastructure capacity allocated to this job run.
NextToken (string) --
A continuation token, if not all reequested job runs have been returned.
Retrieves all the DevEndpoints in this AWS account.
See also: AWS API Documentation
Request Syntax
client.get_dev_endpoints(
MaxResults=123,
NextToken='string'
)
integer
The maximum size of information to return.
string
A continuation token, if this is a continuation call.
dict
Response Syntax
{
'DevEndpoints': [
{
'EndpointName': 'string',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string',
'YarnEndpointAddress': 'string',
'PublicAddress': 'string',
'Status': 'string',
'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'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DevEndpoints (list) --
A list of DevEndpoint definitions.
(dict) --
A development endpoint where a developer can remotely debug ETL scripts.
EndpointName (string) --
The name of the DevEndpoint.
RoleArn (string) --
The AWS ARN of the IAM role used in this DevEndpoint.
SecurityGroupIds (list) --
A list of security group identifiers used in this DevEndpoint.
(string) --
SubnetId (string) --
The subnet ID for this DevEndpoint.
YarnEndpointAddress (string) --
The YARN endpoint address used by this DevEndpoint.
PublicAddress (string) --
The public address used by this DevEndpoint.
Status (string) --
The current status of this DevEndpoint.
NumberOfNodes (integer) --
The number of nodes used by 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) --
Path to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint.
ExtraJarsS3Path (string) --
Path to one or more Java Jars in an S3 bucket that should be loaded in your 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.
NextToken (string) --
A continuation token, if not all DevEndpoint definitions have yet been returned.
Deletes a specified job.
See also: AWS API Documentation
Request Syntax
client.delete_job(
JobName='string'
)
string
[REQUIRED]
The name of the job to delete.
dict
Response Syntax
{
'JobName': 'string'
}
Response Structure
(dict) --
JobName (string) --
The name of the job that was deleted.
Updates a connection definition in the Data Catalog.
See also: AWS API Documentation
Request Syntax
client.update_connection(
CatalogId='string',
Name='string',
ConnectionInput={
'Name': 'string',
'Description': 'string',
'ConnectionType': 'JDBC'|'SFTP',
'MatchCriteria': [
'string',
],
'ConnectionProperties': {
'string': 'string'
},
'PhysicalConnectionRequirements': {
'SubnetId': 'string',
'SecurityGroupIdList': [
'string',
],
'AvailabilityZone': 'string'
}
}
)
string
The ID of the Data Catalog in which the connection resides. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the connection definition to update.
dict
[REQUIRED]
A ConnectionInput object that redefines the connection in question.
Name (string) --
The name of the connection.
Description (string) --
Description of the connection.
ConnectionType (string) --
The type of the connection.
MatchCriteria (list) --
A list of criteria that can be used in selecting this connection.
(string) --
ConnectionProperties (dict) --
A list of key-value pairs used as parameters for this connection.
(string) --
(string) --
PhysicalConnectionRequirements (dict) --
A map of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection successfully.
SubnetId (string) --
The subnet ID used by the connection.
SecurityGroupIdList (list) --
The security group ID list used by the connection.
(string) --
AvailabilityZone (string) --
The connection's availability zone.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves metadata for all Crawlers defined in the customer account.
See also: AWS API Documentation
Request Syntax
client.get_crawlers(
MaxResults=123,
NextToken='string'
)
integer
The number of Crawlers to return on each call.
string
A continuation token, if this is a continuation request.
dict
Response Syntax
{
'Crawlers': [
{
'Name': 'string',
'Role': 'string',
'Targets': {
'S3Targets': [
{
'Path': 'string',
'Exclusions': [
'string',
]
},
],
'JdbcTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'Exclusions': [
'string',
]
},
]
},
'DatabaseName': 'string',
'Description': 'string',
'Classifiers': [
'string',
],
'SchemaChangePolicy': {
'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
},
'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
},
],
'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 its schema. If successful, the crawler records metatdata concerning the data source in the Data Catalog.
Name (string) --
The Crawler name.
Role (string) --
The ARN of an IAM role used to access customer resources such as data in S3.
Targets (dict) --
A collection of targets to crawl.
S3Targets (list) --
Specifies targets in AWS S3.
(dict) --
Specifies a crawler target in AWS S3.
Path (string) --
The path to the S3 target.
Exclusions (list) --
A list of S3 objects to exclude from the crawl.
(string) --
JdbcTargets (list) --
Specifies JDBC targets.
(dict) --
Specifies a JDBC target for a crawl.
ConnectionName (string) --
The name of the connection to use for the JDBC target.
Path (string) --
The path of the JDBC target.
Exclusions (list) --
A list of items to exclude from the crawl.
(string) --
DatabaseName (string) --
The Database where this Crawler's output should be stored.
Description (string) --
A description of this Crawler and where it should be used.
Classifiers (list) --
A list of custom ``Classifier``s associated with this Crawler.
(string) --
SchemaChangePolicy (dict) --
Sets policy for the crawler's update and delete behavior.
UpdateBehavior (string) --
The update behavior.
DeleteBehavior (string) --
The deletion behavior.
State (string) --
Indicates whether this Crawler is running, or whether a run is pending.
TablePrefix (string) --
The table prefix used for catalog tables created.
Schedule (dict) --
A Schedule object that specifies the schedule on which this Crawler is to be run.
ScheduleExpression (string) --
A cron expression that can be used as a Cloudwatch event to schedule something (see CloudWatch Schedule Expression Syntax. 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 this Crawler is running, contains the total time elapsed since the last crawl began.
CreationTime (datetime) --
The time when the Crawler was created.
LastUpdated (datetime) --
The time 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) --
Error information about the last crawl, if an error occurred.
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.
NextToken (string) --
A continuation token, if the returned list has not reached the end of those defined in this customer account.
Creates one or more partitions in a batch operation.
See also: AWS API Documentation
Request Syntax
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'
},
],
'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
},
'Parameters': {
'string': 'string'
},
'LastAnalyzedTime': datetime(2015, 1, 1)
},
]
)
string
The ID of the catalog in which the partion is to be created. Currently, this should be the AWS account ID.
string
[REQUIRED]
The name of the metadata database in which the partition is to be created.
string
[REQUIRED]
The name of the metadata table in which the partition is to be created.
list
[REQUIRED]
A list of PartitionInput structures that define the partitions to be created.
(dict) --
The structure used to create and update a partion.
Values (list) --
The values of the partition.
(string) --
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) -- [REQUIRED]
The name of the Column.
Type (string) --
The datatype of data in the Column.
Comment (string) --
Free-form text comment.
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) --
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) --
A list of initialization parameters for the SerDe, in key-value form.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
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) -- [REQUIRED]
The name of the column.
SortOrder (integer) -- [REQUIRED]
Indicates that the column is sorted in ascending order ( == 1), or in descending order ( ==0).
Parameters (dict) --
User-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
Information about values that appear very frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
Parameters (dict) --
Partition parameters, in the form of a list of key-value pairs.
(string) --
(string) --
LastAnalyzedTime (datetime) --
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) --
Errors encountered when trying to create the requested partitions.
(dict) --
Contains information about a partition error.
PartitionValues (list) --
The values that define the partition.
(string) --
ErrorDetail (dict) --
Details about the partition error.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Deletes an existing function definition from the Data Catalog.
See also: AWS API Documentation
Request Syntax
client.delete_user_defined_function(
CatalogId='string',
DatabaseName='string',
FunctionName='string'
)
string
The ID of the Data Catalog where the function to be deleted is located. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the catalog database where the function is located.
string
[REQUIRED]
The name of the function definition to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the schedule of a crawler using a Cron expression.
See also: AWS API Documentation
Request Syntax
client.update_crawler_schedule(
CrawlerName='string',
Schedule='string'
)
string
[REQUIRED]
Name of the crawler whose schedule to update.
string
Cron expression of the updated schedule.
dict
Response Syntax
{}
Response Structure
(dict) --
Transforms a directed acyclic graph (DAG) into a Python script.
See also: AWS API Documentation
Request Syntax
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'
},
]
)
list
A list of the nodes in the DAG.
(dict) --
Represents a node in a directed acyclic graph (DAG)
Id (string) -- [REQUIRED]
A node identifier that is unique within the node's graph.
NodeType (string) -- [REQUIRED]
The type of node this is.
Args (list) -- [REQUIRED]
Properties of the node, in the form of name-value pairs.
(dict) --
An argument or property of a node.
Name (string) -- [REQUIRED]
The name of the argument or property.
Value (string) -- [REQUIRED]
The value of the argument or property.
Param (boolean) --
True if the value is used as a parameter.
LineNumber (integer) --
The line number of the node.
list
A list of the edges in the DAG.
(dict) --
Represents a directional edge in a directed acyclic graph (DAG).
Source (string) -- [REQUIRED]
The ID of the node at which the edge starts.
Target (string) -- [REQUIRED]
The ID of the node at which the edge ends.
TargetParameter (string) --
The target of the edge.
dict
Response Syntax
{
'PythonScript': 'string'
}
Response Structure
(dict) --
PythonScript (string) --
The Python script generated from the DAG.
Retrieves a list of strings that identify available versions of a specified table.
See also: AWS API Documentation
Request Syntax
client.get_table_versions(
CatalogId='string',
DatabaseName='string',
TableName='string',
NextToken='string',
MaxResults=123
)
string
The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The database in the catalog in which the table resides.
string
[REQUIRED]
The name of the table.
string
A continuation token, if this is not the first call.
integer
The maximum number of table versions to return in one 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'
},
],
'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
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string'
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'CreatedBy': 'string'
},
'VersionId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TableVersions (list) --
A list of strings identifying available versions of the specified table.
(dict) --
Table (dict) --
Represents a collection of related data organized in columns and rows.
Name (string) --
Name of the table.
DatabaseName (string) --
Name of the metadata database where the table metadata resides.
Description (string) --
Description of the table.
Owner (string) --
Owner of the table.
CreateTime (datetime) --
Time when the table definition was created in the Data Catalog.
UpdateTime (datetime) --
Last time the table was updated.
LastAccessTime (datetime) --
Last time the table was accessed. This is usually taken from HDFS, and may not be reliable.
LastAnalyzedTime (datetime) --
Last time column statistics were computed for this table.
Retention (integer) --
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 datatype of data in the Column.
Comment (string) --
Free-form text comment.
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) --
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) --
A list of initialization parameters for the SerDe, in key-value form.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
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) --
User-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
Information about values that appear very frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
PartitionKeys (list) --
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
(dict) --
A column in a Table.
Name (string) --
The name of the Column.
Type (string) --
The datatype of data in the Column.
Comment (string) --
Free-form text comment.
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) --
Properties associated with this table, as a list of key-value pairs.
(string) --
(string) --
CreatedBy (string) --
Person or entity who created the table.
VersionId (string) --
NextToken (string) --
A continuation token, if the list of available versions does not include the last one.
Retrieves metadata for a specified Crawler.
See also: AWS API Documentation
Request Syntax
client.get_crawler(
Name='string'
)
string
[REQUIRED]
Name of the Crawler to retrieve metadata for.
dict
Response Syntax
{
'Crawler': {
'Name': 'string',
'Role': 'string',
'Targets': {
'S3Targets': [
{
'Path': 'string',
'Exclusions': [
'string',
]
},
],
'JdbcTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'Exclusions': [
'string',
]
},
]
},
'DatabaseName': 'string',
'Description': 'string',
'Classifiers': [
'string',
],
'SchemaChangePolicy': {
'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
},
'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
}
}
Response Structure
(dict) --
Crawler (dict) --
The metadata for the specified Crawler.
Name (string) --
The Crawler name.
Role (string) --
The ARN of an IAM role used to access customer resources such as data in S3.
Targets (dict) --
A collection of targets to crawl.
S3Targets (list) --
Specifies targets in AWS S3.
(dict) --
Specifies a crawler target in AWS S3.
Path (string) --
The path to the S3 target.
Exclusions (list) --
A list of S3 objects to exclude from the crawl.
(string) --
JdbcTargets (list) --
Specifies JDBC targets.
(dict) --
Specifies a JDBC target for a crawl.
ConnectionName (string) --
The name of the connection to use for the JDBC target.
Path (string) --
The path of the JDBC target.
Exclusions (list) --
A list of items to exclude from the crawl.
(string) --
DatabaseName (string) --
The Database where this Crawler's output should be stored.
Description (string) --
A description of this Crawler and where it should be used.
Classifiers (list) --
A list of custom ``Classifier``s associated with this Crawler.
(string) --
SchemaChangePolicy (dict) --
Sets policy for the crawler's update and delete behavior.
UpdateBehavior (string) --
The update behavior.
DeleteBehavior (string) --
The deletion behavior.
State (string) --
Indicates whether this Crawler is running, or whether a run is pending.
TablePrefix (string) --
The table prefix used for catalog tables created.
Schedule (dict) --
A Schedule object that specifies the schedule on which this Crawler is to be run.
ScheduleExpression (string) --
A cron expression that can be used as a Cloudwatch event to schedule something (see CloudWatch Schedule Expression Syntax. 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 this Crawler is running, contains the total time elapsed since the last crawl began.
CreationTime (datetime) --
The time when the Crawler was created.
LastUpdated (datetime) --
The time 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) --
Error information about the last crawl, if an error occurred.
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.
Retrieves the Table definition in a Data Catalog for a specified table.
See also: AWS API Documentation
Request Syntax
client.get_table(
CatalogId='string',
DatabaseName='string',
Name='string'
)
string
The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the database in the catalog in which the table resides.
string
[REQUIRED]
The name of the table for which to retrieve the definition.
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'
},
],
'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
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string'
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'CreatedBy': 'string'
}
}
Response Structure
(dict) --
Table (dict) --
The Table object that defines the specified table.
Name (string) --
Name of the table.
DatabaseName (string) --
Name of the metadata database where the table metadata resides.
Description (string) --
Description of the table.
Owner (string) --
Owner of the table.
CreateTime (datetime) --
Time when the table definition was created in the Data Catalog.
UpdateTime (datetime) --
Last time the table was updated.
LastAccessTime (datetime) --
Last time the table was accessed. This is usually taken from HDFS, and may not be reliable.
LastAnalyzedTime (datetime) --
Last time column statistics were computed for this table.
Retention (integer) --
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 datatype of data in the Column.
Comment (string) --
Free-form text comment.
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) --
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) --
A list of initialization parameters for the SerDe, in key-value form.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
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) --
User-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
Information about values that appear very frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
PartitionKeys (list) --
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
(dict) --
A column in a Table.
Name (string) --
The name of the Column.
Type (string) --
The datatype of data in the Column.
Comment (string) --
Free-form text comment.
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) --
Properties associated with this table, as a list of key-value pairs.
(string) --
(string) --
CreatedBy (string) --
Person or entity who created the table.
Updates a specified DevEndpoint.
See also: AWS API Documentation
Request Syntax
client.update_dev_endpoint(
EndpointName='string',
PublicKey='string',
CustomLibraries={
'ExtraPythonLibsS3Path': 'string',
'ExtraJarsS3Path': 'string'
}
)
string
[REQUIRED]
The name of the DevEndpoint to be updated.
string
The public key for the DevEndpoint to use.
dict
Custom Python or Java custom libraries to be loaded in the DevEndpoint.
ExtraPythonLibsS3Path (string) --
Path to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint.
ExtraJarsS3Path (string) --
Path to one or more Java Jars in an S3 bucket that should be loaded in your DevEndpoint.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves all Databases defined in a given Data Catalog.
See also: AWS API Documentation
Request Syntax
client.get_databases(
CatalogId='string',
NextToken='string',
MaxResults=123
)
string
The ID of the Data Catalog from which to retrieve Databases. If none is supplied, the AWS account ID is used by default.
string
A continuation token, if this is a continuation call.
integer
The maximum number of databases to return in one response.
dict
Response Syntax
{
'DatabaseList': [
{
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'Parameters': {
'string': 'string'
},
'CreateTime': datetime(2015, 1, 1)
},
],
'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 may reside in a Hive metastore or an RDBMS.
Name (string) --
Name of the database.
Description (string) --
Description of the database.
LocationUri (string) --
The location of the database (for example, an HDFS path).
Parameters (dict) --
A list of key-value pairs that define parameters and properties of the database.
(string) --
(string) --
CreateTime (datetime) --
The time at which the metadata database was created in the catalog.
NextToken (string) --
A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
Retrieves the status of a migration operation.
See also: AWS API Documentation
Request Syntax
client.get_catalog_import_status(
CatalogId='string'
)
string
The ID of the catalog to migrate. Currently, this should be the AWS account ID.
dict
Response Syntax
{
'ImportStatus': {
'ImportCompleted': True|False,
'ImportTime': datetime(2015, 1, 1),
'ImportedBy': 'string'
}
}
Response Structure
(dict) --
ImportStatus (dict) --
The status of the specified catalog migration.
ImportCompleted (boolean) --
True if the migration has completed, or False otherwise.
ImportTime (datetime) --
The time that the migration was started.
ImportedBy (string) --
The name of the person who initiated the migration.
Retrieve a Classifier by name.
See also: AWS API Documentation
Request Syntax
client.get_classifier(
Name='string'
)
string
[REQUIRED]
Name of the Classifier to retrieve.
dict
Response Syntax
{
'Classifier': {
'GrokClassifier': {
'Name': 'string',
'Classification': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Version': 123,
'GrokPattern': 'string',
'CustomPatterns': 'string'
}
}
}
Response Structure
(dict) --
Classifier (dict) --
The requested Classifier.
GrokClassifier (dict) --
A GrokClassifier object.
Name (string) --
The name of the classifier.
Classification (string) --
The data form that the classifier matches, such as Twitter, JSON, Omniture Logs, and so forth.
CreationTime (datetime) --
The time this classifier was registered.
LastUpdated (datetime) --
The time this classifier was last updated.
Version (integer) --
The version of this classifier.
GrokPattern (string) --
The grok pattern used by this classifier.
CustomPatterns (string) --
Custom grok patterns used by this classifier.
Removes a specified Database from a Data Catalog.
See also: AWS API Documentation
Request Syntax
client.delete_database(
CatalogId='string',
Name='string'
)
string
The ID of the Data Catalog in which the database resides. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The name of the Database to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a new table definition in the Data Catalog.
See also: AWS API Documentation
Request Syntax
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'
},
],
'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
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string'
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
}
}
)
string
The ID of the Data Catalog in which to create the Table. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The catalog database in which to create the new table.
dict
[REQUIRED]
The TableInput object that defines the metadata table to create in the catalog.
Name (string) -- [REQUIRED]
Name of the table.
Description (string) --
Description of the table.
Owner (string) --
Owner of the table.
LastAccessTime (datetime) --
Last time the table was accessed.
LastAnalyzedTime (datetime) --
Last time column statistics were computed for this table.
Retention (integer) --
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) -- [REQUIRED]
The name of the Column.
Type (string) --
The datatype of data in the Column.
Comment (string) --
Free-form text comment.
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) --
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) --
A list of initialization parameters for the SerDe, in key-value form.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
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) -- [REQUIRED]
The name of the column.
SortOrder (integer) -- [REQUIRED]
Indicates that the column is sorted in ascending order ( == 1), or in descending order ( ==0).
Parameters (dict) --
User-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
Information about values that appear very frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
PartitionKeys (list) --
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
(dict) --
A column in a Table.
Name (string) -- [REQUIRED]
The name of the Column.
Type (string) --
The datatype of data in the Column.
Comment (string) --
Free-form text comment.
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) --
Properties associated with this table, as a list of key-value pairs.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves the definitions of some or all of the tables in a given Database.
See also: AWS API Documentation
Request Syntax
client.get_tables(
CatalogId='string',
DatabaseName='string',
Expression='string',
NextToken='string',
MaxResults=123
)
string
The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.
string
[REQUIRED]
The database in the catalog whose tables to list.
string
A regular expression pattern. If present, only those tables whose names match the pattern are returned.
string
A continuation token, included if this is a continuation call.
integer
The maximum number of tables to return in a single 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'
},
],
'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
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string'
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'CreatedBy': '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) --
Name of the table.
DatabaseName (string) --
Name of the metadata database where the table metadata resides.
Description (string) --
Description of the table.
Owner (string) --
Owner of the table.
CreateTime (datetime) --
Time when the table definition was created in the Data Catalog.
UpdateTime (datetime) --
Last time the table was updated.
LastAccessTime (datetime) --
Last time the table was accessed. This is usually taken from HDFS, and may not be reliable.
LastAnalyzedTime (datetime) --
Last time column statistics were computed for this table.
Retention (integer) --
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 datatype of data in the Column.
Comment (string) --
Free-form text comment.
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) --
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) --
A list of initialization parameters for the SerDe, in key-value form.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
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) --
User-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
Information about values that appear very frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
PartitionKeys (list) --
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
(dict) --
A column in a Table.
Name (string) --
The name of the Column.
Type (string) --
The datatype of data in the Column.
Comment (string) --
Free-form text comment.
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) --
Properties associated with this table, as a list of key-value pairs.
(string) --
(string) --
CreatedBy (string) --
Person or entity who created the table.
NextToken (string) --
A continuation token, present if the current list segment is not the last.