Glue

Table of Contents

Client

class Glue.Client

A low-level client representing AWS Glue:

import boto3

client = boto3.client('glue')

These are the available methods:

batch_create_partition(**kwargs)

Creates one or more partitions in a batch operation.

See also: AWS API Documentation

Request Syntax

response = client.batch_create_partition(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    PartitionInputList=[
        {
            'Values': [
                'string',
            ],
            'LastAccessTime': datetime(2015, 1, 1),
            'StorageDescriptor': {
                'Columns': [
                    {
                        'Name': 'string',
                        'Type': 'string',
                        'Comment': 'string'
                    },
                ],
                '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)
        },
    ]
)
Parameters
  • CatalogId (string) -- The ID of the catalog in which the partion is to be created. Currently, this should be the AWS account ID.
  • DatabaseName (string) --

    [REQUIRED]

    The name of the metadata database in which the partition is to be created.

  • TableName (string) --

    [REQUIRED]

    The name of the metadata table in which the partition is to be created.

  • PartitionInputList (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. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.

        • (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) --

            These key-value pairs define initialization parameters for the SerDe.

            • (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) --

        These key-value pairs define partition parameters.

        • (string) --
          • (string) --
      • LastAnalyzedTime (datetime) --

        The last time at which column statistics were computed for this partition.

Return type

dict

Returns

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.

batch_delete_connection(**kwargs)

Deletes a list of connection definitions from the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_connection(
    CatalogId='string',
    ConnectionNameList=[
        'string',
    ]
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog in which the connections reside. If none is provided, the AWS account ID is used by default.
  • ConnectionNameList (list) --

    [REQUIRED]

    A list of names of the connections to delete.

    • (string) --
Return type

dict

Returns

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.

batch_delete_partition(**kwargs)

Deletes one or more partitions in a batch operation.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_partition(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    PartitionsToDelete=[
        {
            'Values': [
                'string',
            ]
        },
    ]
)
Parameters
  • CatalogId (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.
  • DatabaseName (string) --

    [REQUIRED]

    The name of the catalog database in which the table in question resides.

  • TableName (string) --

    [REQUIRED]

    The name of the table where the partitions to be deleted is located.

  • PartitionsToDelete (list) --

    [REQUIRED]

    A list of PartitionInput structures that define the partitions to be deleted.

    • (dict) --

      Contains a list of values defining partitions.

      • Values (list) -- [REQUIRED]

        The list of values.

        • (string) --
Return type

dict

Returns

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.

batch_delete_table(**kwargs)

Deletes multiple tables at once.

Note

After completing this operation, you will no longer have access to the table versions and partitions that belong to the deleted table. AWS Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.

To ensure immediate deletion of all related resources, before calling BatchDeleteTable , use DeleteTableVersion or BatchDeleteTableVersion , and DeletePartition or BatchDeletePartition , to delete any resources that belong to the table.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_table(
    CatalogId='string',
    DatabaseName='string',
    TablesToDelete=[
        'string',
    ]
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default.
  • DatabaseName (string) --

    [REQUIRED]

    The name of the catalog database where the tables to delete reside. For Hive compatibility, this name is entirely lowercase.

  • TablesToDelete (list) --

    [REQUIRED]

    A list of the table to delete.

    • (string) --
Return type

dict

Returns

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. For Hive compatibility, this must be entirely lowercase.

        • ErrorDetail (dict) --

          Detail about the error.

          • ErrorCode (string) --

            The code associated with this error.

          • ErrorMessage (string) --

            A message describing the error.

batch_delete_table_version(**kwargs)

Deletes a specified batch of versions of a table.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_table_version(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    VersionIds=[
        'string',
    ]
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.
  • DatabaseName (string) --

    [REQUIRED]

    The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

  • TableName (string) --

    [REQUIRED]

    The name of the table. For Hive compatibility, this name is entirely lowercase.

  • VersionIds (list) --

    [REQUIRED]

    A list of the IDs of versions to be deleted. A VersionId is a string representation of an integer. Each version is incremented by 1.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'Errors': [
        {
            'TableName': 'string',
            'VersionId': 'string',
            'ErrorDetail': {
                'ErrorCode': 'string',
                'ErrorMessage': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • Errors (list) --

      A list of errors encountered while trying to delete the specified table versions.

      • (dict) --

        An error record for table-version operations.

        • TableName (string) --

          The name of the table in question.

        • VersionId (string) --

          The ID value of the version in question. A VersionID is a string representation of an integer. Each version is incremented by 1.

        • ErrorDetail (dict) --

          Detail about the error.

          • ErrorCode (string) --

            The code associated with this error.

          • ErrorMessage (string) --

            A message describing the error.

batch_get_crawlers(**kwargs)

Returns a list of resource metadata for a given list of crawler names. After calling the ListCrawlers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_crawlers(
    CrawlerNames=[
        'string',
    ]
)
Parameters
CrawlerNames (list) --

[REQUIRED]

A list of crawler names, which might be the names returned from the ListCrawlers operation.

  • (string) --
Return type
dict
Returns
Response Syntax
{
    'Crawlers': [
        {
            'Name': 'string',
            'Role': 'string',
            'Targets': {
                'S3Targets': [
                    {
                        'Path': 'string',
                        'Exclusions': [
                            'string',
                        ]
                    },
                ],
                'JdbcTargets': [
                    {
                        'ConnectionName': 'string',
                        'Path': 'string',
                        'Exclusions': [
                            'string',
                        ]
                    },
                ],
                'DynamoDBTargets': [
                    {
                        'Path': 'string'
                    },
                ],
                'CatalogTargets': [
                    {
                        'DatabaseName': 'string',
                        'Tables': [
                            '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,
            'Configuration': 'string',
            'CrawlerSecurityConfiguration': 'string'
        },
    ],
    'CrawlersNotFound': [
        'string',
    ]
}

Response Structure

  • (dict) --
    • Crawlers (list) --

      A list of crawler definitions.

      • (dict) --

        Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source in the AWS Glue Data Catalog.

        • Name (string) --

          The name of the crawler.

        • Role (string) --

          The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.

        • Targets (dict) --

          A collection of targets to crawl.

          • S3Targets (list) --

            Specifies Amazon Simple Storage Service (Amazon S3) targets.

            • (dict) --

              Specifies a data store in Amazon Simple Storage Service (Amazon S3).

              • Path (string) --

                The path to the Amazon S3 target.

              • Exclusions (list) --

                A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .

                • (string) --
          • JdbcTargets (list) --

            Specifies JDBC targets.

            • (dict) --

              Specifies a JDBC data store to crawl.

              • ConnectionName (string) --

                The name of the connection to use to connect to the JDBC target.

              • Path (string) --

                The path of the JDBC target.

              • Exclusions (list) --

                A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .

                • (string) --
          • DynamoDBTargets (list) --

            Specifies Amazon DynamoDB targets.

            • (dict) --

              Specifies an Amazon DynamoDB table to crawl.

              • Path (string) --

                The name of the DynamoDB table to crawl.

          • CatalogTargets (list) --

            Specifies AWS Glue Data Catalog targets.

            • (dict) --

              Specifies an AWS Glue Data Catalog target.

              • DatabaseName (string) --

                The name of the database to be synchronized.

              • Tables (list) --

                A list of the tables to be synchronized.

                • (string) --
        • DatabaseName (string) --

          The name of the database in which the crawler's output is stored.

        • Description (string) --

          A description of the crawler.

        • Classifiers (list) --

          A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.

          • (string) --
        • SchemaChangePolicy (dict) --

          The policy that specifies update and delete behaviors for the crawler.

          • UpdateBehavior (string) --

            The update behavior when the crawler finds a changed schema.

          • DeleteBehavior (string) --

            The deletion behavior when the crawler finds a deleted object.

        • State (string) --

          Indicates whether the crawler is running, or whether a run is pending.

        • TablePrefix (string) --

          The prefix added to the names of tables that are created.

        • Schedule (dict) --

          For scheduled crawlers, the schedule when the crawler runs.

          • ScheduleExpression (string) --

            A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *) .

          • State (string) --

            The state of the schedule.

        • CrawlElapsedTime (integer) --

          If the crawler is running, contains the total time elapsed since the last crawl began.

        • CreationTime (datetime) --

          The time that the crawler was created.

        • LastUpdated (datetime) --

          The time that the crawler was last updated.

        • LastCrawl (dict) --

          The status of the last crawl, and potentially error information if an error occurred.

          • Status (string) --

            Status of the last crawl.

          • ErrorMessage (string) --

            If an error occurred, the error information about the last crawl.

          • LogGroup (string) --

            The log group for the last crawl.

          • LogStream (string) --

            The log stream for the last crawl.

          • MessagePrefix (string) --

            The prefix for a message about this crawl.

          • StartTime (datetime) --

            The time at which the crawl started.

        • Version (integer) --

          The version of the crawler.

        • Configuration (string) --

          Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler .

        • CrawlerSecurityConfiguration (string) --

          The name of the SecurityConfiguration structure to be used by this crawler.

    • CrawlersNotFound (list) --

      A list of names of crawlers that were not found.

      • (string) --
batch_get_dev_endpoints(**kwargs)

Returns a list of resource metadata for a given list of DevEndpoint names. After calling the ListDevEndpoints operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_dev_endpoints(
    DevEndpointNames=[
        'string',
    ]
)
Parameters
DevEndpointNames (list) --

[REQUIRED]

The list of DevEndpoint names, which may be the names returned from the ListDevEndpoint operation.

  • (string) --
Return type
dict
Returns
Response Syntax
{
    'DevEndpoints': [
        {
            'EndpointName': 'string',
            'RoleArn': 'string',
            'SecurityGroupIds': [
                'string',
            ],
            'SubnetId': 'string',
            'YarnEndpointAddress': 'string',
            'PrivateAddress': 'string',
            'ZeppelinRemoteSparkInterpreterPort': 123,
            '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',
            'PublicKeys': [
                'string',
            ],
            'SecurityConfiguration': 'string',
            'Arguments': {
                'string': 'string'
            }
        },
    ],
    'DevEndpointsNotFound': [
        '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.

        • PrivateAddress (string) --

          A private IP address to access the DevEndpoint within a VPC, if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your virtual private cloud (VPC).

        • ZeppelinRemoteSparkInterpreterPort (integer) --

          The Apache Zeppelin port for the remote Apache Spark interpreter.

        • PublicAddress (string) --

          The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-VPC (virtual private cloud) DevEndpoint.

        • Status (string) --

          The current status of this DevEndpoint.

        • NumberOfNodes (integer) --

          The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

        • AvailabilityZone (string) --

          The AWS availability zone where this DevEndpoint is located.

        • VpcId (string) --

          The ID of the virtual private cloud (VPC) used by this DevEndpoint.

        • ExtraPythonLibsS3Path (string) --

          Path(s) to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

          Please note that only pure Python libraries can currently be used on a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.

        • ExtraJarsS3Path (string) --

          Path to one or more Java Jars in an S3 bucket that should be loaded in your DevEndpoint.

          Please note that only pure Java/Scala libraries can currently be used on a DevEndpoint.

        • FailureReason (string) --

          The reason for a current failure in this DevEndpoint.

        • LastUpdateStatus (string) --

          The status of the last update.

        • CreatedTimestamp (datetime) --

          The point in time at which this DevEndpoint was created.

        • LastModifiedTimestamp (datetime) --

          The point in time at which this DevEndpoint was last modified.

        • PublicKey (string) --

          The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility, as the recommended attribute to use is public keys.

        • PublicKeys (list) --

          A list of public keys to be used by the DevEndpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.

          Note

          If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys: call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.

          • (string) --
        • SecurityConfiguration (string) --

          The name of the SecurityConfiguration structure to be used with this DevEndpoint.

        • Arguments (dict) --

          A map of arguments used to configure the DevEndpoint.

          Note that currently, we only support "--enable-glue-datacatalog": "" as a valid argument.

          • (string) --
            • (string) --
    • DevEndpointsNotFound (list) --

      A list of DevEndpoints not found.

      • (string) --
batch_get_jobs(**kwargs)

Returns a list of resource metadata for a given list of job names. After calling the ListJobs operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_jobs(
    JobNames=[
        'string',
    ]
)
Parameters
JobNames (list) --

[REQUIRED]

A list of job names, which might be the names returned from the ListJobs operation.

  • (string) --
Return type
dict
Returns
Response Syntax
{
    'Jobs': [
        {
            'Name': 'string',
            'Description': 'string',
            'LogUri': 'string',
            'Role': 'string',
            'CreatedOn': datetime(2015, 1, 1),
            'LastModifiedOn': datetime(2015, 1, 1),
            'ExecutionProperty': {
                'MaxConcurrentRuns': 123
            },
            'Command': {
                'Name': 'string',
                'ScriptLocation': 'string',
                'PythonVersion': 'string'
            },
            'DefaultArguments': {
                'string': 'string'
            },
            'Connections': {
                'Connections': [
                    'string',
                ]
            },
            'MaxRetries': 123,
            'AllocatedCapacity': 123,
            'Timeout': 123,
            'MaxCapacity': 123.0,
            'WorkerType': 'Standard'|'G.1X'|'G.2X',
            'NumberOfWorkers': 123,
            'SecurityConfiguration': 'string',
            'NotificationProperty': {
                'NotifyDelayAfter': 123
            }
        },
    ],
    'JobsNotFound': [
        'string',
    ]
}

Response Structure

  • (dict) --
    • Jobs (list) --

      A list of job definitions.

      • (dict) --

        Specifies a job definition.

        • Name (string) --

          The name you assign to this job definition.

        • Description (string) --

          A description of the job.

        • LogUri (string) --

          This field is reserved for future use.

        • Role (string) --

          The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

        • CreatedOn (datetime) --

          The time and date that this job definition was created.

        • LastModifiedOn (datetime) --

          The last point in time when this job definition was modified.

        • ExecutionProperty (dict) --

          An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

          • MaxConcurrentRuns (integer) --

            The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

        • Command (dict) --

          The JobCommand that executes this job.

          • Name (string) --

            The name of the job command. For an Apache Spark ETL job, this must be glueetl . For a Python shell job, it must be pythonshell .

          • ScriptLocation (string) --

            Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that executes a job.

          • PythonVersion (string) --

            The Python version being used to execute a Python shell job. Allowed values are 2 or 3.

        • DefaultArguments (dict) --

          The default arguments for this job, specified as name-value pairs.

          You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

          For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

          For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

          • (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 after a JobRun fails.

        • AllocatedCapacity (integer) --

          This field is deprecated. Use MaxCapacity instead.

          The number of AWS Glue data processing units (DPUs) allocated to runs of this job. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

        • Timeout (integer) --

          The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

        • MaxCapacity (float) --

          The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

          Do not set Max Capacity if using WorkerType and NumberOfWorkers .

          The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

          • When you specify a Python shell job (JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
          • When you specify an Apache Spark ETL job (JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
        • WorkerType (string) --

          The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

          • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
          • For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
          • For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
        • NumberOfWorkers (integer) --

          The number of workers of a defined workerType that are allocated when a job runs.

          The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

        • SecurityConfiguration (string) --

          The name of the SecurityConfiguration structure to be used with this job.

        • NotificationProperty (dict) --

          Specifies configuration properties of a job notification.

          • NotifyDelayAfter (integer) --

            After a job run starts, the number of minutes to wait before sending a job run delay notification.

    • JobsNotFound (list) --

      A list of names of jobs not found.

      • (string) --
batch_get_partition(**kwargs)

Retrieves partitions in a batch request.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_partition(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    PartitionsToGet=[
        {
            'Values': [
                'string',
            ]
        },
    ]
)
Parameters
  • CatalogId (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.
  • DatabaseName (string) --

    [REQUIRED]

    The name of the catalog database where the partitions reside.

  • TableName (string) --

    [REQUIRED]

    The name of the partitions' table.

  • PartitionsToGet (list) --

    [REQUIRED]

    A list of partition values identifying the partitions to retrieve.

    • (dict) --

      Contains a list of values defining partitions.

      • Values (list) -- [REQUIRED]

        The list of values.

        • (string) --
Return type

dict

Returns

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) --

              These key-value pairs define initialization parameters for the SerDe.

              • (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) --

          These key-value pairs define partition parameters.

          • (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) --

        Contains a list of values defining partitions.

        • Values (list) --

          The list of values.

          • (string) --

batch_get_triggers(**kwargs)

Returns a list of resource metadata for a given list of trigger names. After calling the ListTriggers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_triggers(
    TriggerNames=[
        'string',
    ]
)
Parameters
TriggerNames (list) --

[REQUIRED]

A list of trigger names, which may be the names returned from the ListTriggers operation.

  • (string) --
Return type
dict
Returns
Response Syntax
{
    'Triggers': [
        {
            'Name': 'string',
            'WorkflowName': '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'
                    },
                    'Timeout': 123,
                    'SecurityConfiguration': 'string',
                    'NotificationProperty': {
                        'NotifyDelayAfter': 123
                    },
                    'CrawlerName': 'string'
                },
            ],
            'Predicate': {
                'Logical': 'AND'|'ANY',
                'Conditions': [
                    {
                        'LogicalOperator': 'EQUALS',
                        'JobName': 'string',
                        'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                        'CrawlerName': 'string',
                        'CrawlState': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED'
                    },
                ]
            }
        },
    ],
    'TriggersNotFound': [
        'string',
    ]
}

Response Structure

  • (dict) --
    • Triggers (list) --

      A list of trigger definitions.

      • (dict) --

        Information about a specific trigger.

        • Name (string) --

          The name of the trigger.

        • WorkflowName (string) --

          The name of the workflow associated with the trigger.

        • Id (string) --

          Reserved for future use.

        • Type (string) --

          The type of trigger that this is.

        • State (string) --

          The current state of the trigger.

        • Description (string) --

          A description of this trigger.

        • Schedule (string) --

          A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .

        • Actions (list) --

          The actions initiated by this trigger.

          • (dict) --

            Defines an action to be initiated by a trigger.

            • JobName (string) --

              The name of a job to be executed.

            • Arguments (dict) --

              The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

              You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

              For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

              For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

              • (string) --
                • (string) --
            • Timeout (integer) --

              The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

            • SecurityConfiguration (string) --

              The name of the SecurityConfiguration structure to be used with this action.

            • NotificationProperty (dict) --

              Specifies configuration properties of a job run notification.

              • NotifyDelayAfter (integer) --

                After a job run starts, the number of minutes to wait before sending a job run delay notification.

            • CrawlerName (string) --

              The name of the crawler to be used with this action.

        • Predicate (dict) --

          The predicate of this trigger, which defines when it will fire.

          • Logical (string) --

            An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

          • Conditions (list) --

            A list of the conditions that determine when the trigger will fire.

            • (dict) --

              Defines a condition under which a trigger fires.

              • LogicalOperator (string) --

                A logical operator.

              • JobName (string) --

                The name of the job whose JobRuns this condition applies to, and on which this trigger waits.

              • State (string) --

                The condition state. Currently, the values supported are SUCCEEDED , STOPPED , TIMEOUT , and FAILED .

              • CrawlerName (string) --

                The name of the crawler to which this condition applies.

              • CrawlState (string) --

                The state of the crawler to which this condition applies.

    • TriggersNotFound (list) --

      A list of names of triggers not found.

      • (string) --
batch_get_workflows(**kwargs)

Returns a list of resource metadata for a given list of workflow names. After calling the ListWorkflows operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_workflows(
    Names=[
        'string',
    ],
    IncludeGraph=True|False
)
Parameters
  • Names (list) --

    [REQUIRED]

    A list of workflow names, which may be the names returned from the ListWorkflows operation.

    • (string) --
  • IncludeGraph (boolean) -- Specifies whether to include a graph when returning the workflow resource metadata.
Return type

dict

Returns

Response Syntax

{
    'Workflows': [
        {
            'Name': 'string',
            'Description': 'string',
            'DefaultRunProperties': {
                'string': 'string'
            },
            'CreatedOn': datetime(2015, 1, 1),
            'LastModifiedOn': datetime(2015, 1, 1),
            'LastRun': {
                'Name': 'string',
                'WorkflowRunId': 'string',
                'WorkflowRunProperties': {
                    'string': 'string'
                },
                'StartedOn': datetime(2015, 1, 1),
                'CompletedOn': datetime(2015, 1, 1),
                'Status': 'RUNNING'|'COMPLETED',
                'Statistics': {
                    'TotalActions': 123,
                    'TimeoutActions': 123,
                    'FailedActions': 123,
                    'StoppedActions': 123,
                    'SucceededActions': 123,
                    'RunningActions': 123
                },
                'Graph': {
                    'Nodes': [
                        {
                            'Type': 'CRAWLER'|'JOB'|'TRIGGER',
                            'Name': 'string',
                            'UniqueId': 'string',
                            'TriggerDetails': {
                                'Trigger': {
                                    'Name': 'string',
                                    'WorkflowName': 'string',
                                    'Id': 'string',
                                    'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND',
                                    'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
                                    'Description': 'string',
                                    'Schedule': 'string',
                                    'Actions': [
                                        {
                                            'JobName': 'string',
                                            'Arguments': {
                                                'string': 'string'
                                            },
                                            'Timeout': 123,
                                            'SecurityConfiguration': 'string',
                                            'NotificationProperty': {
                                                'NotifyDelayAfter': 123
                                            },
                                            'CrawlerName': 'string'
                                        },
                                    ],
                                    'Predicate': {
                                        'Logical': 'AND'|'ANY',
                                        'Conditions': [
                                            {
                                                'LogicalOperator': 'EQUALS',
                                                'JobName': 'string',
                                                'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                                                'CrawlerName': 'string',
                                                'CrawlState': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED'
                                            },
                                        ]
                                    }
                                }
                            },
                            'JobDetails': {
                                'JobRuns': [
                                    {
                                        'Id': 'string',
                                        'Attempt': 123,
                                        'PreviousRunId': 'string',
                                        'TriggerName': 'string',
                                        'JobName': 'string',
                                        'StartedOn': datetime(2015, 1, 1),
                                        'LastModifiedOn': datetime(2015, 1, 1),
                                        'CompletedOn': datetime(2015, 1, 1),
                                        'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                                        'Arguments': {
                                            'string': 'string'
                                        },
                                        'ErrorMessage': 'string',
                                        'PredecessorRuns': [
                                            {
                                                'JobName': 'string',
                                                'RunId': 'string'
                                            },
                                        ],
                                        'AllocatedCapacity': 123,
                                        'ExecutionTime': 123,
                                        'Timeout': 123,
                                        'MaxCapacity': 123.0,
                                        'WorkerType': 'Standard'|'G.1X'|'G.2X',
                                        'NumberOfWorkers': 123,
                                        'SecurityConfiguration': 'string',
                                        'LogGroupName': 'string',
                                        'NotificationProperty': {
                                            'NotifyDelayAfter': 123
                                        }
                                    },
                                ]
                            },
                            'CrawlerDetails': {
                                'Crawls': [
                                    {
                                        'State': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED',
                                        'StartedOn': datetime(2015, 1, 1),
                                        'CompletedOn': datetime(2015, 1, 1),
                                        'ErrorMessage': 'string',
                                        'LogGroup': 'string',
                                        'LogStream': 'string'
                                    },
                                ]
                            }
                        },
                    ],
                    'Edges': [
                        {
                            'SourceId': 'string',
                            'DestinationId': 'string'
                        },
                    ]
                }
            },
            'Graph': {
                'Nodes': [
                    {
                        'Type': 'CRAWLER'|'JOB'|'TRIGGER',
                        'Name': 'string',
                        'UniqueId': 'string',
                        'TriggerDetails': {
                            'Trigger': {
                                'Name': 'string',
                                'WorkflowName': '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'
                                        },
                                        'Timeout': 123,
                                        'SecurityConfiguration': 'string',
                                        'NotificationProperty': {
                                            'NotifyDelayAfter': 123
                                        },
                                        'CrawlerName': 'string'
                                    },
                                ],
                                'Predicate': {
                                    'Logical': 'AND'|'ANY',
                                    'Conditions': [
                                        {
                                            'LogicalOperator': 'EQUALS',
                                            'JobName': 'string',
                                            'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                                            'CrawlerName': 'string',
                                            'CrawlState': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED'
                                        },
                                    ]
                                }
                            }
                        },
                        'JobDetails': {
                            'JobRuns': [
                                {
                                    'Id': 'string',
                                    'Attempt': 123,
                                    'PreviousRunId': 'string',
                                    'TriggerName': 'string',
                                    'JobName': 'string',
                                    'StartedOn': datetime(2015, 1, 1),
                                    'LastModifiedOn': datetime(2015, 1, 1),
                                    'CompletedOn': datetime(2015, 1, 1),
                                    'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                                    'Arguments': {
                                        'string': 'string'
                                    },
                                    'ErrorMessage': 'string',
                                    'PredecessorRuns': [
                                        {
                                            'JobName': 'string',
                                            'RunId': 'string'
                                        },
                                    ],
                                    'AllocatedCapacity': 123,
                                    'ExecutionTime': 123,
                                    'Timeout': 123,
                                    'MaxCapacity': 123.0,
                                    'WorkerType': 'Standard'|'G.1X'|'G.2X',
                                    'NumberOfWorkers': 123,
                                    'SecurityConfiguration': 'string',
                                    'LogGroupName': 'string',
                                    'NotificationProperty': {
                                        'NotifyDelayAfter': 123
                                    }
                                },
                            ]
                        },
                        'CrawlerDetails': {
                            'Crawls': [
                                {
                                    'State': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED',
                                    'StartedOn': datetime(2015, 1, 1),
                                    'CompletedOn': datetime(2015, 1, 1),
                                    'ErrorMessage': 'string',
                                    'LogGroup': 'string',
                                    'LogStream': 'string'
                                },
                            ]
                        }
                    },
                ],
                'Edges': [
                    {
                        'SourceId': 'string',
                        'DestinationId': 'string'
                    },
                ]
            }
        },
    ],
    'MissingWorkflows': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • Workflows (list) --

      A list of workflow resource metadata.

      • (dict) --

        A workflow represents a flow in which AWS Glue components should be executed to complete a logical task.

        • Name (string) --

          The name of the workflow representing the flow.

        • Description (string) --

          A description of the workflow.

        • DefaultRunProperties (dict) --

          A collection of properties to be used as part of each execution of the workflow.

          • (string) --
            • (string) --
        • CreatedOn (datetime) --

          The date and time when the workflow was created.

        • LastModifiedOn (datetime) --

          The date and time when the workflow was last modified.

        • LastRun (dict) --

          The information about the last execution of the workflow.

          • Name (string) --

            Name of the workflow which was executed.

          • WorkflowRunId (string) --

            The ID of this workflow run.

          • WorkflowRunProperties (dict) --

            The workflow run properties which were set during the run.

            • (string) --
              • (string) --
          • StartedOn (datetime) --

            The date and time when the workflow run was started.

          • CompletedOn (datetime) --

            The date and time when the workflow run completed.

          • Status (string) --

            The status of the workflow run.

          • Statistics (dict) --

            The statistics of the run.

            • TotalActions (integer) --

              Total number of Actions in the workflow run.

            • TimeoutActions (integer) --

              Total number of Actions which timed out.

            • FailedActions (integer) --

              Total number of Actions which have failed.

            • StoppedActions (integer) --

              Total number of Actions which have stopped.

            • SucceededActions (integer) --

              Total number of Actions which have succeeded.

            • RunningActions (integer) --

              Total number Actions in running state.

          • Graph (dict) --

            The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.

            • Nodes (list) --

              A list of the the AWS Glue components belong to the workflow represented as nodes.

              • (dict) --

                A node represents an AWS Glue component like Trigger, Job etc. which is part of a workflow.

                • Type (string) --

                  The type of AWS Glue component represented by the node.

                • Name (string) --

                  The name of the AWS Glue component represented by the node.

                • UniqueId (string) --

                  The unique Id assigned to the node within the workflow.

                • TriggerDetails (dict) --

                  Details of the Trigger when the node represents a Trigger.

                  • Trigger (dict) --

                    The information of the trigger represented by the trigger node.

                    • Name (string) --

                      The name of the trigger.

                    • WorkflowName (string) --

                      The name of the workflow associated with the trigger.

                    • Id (string) --

                      Reserved for future use.

                    • Type (string) --

                      The type of trigger that this is.

                    • State (string) --

                      The current state of the trigger.

                    • Description (string) --

                      A description of this trigger.

                    • Schedule (string) --

                      A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .

                    • Actions (list) --

                      The actions initiated by this trigger.

                      • (dict) --

                        Defines an action to be initiated by a trigger.

                        • JobName (string) --

                          The name of a job to be executed.

                        • Arguments (dict) --

                          The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

                          You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

                          For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

                          For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

                          • (string) --
                            • (string) --
                        • Timeout (integer) --

                          The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

                        • SecurityConfiguration (string) --

                          The name of the SecurityConfiguration structure to be used with this action.

                        • NotificationProperty (dict) --

                          Specifies configuration properties of a job run notification.

                          • NotifyDelayAfter (integer) --

                            After a job run starts, the number of minutes to wait before sending a job run delay notification.

                        • CrawlerName (string) --

                          The name of the crawler to be used with this action.

                    • Predicate (dict) --

                      The predicate of this trigger, which defines when it will fire.

                      • Logical (string) --

                        An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

                      • Conditions (list) --

                        A list of the conditions that determine when the trigger will fire.

                        • (dict) --

                          Defines a condition under which a trigger fires.

                          • LogicalOperator (string) --

                            A logical operator.

                          • JobName (string) --

                            The name of the job whose JobRuns this condition applies to, and on which this trigger waits.

                          • State (string) --

                            The condition state. Currently, the values supported are SUCCEEDED , STOPPED , TIMEOUT , and FAILED .

                          • CrawlerName (string) --

                            The name of the crawler to which this condition applies.

                          • CrawlState (string) --

                            The state of the crawler to which this condition applies.

                • JobDetails (dict) --

                  Details of the Job when the node represents a Job.

                  • JobRuns (list) --

                    The information for the job runs represented by the job node.

                    • (dict) --

                      Contains information about a job run.

                      • Id (string) --

                        The ID of this job run.

                      • Attempt (integer) --

                        The number of the attempt to run this job.

                      • PreviousRunId (string) --

                        The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

                      • TriggerName (string) --

                        The name of the trigger that started this job run.

                      • JobName (string) --

                        The name of the job definition being used in this run.

                      • StartedOn (datetime) --

                        The date and time at which this job run was started.

                      • LastModifiedOn (datetime) --

                        The last time that this job run was modified.

                      • CompletedOn (datetime) --

                        The date and time that this job run completed.

                      • JobRunState (string) --

                        The current state of the job run.

                      • Arguments (dict) --

                        The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.

                        You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

                        For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

                        For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

                        • (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 was used in the predicate of a conditional trigger that triggered this job run.

                          • JobName (string) --

                            The name of the job definition used by the predecessor job run.

                          • RunId (string) --

                            The job-run ID of the predecessor job run.

                      • AllocatedCapacity (integer) --

                        This field is deprecated. Use MaxCapacity instead.

                        The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

                      • ExecutionTime (integer) --

                        The amount of time (in seconds) that the job run consumed resources.

                      • Timeout (integer) --

                        The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

                      • MaxCapacity (float) --

                        The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

                        Do not set Max Capacity if using WorkerType and NumberOfWorkers .

                        The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

                        • When you specify a Python shell job (JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
                        • When you specify an Apache Spark ETL job (JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
                      • WorkerType (string) --

                        The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

                        • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
                        • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
                        • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
                      • NumberOfWorkers (integer) --

                        The number of workers of a defined workerType that are allocated when a job runs.

                        The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

                      • SecurityConfiguration (string) --

                        The name of the SecurityConfiguration structure to be used with this job run.

                      • LogGroupName (string) --

                        The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using AWS KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.

                      • NotificationProperty (dict) --

                        Specifies configuration properties of a job run notification.

                        • NotifyDelayAfter (integer) --

                          After a job run starts, the number of minutes to wait before sending a job run delay notification.

                • CrawlerDetails (dict) --

                  Details of the crawler when the node represents a crawler.

                  • Crawls (list) --

                    A list of crawls represented by the crawl node.

                    • (dict) --

                      The details of a crawl in the workflow.

                      • State (string) --

                        The state of the crawler.

                      • StartedOn (datetime) --

                        The date and time on which the crawl started.

                      • CompletedOn (datetime) --

                        The date and time on which the crawl completed.

                      • ErrorMessage (string) --

                        The error message associated with the crawl.

                      • LogGroup (string) --

                        The log group associated with the crawl.

                      • LogStream (string) --

                        The log stream associated with the crawl.

            • Edges (list) --

              A list of all the directed connections between the nodes belonging to the workflow.

              • (dict) --

                An edge represents a directed connection between two AWS Glue components which are part of the workflow the edge belongs to.

                • SourceId (string) --

                  The unique of the node within the workflow where the edge starts.

                • DestinationId (string) --

                  The unique of the node within the workflow where the edge ends.

        • Graph (dict) --

          The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.

          • Nodes (list) --

            A list of the the AWS Glue components belong to the workflow represented as nodes.

            • (dict) --

              A node represents an AWS Glue component like Trigger, Job etc. which is part of a workflow.

              • Type (string) --

                The type of AWS Glue component represented by the node.

              • Name (string) --

                The name of the AWS Glue component represented by the node.

              • UniqueId (string) --

                The unique Id assigned to the node within the workflow.

              • TriggerDetails (dict) --

                Details of the Trigger when the node represents a Trigger.

                • Trigger (dict) --

                  The information of the trigger represented by the trigger node.

                  • Name (string) --

                    The name of the trigger.

                  • WorkflowName (string) --

                    The name of the workflow associated with the trigger.

                  • Id (string) --

                    Reserved for future use.

                  • Type (string) --

                    The type of trigger that this is.

                  • State (string) --

                    The current state of the trigger.

                  • Description (string) --

                    A description of this trigger.

                  • Schedule (string) --

                    A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .

                  • Actions (list) --

                    The actions initiated by this trigger.

                    • (dict) --

                      Defines an action to be initiated by a trigger.

                      • JobName (string) --

                        The name of a job to be executed.

                      • Arguments (dict) --

                        The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

                        You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

                        For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

                        For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

                        • (string) --
                          • (string) --
                      • Timeout (integer) --

                        The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

                      • SecurityConfiguration (string) --

                        The name of the SecurityConfiguration structure to be used with this action.

                      • NotificationProperty (dict) --

                        Specifies configuration properties of a job run notification.

                        • NotifyDelayAfter (integer) --

                          After a job run starts, the number of minutes to wait before sending a job run delay notification.

                      • CrawlerName (string) --

                        The name of the crawler to be used with this action.

                  • Predicate (dict) --

                    The predicate of this trigger, which defines when it will fire.

                    • Logical (string) --

                      An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

                    • Conditions (list) --

                      A list of the conditions that determine when the trigger will fire.

                      • (dict) --

                        Defines a condition under which a trigger fires.

                        • LogicalOperator (string) --

                          A logical operator.

                        • JobName (string) --

                          The name of the job whose JobRuns this condition applies to, and on which this trigger waits.

                        • State (string) --

                          The condition state. Currently, the values supported are SUCCEEDED , STOPPED , TIMEOUT , and FAILED .

                        • CrawlerName (string) --

                          The name of the crawler to which this condition applies.

                        • CrawlState (string) --

                          The state of the crawler to which this condition applies.

              • JobDetails (dict) --

                Details of the Job when the node represents a Job.

                • JobRuns (list) --

                  The information for the job runs represented by the job node.

                  • (dict) --

                    Contains information about a job run.

                    • Id (string) --

                      The ID of this job run.

                    • Attempt (integer) --

                      The number of the attempt to run this job.

                    • PreviousRunId (string) --

                      The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

                    • TriggerName (string) --

                      The name of the trigger that started this job run.

                    • JobName (string) --

                      The name of the job definition being used in this run.

                    • StartedOn (datetime) --

                      The date and time at which this job run was started.

                    • LastModifiedOn (datetime) --

                      The last time that this job run was modified.

                    • CompletedOn (datetime) --

                      The date and time that this job run completed.

                    • JobRunState (string) --

                      The current state of the job run.

                    • Arguments (dict) --

                      The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.

                      You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

                      For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

                      For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

                      • (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 was used in the predicate of a conditional trigger that triggered this job run.

                        • JobName (string) --

                          The name of the job definition used by the predecessor job run.

                        • RunId (string) --

                          The job-run ID of the predecessor job run.

                    • AllocatedCapacity (integer) --

                      This field is deprecated. Use MaxCapacity instead.

                      The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

                    • ExecutionTime (integer) --

                      The amount of time (in seconds) that the job run consumed resources.

                    • Timeout (integer) --

                      The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

                    • MaxCapacity (float) --

                      The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

                      Do not set Max Capacity if using WorkerType and NumberOfWorkers .

                      The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

                      • When you specify a Python shell job (JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
                      • When you specify an Apache Spark ETL job (JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
                    • WorkerType (string) --

                      The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

                      • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
                      • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
                      • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
                    • NumberOfWorkers (integer) --

                      The number of workers of a defined workerType that are allocated when a job runs.

                      The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

                    • SecurityConfiguration (string) --

                      The name of the SecurityConfiguration structure to be used with this job run.

                    • LogGroupName (string) --

                      The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using AWS KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.

                    • NotificationProperty (dict) --

                      Specifies configuration properties of a job run notification.

                      • NotifyDelayAfter (integer) --

                        After a job run starts, the number of minutes to wait before sending a job run delay notification.

              • CrawlerDetails (dict) --

                Details of the crawler when the node represents a crawler.

                • Crawls (list) --

                  A list of crawls represented by the crawl node.

                  • (dict) --

                    The details of a crawl in the workflow.

                    • State (string) --

                      The state of the crawler.

                    • StartedOn (datetime) --

                      The date and time on which the crawl started.

                    • CompletedOn (datetime) --

                      The date and time on which the crawl completed.

                    • ErrorMessage (string) --

                      The error message associated with the crawl.

                    • LogGroup (string) --

                      The log group associated with the crawl.

                    • LogStream (string) --

                      The log stream associated with the crawl.

          • Edges (list) --

            A list of all the directed connections between the nodes belonging to the workflow.

            • (dict) --

              An edge represents a directed connection between two AWS Glue components which are part of the workflow the edge belongs to.

              • SourceId (string) --

                The unique of the node within the workflow where the edge starts.

              • DestinationId (string) --

                The unique of the node within the workflow where the edge ends.

    • MissingWorkflows (list) --

      A list of names of workflows not found.

      • (string) --

batch_stop_job_run(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.batch_stop_job_run(
    JobName='string',
    JobRunIds=[
        'string',
    ]
)
Parameters
  • JobName (string) --

    [REQUIRED]

    The name of the job definition for which to stop job runs.

  • JobRunIds (list) --

    [REQUIRED]

    A list of the JobRunIds that should be stopped for that job definition.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'SuccessfulSubmissions': [
        {
            'JobName': 'string',
            'JobRunId': 'string'
        },
    ],
    'Errors': [
        {
            'JobName': 'string',
            'JobRunId': 'string',
            'ErrorDetail': {
                'ErrorCode': 'string',
                'ErrorMessage': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • SuccessfulSubmissions (list) --

      A list of the JobRuns that were successfully submitted for stopping.

      • (dict) --

        Records a successful request to stop a specified JobRun .

        • JobName (string) --

          The name of the job definition used in the job run that was stopped.

        • JobRunId (string) --

          The JobRunId of the job run that was stopped.

    • Errors (list) --

      A list of the errors that were encountered in trying to stop JobRuns , including the JobRunId for which each error was encountered and details about the error.

      • (dict) --

        Records an error that occurred when attempting to stop a specified job run.

        • JobName (string) --

          The name of the job definition that is used in the job run in question.

        • JobRunId (string) --

          The JobRunId of the job run in question.

        • ErrorDetail (dict) --

          Specifies details about the error that was encountered.

          • ErrorCode (string) --

            The code associated with this error.

          • ErrorMessage (string) --

            A message describing the error.

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_classifier(**kwargs)

Creates a classifier in the user's account. This can be a GrokClassifier , an XMLClassifier , a JsonClassifier , or a CsvClassifier , depending on which field of the request is present.

See also: AWS API Documentation

Request Syntax

response = client.create_classifier(
    GrokClassifier={
        'Classification': 'string',
        'Name': 'string',
        'GrokPattern': 'string',
        'CustomPatterns': 'string'
    },
    XMLClassifier={
        'Classification': 'string',
        'Name': 'string',
        'RowTag': 'string'
    },
    JsonClassifier={
        'Name': 'string',
        'JsonPath': 'string'
    },
    CsvClassifier={
        'Name': 'string',
        'Delimiter': 'string',
        'QuoteSymbol': 'string',
        'ContainsHeader': 'UNKNOWN'|'PRESENT'|'ABSENT',
        'Header': [
            'string',
        ],
        'DisableValueTrimming': True|False,
        'AllowSingleColumn': True|False
    }
)
Parameters
  • GrokClassifier (dict) --

    A GrokClassifier object specifying the classifier to create.

    • Classification (string) -- [REQUIRED]

      An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.

    • Name (string) -- [REQUIRED]

      The name of the new classifier.

    • GrokPattern (string) -- [REQUIRED]

      The grok pattern used by this classifier.

    • CustomPatterns (string) --

      Optional custom grok patterns used by this classifier.

  • XMLClassifier (dict) --

    An XMLClassifier object specifying the classifier to create.

    • Classification (string) -- [REQUIRED]

      An identifier of the data format that the classifier matches.

    • Name (string) -- [REQUIRED]

      The name of the classifier.

    • RowTag (string) --

      The XML tag designating the element that contains each record in an XML document being parsed. This can't identify a self-closing element (closed by /> ). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).

  • JsonClassifier (dict) --

    A JsonClassifier object specifying the classifier to create.

    • Name (string) -- [REQUIRED]

      The name of the classifier.

    • JsonPath (string) -- [REQUIRED]

      A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath , as described in Writing JsonPath Custom Classifiers .

  • CsvClassifier (dict) --

    A CsvClassifier object specifying the classifier to create.

    • Name (string) -- [REQUIRED]

      The name of the classifier.

    • Delimiter (string) --

      A custom symbol to denote what separates each column entry in the row.

    • QuoteSymbol (string) --

      A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter.

    • ContainsHeader (string) --

      Indicates whether the CSV file contains a header.

    • Header (list) --

      A list of strings representing column names.

      • (string) --
    • DisableValueTrimming (boolean) --

      Specifies not to trim values before identifying the type of column values. The default value is true.

    • AllowSingleColumn (boolean) --

      Enables the processing of files that contain only one column.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

create_connection(**kwargs)

Creates a connection definition in the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.create_connection(
    CatalogId='string',
    ConnectionInput={
        'Name': 'string',
        'Description': 'string',
        'ConnectionType': 'JDBC'|'SFTP',
        'MatchCriteria': [
            'string',
        ],
        'ConnectionProperties': {
            'string': 'string'
        },
        'PhysicalConnectionRequirements': {
            'SubnetId': 'string',
            'SecurityGroupIdList': [
                'string',
            ],
            'AvailabilityZone': 'string'
        }
    }
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog in which to create the connection. If none is provided, the AWS account ID is used by default.
  • ConnectionInput (dict) --

    [REQUIRED]

    A ConnectionInput object defining the connection to create.

    • Name (string) -- [REQUIRED]

      The name of the connection.

    • Description (string) --

      The description of the connection.

    • ConnectionType (string) -- [REQUIRED]

      The type of the connection. Currently, only JDBC is supported; SFTP is not supported.

    • MatchCriteria (list) --

      A list of criteria that can be used in selecting this connection.

      • (string) --
    • ConnectionProperties (dict) -- [REQUIRED]

      These key-value pairs define parameters for the connection.

      • (string) --
        • (string) --
    • PhysicalConnectionRequirements (dict) --

      A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to successfully make this connection.

      • 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. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

create_crawler(**kwargs)

Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the s3Targets field, the jdbcTargets field, or the DynamoDBTargets field.

See also: AWS API Documentation

Request Syntax

response = client.create_crawler(
    Name='string',
    Role='string',
    DatabaseName='string',
    Description='string',
    Targets={
        'S3Targets': [
            {
                'Path': 'string',
                'Exclusions': [
                    'string',
                ]
            },
        ],
        'JdbcTargets': [
            {
                'ConnectionName': 'string',
                'Path': 'string',
                'Exclusions': [
                    'string',
                ]
            },
        ],
        'DynamoDBTargets': [
            {
                'Path': 'string'
            },
        ],
        'CatalogTargets': [
            {
                'DatabaseName': 'string',
                'Tables': [
                    'string',
                ]
            },
        ]
    },
    Schedule='string',
    Classifiers=[
        'string',
    ],
    TablePrefix='string',
    SchemaChangePolicy={
        'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
        'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
    },
    Configuration='string',
    CrawlerSecurityConfiguration='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

    Name of the new crawler.

  • Role (string) --

    [REQUIRED]

    The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.

  • DatabaseName (string) -- The AWS Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/* .
  • Description (string) -- A description of the new crawler.
  • Targets (dict) --

    [REQUIRED]

    A list of collection of targets to crawl.

    • S3Targets (list) --

      Specifies Amazon Simple Storage Service (Amazon S3) targets.

      • (dict) --

        Specifies a data store in Amazon Simple Storage Service (Amazon S3).

        • Path (string) --

          The path to the Amazon S3 target.

        • Exclusions (list) --

          A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .

          • (string) --
    • JdbcTargets (list) --

      Specifies JDBC targets.

      • (dict) --

        Specifies a JDBC data store to crawl.

        • ConnectionName (string) --

          The name of the connection to use to connect to the JDBC target.

        • Path (string) --

          The path of the JDBC target.

        • Exclusions (list) --

          A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .

          • (string) --
    • DynamoDBTargets (list) --

      Specifies Amazon DynamoDB targets.

      • (dict) --

        Specifies an Amazon DynamoDB table to crawl.

        • Path (string) --

          The name of the DynamoDB table to crawl.

    • CatalogTargets (list) --

      Specifies AWS Glue Data Catalog targets.

      • (dict) --

        Specifies an AWS Glue Data Catalog target.

        • DatabaseName (string) -- [REQUIRED]

          The name of the database to be synchronized.

        • Tables (list) -- [REQUIRED]

          A list of the tables to be synchronized.

          • (string) --
  • Schedule (string) -- A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *) .
  • Classifiers (list) --

    A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.

    • (string) --
  • TablePrefix (string) -- The table prefix used for catalog tables that are created.
  • SchemaChangePolicy (dict) --

    The policy for the crawler's update and deletion behavior.

    • UpdateBehavior (string) --

      The update behavior when the crawler finds a changed schema.

    • DeleteBehavior (string) --

      The deletion behavior when the crawler finds a deleted object.

  • Configuration (string) -- The crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler .
  • CrawlerSecurityConfiguration (string) -- The name of the SecurityConfiguration structure to be used by this crawler.
  • Tags (dict) --

    The tags to use with this crawler request. You can use tags to limit access to the crawler. For more information, see AWS Tags in AWS Glue .

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

create_database(**kwargs)

Creates a new database in a Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.create_database(
    CatalogId='string',
    DatabaseInput={
        'Name': 'string',
        'Description': 'string',
        'LocationUri': 'string',
        'Parameters': {
            'string': 'string'
        }
    }
)
Parameters
  • CatalogId (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.
  • DatabaseInput (dict) --

    [REQUIRED]

    A DatabaseInput object defining the metadata database to create in the catalog.

    • Name (string) -- [REQUIRED]

      Name of the database. For Hive compatibility, this is folded to lowercase when it is stored.

    • Description (string) --

      Description of the database

    • LocationUri (string) --

      The location of the database (for example, an HDFS path).

    • Parameters (dict) --

      Thes key-value pairs define parameters and properties of the database.

      • (string) --
        • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

create_dev_endpoint(**kwargs)

Creates a new DevEndpoint.

See also: AWS API Documentation

Request Syntax

response = client.create_dev_endpoint(
    EndpointName='string',
    RoleArn='string',
    SecurityGroupIds=[
        'string',
    ],
    SubnetId='string',
    PublicKey='string',
    PublicKeys=[
        'string',
    ],
    NumberOfNodes=123,
    ExtraPythonLibsS3Path='string',
    ExtraJarsS3Path='string',
    SecurityConfiguration='string',
    Tags={
        'string': 'string'
    },
    Arguments={
        'string': 'string'
    }
)
Parameters
  • EndpointName (string) --

    [REQUIRED]

    The name to be assigned to the new DevEndpoint.

  • RoleArn (string) --

    [REQUIRED]

    The IAM role for the DevEndpoint.

  • SecurityGroupIds (list) --

    Security group IDs for the security groups to be used by the new DevEndpoint.

    • (string) --
  • SubnetId (string) -- The subnet ID for the new DevEndpoint to use.
  • PublicKey (string) -- The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility, as the recommended attribute to use is public keys.
  • PublicKeys (list) --

    A list of public keys to be used by the DevEndpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.

    Note

    If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys: call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.

    • (string) --
  • NumberOfNodes (integer) -- The number of AWS Glue Data Processing Units (DPUs) to allocate to this DevEndpoint.
  • ExtraPythonLibsS3Path (string) --

    Path(s) to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

    Please note that only pure Python libraries can currently be used on a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.

  • ExtraJarsS3Path (string) -- Path to one or more Java Jars in an S3 bucket that should be loaded in your DevEndpoint.
  • SecurityConfiguration (string) -- The name of the SecurityConfiguration structure to be used with this DevEndpoint.
  • Tags (dict) --

    The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

    • (string) --
      • (string) --
  • Arguments (dict) --

    A map of arguments used to configure the DevEndpoint.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'EndpointName': 'string',
    'Status': 'string',
    'SecurityGroupIds': [
        'string',
    ],
    'SubnetId': 'string',
    'RoleArn': 'string',
    'YarnEndpointAddress': 'string',
    'ZeppelinRemoteSparkInterpreterPort': 123,
    'NumberOfNodes': 123,
    'AvailabilityZone': 'string',
    'VpcId': 'string',
    'ExtraPythonLibsS3Path': 'string',
    'ExtraJarsS3Path': 'string',
    'FailureReason': 'string',
    'SecurityConfiguration': 'string',
    'CreatedTimestamp': datetime(2015, 1, 1),
    'Arguments': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • EndpointName (string) --

      The name assigned to the new DevEndpoint.

    • Status (string) --

      The current status of the new DevEndpoint.

    • SecurityGroupIds (list) --

      The security groups assigned to the new DevEndpoint.

      • (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.

    • ZeppelinRemoteSparkInterpreterPort (integer) --

      The Apache Zeppelin port for the remote Apache Spark interpreter.

    • NumberOfNodes (integer) --

      The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

    • AvailabilityZone (string) --

      The AWS availability zone where this DevEndpoint is located.

    • VpcId (string) --

      The ID of the VPC used by this DevEndpoint.

    • ExtraPythonLibsS3Path (string) --

      Path(s) 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.

    • SecurityConfiguration (string) --

      The name of the SecurityConfiguration structure being used with this DevEndpoint.

    • CreatedTimestamp (datetime) --

      The point in time at which this DevEndpoint was created.

    • Arguments (dict) --

      The map of arguments used to configure this DevEndpoint.

      • (string) --
        • (string) --

create_job(**kwargs)

Creates a new job definition.

See also: AWS API Documentation

Request Syntax

response = client.create_job(
    Name='string',
    Description='string',
    LogUri='string',
    Role='string',
    ExecutionProperty={
        'MaxConcurrentRuns': 123
    },
    Command={
        'Name': 'string',
        'ScriptLocation': 'string',
        'PythonVersion': 'string'
    },
    DefaultArguments={
        'string': 'string'
    },
    Connections={
        'Connections': [
            'string',
        ]
    },
    MaxRetries=123,
    AllocatedCapacity=123,
    Timeout=123,
    MaxCapacity=123.0,
    SecurityConfiguration='string',
    Tags={
        'string': 'string'
    },
    NotificationProperty={
        'NotifyDelayAfter': 123
    },
    NumberOfWorkers=123,
    WorkerType='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name you assign to this job definition. It must be unique in your account.

  • Description (string) -- Description of the job being defined.
  • LogUri (string) -- This field is reserved for future use.
  • Role (string) --

    [REQUIRED]

    The name or Amazon Resource Name (ARN) of the IAM 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 the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

  • Command (dict) --

    [REQUIRED]

    The JobCommand that executes this job.

    • Name (string) --

      The name of the job command. For an Apache Spark ETL job, this must be glueetl . For a Python shell job, it must be pythonshell .

    • ScriptLocation (string) --

      Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that executes a job.

    • PythonVersion (string) --

      The Python version being used to execute a Python shell job. Allowed values are 2 or 3.

  • DefaultArguments (dict) --

    The default arguments for this job.

    You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

    For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

    For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

    • (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) --

    This parameter is deprecated. Use MaxCapacity instead.

    The number of AWS Glue data processing units (DPUs) to allocate to this Job. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

  • Timeout (integer) -- The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
  • MaxCapacity (float) --

    The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

    Do not set Max Capacity if using WorkerType and NumberOfWorkers .

    The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

    • When you specify a Python shell job (JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
    • When you specify an Apache Spark ETL job (JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
  • SecurityConfiguration (string) -- The name of the SecurityConfiguration structure to be used with this job.
  • Tags (dict) --

    The tags to use with this job. You may use tags to limit access to the job. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

    • (string) --
      • (string) --
  • NotificationProperty (dict) --

    Specifies configuration properties of a job notification.

    • NotifyDelayAfter (integer) --

      After a job run starts, the number of minutes to wait before sending a job run delay notification.

  • NumberOfWorkers (integer) --

    The number of workers of a defined workerType that are allocated when a job runs.

    The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

  • WorkerType (string) --

    The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

    • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
    • For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
    • For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Return type

dict

Returns

Response Syntax

{
    'Name': 'string'
}

Response Structure

  • (dict) --

    • Name (string) --

      The unique name that was provided for this job definition.

create_partition(**kwargs)

Creates a new partition.

See also: AWS API Documentation

Request Syntax

response = client.create_partition(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    PartitionInput={
        'Values': [
            'string',
        ],
        'LastAccessTime': datetime(2015, 1, 1),
        'StorageDescriptor': {
            'Columns': [
                {
                    'Name': 'string',
                    'Type': 'string',
                    'Comment': 'string'
                },
            ],
            '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)
    }
)
Parameters
  • CatalogId (string) -- The ID of the catalog in which the partion is to be created. Currently, this should be the AWS account ID.
  • DatabaseName (string) --

    [REQUIRED]

    The name of the metadata database in which the partition is to be created.

  • TableName (string) --

    [REQUIRED]

    The name of the metadata table in which the partition is to be created.

  • PartitionInput (dict) --

    [REQUIRED]

    A PartitionInput structure defining the partition to be created.

    • Values (list) --

      The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.

      • (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) --

          These key-value pairs define initialization parameters for the SerDe.

          • (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) --

      These key-value pairs define partition parameters.

      • (string) --
        • (string) --
    • LastAnalyzedTime (datetime) --

      The last time at which column statistics were computed for this partition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

create_script(**kwargs)

Transforms a directed acyclic graph (DAG) into code.

See also: AWS API Documentation

Request Syntax

response = client.create_script(
    DagNodes=[
        {
            'Id': 'string',
            'NodeType': 'string',
            'Args': [
                {
                    'Name': 'string',
                    'Value': 'string',
                    'Param': True|False
                },
            ],
            'LineNumber': 123
        },
    ],
    DagEdges=[
        {
            'Source': 'string',
            'Target': 'string',
            'TargetParameter': 'string'
        },
    ],
    Language='PYTHON'|'SCALA'
)
Parameters
  • DagNodes (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 that 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.

  • DagEdges (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.

  • Language (string) -- The programming language of the resulting code from the DAG.
Return type

dict

Returns

Response Syntax

{
    'PythonScript': 'string',
    'ScalaCode': 'string'
}

Response Structure

  • (dict) --

    • PythonScript (string) --

      The Python script generated from the DAG.

    • ScalaCode (string) --

      The Scala code generated from the DAG.

create_security_configuration(**kwargs)

Creates a new security configuration.

See also: AWS API Documentation

Request Syntax

response = client.create_security_configuration(
    Name='string',
    EncryptionConfiguration={
        'S3Encryption': [
            {
                'S3EncryptionMode': 'DISABLED'|'SSE-KMS'|'SSE-S3',
                'KmsKeyArn': 'string'
            },
        ],
        'CloudWatchEncryption': {
            'CloudWatchEncryptionMode': 'DISABLED'|'SSE-KMS',
            'KmsKeyArn': 'string'
        },
        'JobBookmarksEncryption': {
            'JobBookmarksEncryptionMode': 'DISABLED'|'CSE-KMS',
            'KmsKeyArn': 'string'
        }
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name for the new security configuration.

  • EncryptionConfiguration (dict) --

    [REQUIRED]

    The encryption configuration for the new security configuration.

    • S3Encryption (list) --

      The encryption configuration for S3 data.

      • (dict) --

        Specifies how S3 data should be encrypted.

        • S3EncryptionMode (string) --

          The encryption mode to use for S3 data.

        • KmsKeyArn (string) --

          The AWS ARN of the KMS key to be used to encrypt the data.

    • CloudWatchEncryption (dict) --

      The encryption configuration for CloudWatch.

      • CloudWatchEncryptionMode (string) --

        The encryption mode to use for CloudWatch data.

      • KmsKeyArn (string) --

        The AWS ARN of the KMS key to be used to encrypt the data.

    • JobBookmarksEncryption (dict) --

      The encryption configuration for Job Bookmarks.

      • JobBookmarksEncryptionMode (string) --

        The encryption mode to use for Job bookmarks data.

      • KmsKeyArn (string) --

        The AWS ARN of the KMS key to be used to encrypt the data.

Return type

dict

Returns

Response Syntax

{
    'Name': 'string',
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • Name (string) --

      The name assigned to the new security configuration.

    • CreatedTimestamp (datetime) --

      The time at which the new security configuration was created.

create_table(**kwargs)

Creates a new table definition in the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.create_table(
    CatalogId='string',
    DatabaseName='string',
    TableInput={
        'Name': 'string',
        'Description': 'string',
        'Owner': 'string',
        'LastAccessTime': datetime(2015, 1, 1),
        'LastAnalyzedTime': datetime(2015, 1, 1),
        'Retention': 123,
        'StorageDescriptor': {
            'Columns': [
                {
                    'Name': 'string',
                    'Type': 'string',
                    'Comment': 'string'
                },
            ],
            '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'
        }
    }
)
Parameters
  • CatalogId (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.
  • DatabaseName (string) --

    [REQUIRED]

    The catalog database in which to create the new table. For Hive compatibility, this name is entirely lowercase.

  • TableInput (dict) --

    [REQUIRED]

    The TableInput object that defines the metadata table to create in the catalog.

    • Name (string) -- [REQUIRED]

      Name of the table. For Hive compatibility, this is folded to lowercase when it is stored.

    • 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) --

          These key-value pairs define initialization parameters for the SerDe.

          • (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.

      When creating a table used by Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:

      "PartitionKeys": []
      • (dict) --

        A column in a Table .

        • Name (string) -- [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) --

      These key-value pairs define properties associated with the table.

      • (string) --
        • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

create_trigger(**kwargs)

Creates a new trigger.

See also: AWS API Documentation

Request Syntax

response = client.create_trigger(
    Name='string',
    WorkflowName='string',
    Type='SCHEDULED'|'CONDITIONAL'|'ON_DEMAND',
    Schedule='string',
    Predicate={
        'Logical': 'AND'|'ANY',
        'Conditions': [
            {
                'LogicalOperator': 'EQUALS',
                'JobName': 'string',
                'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                'CrawlerName': 'string',
                'CrawlState': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED'
            },
        ]
    },
    Actions=[
        {
            'JobName': 'string',
            'Arguments': {
                'string': 'string'
            },
            'Timeout': 123,
            'SecurityConfiguration': 'string',
            'NotificationProperty': {
                'NotifyDelayAfter': 123
            },
            'CrawlerName': 'string'
        },
    ],
    Description='string',
    StartOnCreation=True|False,
    Tags={
        'string': 'string'
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the trigger.

  • WorkflowName (string) -- The name of the workflow associated with the trigger.
  • Type (string) --

    [REQUIRED]

    The type of the new trigger.

  • Schedule (string) --

    A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .

    This field is required when the trigger type is SCHEDULED.

  • Predicate (dict) --

    A predicate to specify when the new trigger should fire.

    This field is required when the trigger type is CONDITIONAL .

    • Logical (string) --

      An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

    • Conditions (list) --

      A list of the conditions that determine when the trigger will fire.

      • (dict) --

        Defines a condition under which a trigger fires.

        • LogicalOperator (string) --

          A logical operator.

        • JobName (string) --

          The name of the job whose JobRuns this condition applies to, and on which this trigger waits.

        • State (string) --

          The condition state. Currently, the values supported are SUCCEEDED , STOPPED , TIMEOUT , and FAILED .

        • CrawlerName (string) --

          The name of the crawler to which this condition applies.

        • CrawlState (string) --

          The state of the crawler to which this condition applies.

  • Actions (list) --

    [REQUIRED]

    The actions initiated by this trigger when it fires.

    • (dict) --

      Defines an action to be initiated by a trigger.

      • JobName (string) --

        The name of a job to be executed.

      • Arguments (dict) --

        The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

        You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

        For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

        For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

        • (string) --
          • (string) --
      • Timeout (integer) --

        The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

      • SecurityConfiguration (string) --

        The name of the SecurityConfiguration structure to be used with this action.

      • NotificationProperty (dict) --

        Specifies configuration properties of a job run notification.

        • NotifyDelayAfter (integer) --

          After a job run starts, the number of minutes to wait before sending a job run delay notification.

      • CrawlerName (string) --

        The name of the crawler to be used with this action.

  • Description (string) -- A description of the new trigger.
  • StartOnCreation (boolean) -- Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers.
  • Tags (dict) --

    The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'Name': 'string'
}

Response Structure

  • (dict) --

    • Name (string) --

      The name of the trigger.

create_user_defined_function(**kwargs)

Creates a new function definition in the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.create_user_defined_function(
    CatalogId='string',
    DatabaseName='string',
    FunctionInput={
        'FunctionName': 'string',
        'ClassName': 'string',
        'OwnerName': 'string',
        'OwnerType': 'USER'|'ROLE'|'GROUP',
        'ResourceUris': [
            {
                'ResourceType': 'JAR'|'FILE'|'ARCHIVE',
                'Uri': 'string'
            },
        ]
    }
)
Parameters
  • CatalogId (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.
  • DatabaseName (string) --

    [REQUIRED]

    The name of the catalog database in which to create the function.

  • FunctionInput (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.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

create_workflow(**kwargs)

Creates a new workflow.

See also: AWS API Documentation

Request Syntax

response = client.create_workflow(
    Name='string',
    Description='string',
    DefaultRunProperties={
        'string': 'string'
    },
    Tags={
        'string': 'string'
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name to be assigned to the workflow. It should be unique within your account.

  • Description (string) -- A description of the workflow.
  • DefaultRunProperties (dict) --

    A collection of properties to be used as part of each execution of the workflow.

    • (string) --
      • (string) --
  • Tags (dict) --

    The tags to be used with this workflow.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'Name': 'string'
}

Response Structure

  • (dict) --

    • Name (string) --

      The name of the workflow which was provided as part of the request.

delete_classifier(**kwargs)

Removes a classifier from the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.delete_classifier(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

Name of the classifier to remove.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_connection(**kwargs)

Deletes a connection from the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.delete_connection(
    CatalogId='string',
    ConnectionName='string'
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default.
  • ConnectionName (string) --

    [REQUIRED]

    The name of the connection to delete.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_crawler(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_crawler(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the crawler to remove.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_database(**kwargs)

Removes a specified Database from a Data Catalog.

Note

After completing this operation, you will no longer have access to the tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted database. AWS Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.

To ensure immediate deletion of all related resources, before calling DeleteDatabase , use DeleteTableVersion or BatchDeleteTableVersion , DeletePartition or BatchDeletePartition , DeleteUserDefinedFunction , and DeleteTable or BatchDeleteTable , to delete any resources that belong to the database.

See also: AWS API Documentation

Request Syntax

response = client.delete_database(
    CatalogId='string',
    Name='string'
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog in which the database resides. If none is supplied, the AWS account ID is used by default.
  • Name (string) --

    [REQUIRED]

    The name of the Database to delete. For Hive compatibility, this must be all lowercase.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_dev_endpoint(**kwargs)

Deletes a specified DevEndpoint.

See also: AWS API Documentation

Request Syntax

response = client.delete_dev_endpoint(
    EndpointName='string'
)
Parameters
EndpointName (string) --

[REQUIRED]

The name of the DevEndpoint.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_job(**kwargs)

Deletes a specified job definition. If the job definition is not found, no exception is thrown.

See also: AWS API Documentation

Request Syntax

response = client.delete_job(
    JobName='string'
)
Parameters
JobName (string) --

[REQUIRED]

The name of the job definition to delete.

Return type
dict
Returns
Response Syntax
{
    'JobName': 'string'
}

Response Structure

  • (dict) --
    • JobName (string) --

      The name of the job definition that was deleted.

delete_partition(**kwargs)

Deletes a specified partition.

See also: AWS API Documentation

Request Syntax

response = client.delete_partition(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    PartitionValues=[
        'string',
    ]
)
Parameters
  • CatalogId (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.
  • DatabaseName (string) --

    [REQUIRED]

    The name of the catalog database in which the table in question resides.

  • TableName (string) --

    [REQUIRED]

    The name of the table where the partition to be deleted is located.

  • PartitionValues (list) --

    [REQUIRED]

    The values that define the partition.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_resource_policy(**kwargs)

Deletes a specified policy.

See also: AWS API Documentation

Request Syntax

response = client.delete_resource_policy(
    PolicyHashCondition='string'
)
Parameters
PolicyHashCondition (string) -- The hash value returned when this policy was set.
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_security_configuration(**kwargs)

Deletes a specified security configuration.

See also: AWS API Documentation

Request Syntax

response = client.delete_security_configuration(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the security configuration to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_table(**kwargs)

Removes a table definition from the Data Catalog.

Note

After completing this operation, you will no longer have access to the table versions and partitions that belong to the deleted table. AWS Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.

To ensure immediate deletion of all related resources, before calling DeleteTable , use DeleteTableVersion or BatchDeleteTableVersion , and DeletePartition or BatchDeletePartition , to delete any resources that belong to the table.

See also: AWS API Documentation

Request Syntax

response = client.delete_table(
    CatalogId='string',
    DatabaseName='string',
    Name='string'
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default.
  • DatabaseName (string) --

    [REQUIRED]

    The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.

  • Name (string) --

    [REQUIRED]

    The name of the table to be deleted. For Hive compatibility, this name is entirely lowercase.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_table_version(**kwargs)

Deletes a specified version of a table.

See also: AWS API Documentation

Request Syntax

response = client.delete_table_version(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    VersionId='string'
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.
  • DatabaseName (string) --

    [REQUIRED]

    The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

  • TableName (string) --

    [REQUIRED]

    The name of the table. For Hive compatibility, this name is entirely lowercase.

  • VersionId (string) --

    [REQUIRED]

    The ID of the table version to be deleted. A VersionID is a string representation of an integer. Each version is incremented by 1.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_trigger(**kwargs)

Deletes a specified trigger. If the trigger is not found, no exception is thrown.

See also: AWS API Documentation

Request Syntax

response = client.delete_trigger(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the trigger to delete.

Return type
dict
Returns
Response Syntax
{
    'Name': 'string'
}

Response Structure

  • (dict) --
    • Name (string) --

      The name of the trigger that was deleted.

delete_user_defined_function(**kwargs)

Deletes an existing function definition from the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.delete_user_defined_function(
    CatalogId='string',
    DatabaseName='string',
    FunctionName='string'
)
Parameters
  • CatalogId (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.
  • DatabaseName (string) --

    [REQUIRED]

    The name of the catalog database where the function is located.

  • FunctionName (string) --

    [REQUIRED]

    The name of the function definition to be deleted.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_workflow(**kwargs)

Deletes a workflow.

See also: AWS API Documentation

Request Syntax

response = client.delete_workflow(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

Name of the workflow to be deleted.

Return type
dict
Returns
Response Syntax
{
    'Name': 'string'
}

Response Structure

  • (dict) --
    • Name (string) --

      Name of the workflow specified in input.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_catalog_import_status(**kwargs)

Retrieves the status of a migration operation.

See also: AWS API Documentation

Request Syntax

response = client.get_catalog_import_status(
    CatalogId='string'
)
Parameters
CatalogId (string) -- The ID of the catalog to migrate. Currently, this should be the AWS account ID.
Return type
dict
Returns
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.

get_classifier(**kwargs)

Retrieve a classifier by name.

See also: AWS API Documentation

Request Syntax

response = client.get_classifier(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

Name of the classifier to retrieve.

Return type
dict
Returns
Response Syntax
{
    'Classifier': {
        'GrokClassifier': {
            'Name': 'string',
            'Classification': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastUpdated': datetime(2015, 1, 1),
            'Version': 123,
            'GrokPattern': 'string',
            'CustomPatterns': 'string'
        },
        'XMLClassifier': {
            'Name': 'string',
            'Classification': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastUpdated': datetime(2015, 1, 1),
            'Version': 123,
            'RowTag': 'string'
        },
        'JsonClassifier': {
            'Name': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastUpdated': datetime(2015, 1, 1),
            'Version': 123,
            'JsonPath': 'string'
        },
        'CsvClassifier': {
            'Name': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastUpdated': datetime(2015, 1, 1),
            'Version': 123,
            'Delimiter': 'string',
            'QuoteSymbol': 'string',
            'ContainsHeader': 'UNKNOWN'|'PRESENT'|'ABSENT',
            'Header': [
                'string',
            ],
            'DisableValueTrimming': True|False,
            'AllowSingleColumn': True|False
        }
    }
}

Response Structure

  • (dict) --
    • Classifier (dict) --

      The requested classifier.

      • GrokClassifier (dict) --

        A classifier that uses grok .

        • Name (string) --

          The name of the classifier.

        • Classification (string) --

          An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.

        • CreationTime (datetime) --

          The time that this classifier was registered.

        • LastUpdated (datetime) --

          The time that this classifier was last updated.

        • Version (integer) --

          The version of this classifier.

        • GrokPattern (string) --

          The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers .

        • CustomPatterns (string) --

          Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers .

      • XMLClassifier (dict) --

        A classifier for XML content.

        • Name (string) --

          The name of the classifier.

        • Classification (string) --

          An identifier of the data format that the classifier matches.

        • CreationTime (datetime) --

          The time that this classifier was registered.

        • LastUpdated (datetime) --

          The time that this classifier was last updated.

        • Version (integer) --

          The version of this classifier.

        • RowTag (string) --

          The XML tag designating the element that contains each record in an XML document being parsed. This can't identify a self-closing element (closed by /> ). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).

      • JsonClassifier (dict) --

        A classifier for JSON content.

        • Name (string) --

          The name of the classifier.

        • CreationTime (datetime) --

          The time that this classifier was registered.

        • LastUpdated (datetime) --

          The time that this classifier was last updated.

        • Version (integer) --

          The version of this classifier.

        • JsonPath (string) --

          A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath , as described in Writing JsonPath Custom Classifiers .

      • CsvClassifier (dict) --

        A classifier for comma-separated values (CSV).

        • Name (string) --

          The name of the classifier.

        • CreationTime (datetime) --

          The time that this classifier was registered.

        • LastUpdated (datetime) --

          The time that this classifier was last updated.

        • Version (integer) --

          The version of this classifier.

        • Delimiter (string) --

          A custom symbol to denote what separates each column entry in the row.

        • QuoteSymbol (string) --

          A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.

        • ContainsHeader (string) --

          Indicates whether the CSV file contains a header.

        • Header (list) --

          A list of strings representing column names.

          • (string) --
        • DisableValueTrimming (boolean) --

          Specifies not to trim values before identifying the type of column values. The default value is true .

        • AllowSingleColumn (boolean) --

          Enables the processing of files that contain only one column.

get_classifiers(**kwargs)

Lists all classifier objects in the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.get_classifiers(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The size of the list to return (optional).
  • NextToken (string) -- An optional continuation token.
Return type

dict

Returns

Response Syntax

{
    'Classifiers': [
        {
            'GrokClassifier': {
                'Name': 'string',
                'Classification': 'string',
                'CreationTime': datetime(2015, 1, 1),
                'LastUpdated': datetime(2015, 1, 1),
                'Version': 123,
                'GrokPattern': 'string',
                'CustomPatterns': 'string'
            },
            'XMLClassifier': {
                'Name': 'string',
                'Classification': 'string',
                'CreationTime': datetime(2015, 1, 1),
                'LastUpdated': datetime(2015, 1, 1),
                'Version': 123,
                'RowTag': 'string'
            },
            'JsonClassifier': {
                'Name': 'string',
                'CreationTime': datetime(2015, 1, 1),
                'LastUpdated': datetime(2015, 1, 1),
                'Version': 123,
                'JsonPath': 'string'
            },
            'CsvClassifier': {
                'Name': 'string',
                'CreationTime': datetime(2015, 1, 1),
                'LastUpdated': datetime(2015, 1, 1),
                'Version': 123,
                'Delimiter': 'string',
                'QuoteSymbol': 'string',
                'ContainsHeader': 'UNKNOWN'|'PRESENT'|'ABSENT',
                'Header': [
                    'string',
                ],
                'DisableValueTrimming': True|False,
                'AllowSingleColumn': True|False
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Classifiers (list) --

      The requested list of classifier objects.

      • (dict) --

        Classifiers are triggered during a crawl task. A classifier checks whether a given file is in a format it can handle. If it is, the classifier creates a schema in the form of a StructType object that matches that data format.

        You can use the standard classifiers that AWS Glue provides, or you can write your own classifiers to best categorize your data sources and specify the appropriate schemas to use for them. A classifier can be a grok classifier, an XML classifier, a JSON classifier, or a custom CSV classifier, as specified in one of the fields in the Classifier object.

        • GrokClassifier (dict) --

          A classifier that uses grok .

          • Name (string) --

            The name of the classifier.

          • Classification (string) --

            An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.

          • CreationTime (datetime) --

            The time that this classifier was registered.

          • LastUpdated (datetime) --

            The time that this classifier was last updated.

          • Version (integer) --

            The version of this classifier.

          • GrokPattern (string) --

            The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers .

          • CustomPatterns (string) --

            Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers .

        • XMLClassifier (dict) --

          A classifier for XML content.

          • Name (string) --

            The name of the classifier.

          • Classification (string) --

            An identifier of the data format that the classifier matches.

          • CreationTime (datetime) --

            The time that this classifier was registered.

          • LastUpdated (datetime) --

            The time that this classifier was last updated.

          • Version (integer) --

            The version of this classifier.

          • RowTag (string) --

            The XML tag designating the element that contains each record in an XML document being parsed. This can't identify a self-closing element (closed by /> ). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).

        • JsonClassifier (dict) --

          A classifier for JSON content.

          • Name (string) --

            The name of the classifier.

          • CreationTime (datetime) --

            The time that this classifier was registered.

          • LastUpdated (datetime) --

            The time that this classifier was last updated.

          • Version (integer) --

            The version of this classifier.

          • JsonPath (string) --

            A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath , as described in Writing JsonPath Custom Classifiers .

        • CsvClassifier (dict) --

          A classifier for comma-separated values (CSV).

          • Name (string) --

            The name of the classifier.

          • CreationTime (datetime) --

            The time that this classifier was registered.

          • LastUpdated (datetime) --

            The time that this classifier was last updated.

          • Version (integer) --

            The version of this classifier.

          • Delimiter (string) --

            A custom symbol to denote what separates each column entry in the row.

          • QuoteSymbol (string) --

            A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.

          • ContainsHeader (string) --

            Indicates whether the CSV file contains a header.

          • Header (list) --

            A list of strings representing column names.

            • (string) --
          • DisableValueTrimming (boolean) --

            Specifies not to trim values before identifying the type of column values. The default value is true .

          • AllowSingleColumn (boolean) --

            Enables the processing of files that contain only one column.

    • NextToken (string) --

      A continuation token.

get_connection(**kwargs)

Retrieves a connection definition from the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.get_connection(
    CatalogId='string',
    Name='string',
    HidePassword=True|False
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default.
  • Name (string) --

    [REQUIRED]

    The name of the connection definition to retrieve.

  • HidePassword (boolean) -- Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but does have permission to access the rest of the connection properties.
Return type

dict

Returns

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) --

        The description of the connection.

      • ConnectionType (string) --

        The type of the connection. Currently, only JDBC is supported; SFTP is not supported.

      • MatchCriteria (list) --

        A list of criteria that can be used in selecting this connection.

        • (string) --
      • ConnectionProperties (dict) --

        These key-value pairs define parameters for the connection:

        • HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.
        • PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.
        • USER_NAME - The name under which to log in to the database. The value string for USER_NAME is "USERNAME ".
        • PASSWORD - A password, if one is used, for the user name.
        • ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.
        • JDBC_DRIVER_JAR_URI - The Amazon S3 path of the JAR file that contains the JDBC driver to use.
        • JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.
        • JDBC_ENGINE - The name of the JDBC engine to use.
        • JDBC_ENGINE_VERSION - The version of the JDBC engine to use.
        • CONFIG_FILES - (Reserved for future use).
        • INSTANCE_ID - The instance ID to use.
        • JDBC_CONNECTION_URL - The URL for the JDBC connection.
        • JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching will be enforced for the JDBC connection on the client. The default is false.
        • (string) --
          • (string) --
      • PhysicalConnectionRequirements (dict) --

        A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to make this connection successfully.

        • SubnetId (string) --

          The subnet ID used by the connection.

        • SecurityGroupIdList (list) --

          The security group ID list used by the connection.

          • (string) --
        • AvailabilityZone (string) --

          The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.

      • CreationTime (datetime) --

        The time that this connection definition was created.

      • LastUpdatedTime (datetime) --

        The last time that this connection definition was updated.

      • LastUpdatedBy (string) --

        The user, group, or role that last updated this connection definition.

get_connections(**kwargs)

Retrieves a list of connection definitions from the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.get_connections(
    CatalogId='string',
    Filter={
        'MatchCriteria': [
            'string',
        ],
        'ConnectionType': 'JDBC'|'SFTP'
    },
    HidePassword=True|False,
    NextToken='string',
    MaxResults=123
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog in which the connections reside. If none is provided, the AWS account ID is used by default.
  • Filter (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. Currently, only JDBC is supported; SFTP is not supported.

  • HidePassword (boolean) -- Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but does have permission to access the rest of the connection properties.
  • NextToken (string) -- A continuation token, if this is a continuation call.
  • MaxResults (integer) -- The maximum number of connections to return in one response.
Return type

dict

Returns

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) --

          The description of the connection.

        • ConnectionType (string) --

          The type of the connection. Currently, only JDBC is supported; SFTP is not supported.

        • MatchCriteria (list) --

          A list of criteria that can be used in selecting this connection.

          • (string) --
        • ConnectionProperties (dict) --

          These key-value pairs define parameters for the connection:

          • HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.
          • PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.
          • USER_NAME - The name under which to log in to the database. The value string for USER_NAME is "USERNAME ".
          • PASSWORD - A password, if one is used, for the user name.
          • ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.
          • JDBC_DRIVER_JAR_URI - The Amazon S3 path of the JAR file that contains the JDBC driver to use.
          • JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.
          • JDBC_ENGINE - The name of the JDBC engine to use.
          • JDBC_ENGINE_VERSION - The version of the JDBC engine to use.
          • CONFIG_FILES - (Reserved for future use).
          • INSTANCE_ID - The instance ID to use.
          • JDBC_CONNECTION_URL - The URL for the JDBC connection.
          • JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching will be enforced for the JDBC connection on the client. The default is false.
          • (string) --
            • (string) --
        • PhysicalConnectionRequirements (dict) --

          A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to make this connection successfully.

          • SubnetId (string) --

            The subnet ID used by the connection.

          • SecurityGroupIdList (list) --

            The security group ID list used by the connection.

            • (string) --
          • AvailabilityZone (string) --

            The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.

        • CreationTime (datetime) --

          The time that this connection definition was created.

        • LastUpdatedTime (datetime) --

          The last time that this connection definition was updated.

        • LastUpdatedBy (string) --

          The user, group, or role that last updated this connection definition.

    • NextToken (string) --

      A continuation token, if the list of connections returned does not include the last of the filtered connections.

get_crawler(**kwargs)

Retrieves metadata for a specified crawler.

See also: AWS API Documentation

Request Syntax

response = client.get_crawler(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the crawler to retrieve metadata for.

Return type
dict
Returns
Response Syntax
{
    'Crawler': {
        'Name': 'string',
        'Role': 'string',
        'Targets': {
            'S3Targets': [
                {
                    'Path': 'string',
                    'Exclusions': [
                        'string',
                    ]
                },
            ],
            'JdbcTargets': [
                {
                    'ConnectionName': 'string',
                    'Path': 'string',
                    'Exclusions': [
                        'string',
                    ]
                },
            ],
            'DynamoDBTargets': [
                {
                    'Path': 'string'
                },
            ],
            'CatalogTargets': [
                {
                    'DatabaseName': 'string',
                    'Tables': [
                        '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,
        'Configuration': 'string',
        'CrawlerSecurityConfiguration': 'string'
    }
}

Response Structure

  • (dict) --
    • Crawler (dict) --

      The metadata for the specified crawler.

      • Name (string) --

        The name of the crawler.

      • Role (string) --

        The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.

      • Targets (dict) --

        A collection of targets to crawl.

        • S3Targets (list) --

          Specifies Amazon Simple Storage Service (Amazon S3) targets.

          • (dict) --

            Specifies a data store in Amazon Simple Storage Service (Amazon S3).

            • Path (string) --

              The path to the Amazon S3 target.

            • Exclusions (list) --

              A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .

              • (string) --
        • JdbcTargets (list) --

          Specifies JDBC targets.

          • (dict) --

            Specifies a JDBC data store to crawl.

            • ConnectionName (string) --

              The name of the connection to use to connect to the JDBC target.

            • Path (string) --

              The path of the JDBC target.

            • Exclusions (list) --

              A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .

              • (string) --
        • DynamoDBTargets (list) --

          Specifies Amazon DynamoDB targets.

          • (dict) --

            Specifies an Amazon DynamoDB table to crawl.

            • Path (string) --

              The name of the DynamoDB table to crawl.

        • CatalogTargets (list) --

          Specifies AWS Glue Data Catalog targets.

          • (dict) --

            Specifies an AWS Glue Data Catalog target.

            • DatabaseName (string) --

              The name of the database to be synchronized.

            • Tables (list) --

              A list of the tables to be synchronized.

              • (string) --
      • DatabaseName (string) --

        The name of the database in which the crawler's output is stored.

      • Description (string) --

        A description of the crawler.

      • Classifiers (list) --

        A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.

        • (string) --
      • SchemaChangePolicy (dict) --

        The policy that specifies update and delete behaviors for the crawler.

        • UpdateBehavior (string) --

          The update behavior when the crawler finds a changed schema.

        • DeleteBehavior (string) --

          The deletion behavior when the crawler finds a deleted object.

      • State (string) --

        Indicates whether the crawler is running, or whether a run is pending.

      • TablePrefix (string) --

        The prefix added to the names of tables that are created.

      • Schedule (dict) --

        For scheduled crawlers, the schedule when the crawler runs.

        • ScheduleExpression (string) --

          A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *) .

        • State (string) --

          The state of the schedule.

      • CrawlElapsedTime (integer) --

        If the crawler is running, contains the total time elapsed since the last crawl began.

      • CreationTime (datetime) --

        The time that the crawler was created.

      • LastUpdated (datetime) --

        The time that the crawler was last updated.

      • LastCrawl (dict) --

        The status of the last crawl, and potentially error information if an error occurred.

        • Status (string) --

          Status of the last crawl.

        • ErrorMessage (string) --

          If an error occurred, the error information about the last crawl.

        • LogGroup (string) --

          The log group for the last crawl.

        • LogStream (string) --

          The log stream for the last crawl.

        • MessagePrefix (string) --

          The prefix for a message about this crawl.

        • StartTime (datetime) --

          The time at which the crawl started.

      • Version (integer) --

        The version of the crawler.

      • Configuration (string) --

        Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler .

      • CrawlerSecurityConfiguration (string) --

        The name of the SecurityConfiguration structure to be used by this crawler.

get_crawler_metrics(**kwargs)

Retrieves metrics about specified crawlers.

See also: AWS API Documentation

Request Syntax

response = client.get_crawler_metrics(
    CrawlerNameList=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters
  • CrawlerNameList (list) --

    A list of the names of crawlers about which to retrieve metrics.

    • (string) --
  • MaxResults (integer) -- The maximum size of a list to return.
  • NextToken (string) -- A continuation token, if this is a continuation call.
Return type

dict

Returns

Response Syntax

{
    'CrawlerMetricsList': [
        {
            'CrawlerName': 'string',
            'TimeLeftSeconds': 123.0,
            'StillEstimating': True|False,
            'LastRuntimeSeconds': 123.0,
            'MedianRuntimeSeconds': 123.0,
            'TablesCreated': 123,
            'TablesUpdated': 123,
            'TablesDeleted': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CrawlerMetricsList (list) --

      A list of metrics for the specified crawler.

      • (dict) --

        Metrics for a specified crawler.

        • CrawlerName (string) --

          The name of the crawler.

        • TimeLeftSeconds (float) --

          The estimated time left to complete a running crawl.

        • StillEstimating (boolean) --

          True if the crawler is still estimating how long it will take to complete this run.

        • LastRuntimeSeconds (float) --

          The duration of the crawler's most recent run, in seconds.

        • MedianRuntimeSeconds (float) --

          The median duration of this crawler's runs, in seconds.

        • TablesCreated (integer) --

          The number of tables created by this crawler.

        • TablesUpdated (integer) --

          The number of tables updated by this crawler.

        • TablesDeleted (integer) --

          The number of tables deleted by this crawler.

    • NextToken (string) --

      A continuation token, if the returned list does not contain the last metric available.

get_crawlers(**kwargs)

Retrieves metadata for all crawlers defined in the customer account.

See also: AWS API Documentation

Request Syntax

response = client.get_crawlers(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The number of crawlers to return on each call.
  • NextToken (string) -- A continuation token, if this is a continuation request.
Return type

dict

Returns

Response Syntax

{
    'Crawlers': [
        {
            'Name': 'string',
            'Role': 'string',
            'Targets': {
                'S3Targets': [
                    {
                        'Path': 'string',
                        'Exclusions': [
                            'string',
                        ]
                    },
                ],
                'JdbcTargets': [
                    {
                        'ConnectionName': 'string',
                        'Path': 'string',
                        'Exclusions': [
                            'string',
                        ]
                    },
                ],
                'DynamoDBTargets': [
                    {
                        'Path': 'string'
                    },
                ],
                'CatalogTargets': [
                    {
                        'DatabaseName': 'string',
                        'Tables': [
                            '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,
            'Configuration': 'string',
            'CrawlerSecurityConfiguration': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Crawlers (list) --

      A list of crawler metadata.

      • (dict) --

        Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source in the AWS Glue Data Catalog.

        • Name (string) --

          The name of the crawler.

        • Role (string) --

          The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.

        • Targets (dict) --

          A collection of targets to crawl.

          • S3Targets (list) --

            Specifies Amazon Simple Storage Service (Amazon S3) targets.

            • (dict) --

              Specifies a data store in Amazon Simple Storage Service (Amazon S3).

              • Path (string) --

                The path to the Amazon S3 target.

              • Exclusions (list) --

                A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .

                • (string) --
          • JdbcTargets (list) --

            Specifies JDBC targets.

            • (dict) --

              Specifies a JDBC data store to crawl.

              • ConnectionName (string) --

                The name of the connection to use to connect to the JDBC target.

              • Path (string) --

                The path of the JDBC target.

              • Exclusions (list) --

                A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .

                • (string) --
          • DynamoDBTargets (list) --

            Specifies Amazon DynamoDB targets.

            • (dict) --

              Specifies an Amazon DynamoDB table to crawl.

              • Path (string) --

                The name of the DynamoDB table to crawl.

          • CatalogTargets (list) --

            Specifies AWS Glue Data Catalog targets.

            • (dict) --

              Specifies an AWS Glue Data Catalog target.

              • DatabaseName (string) --

                The name of the database to be synchronized.

              • Tables (list) --

                A list of the tables to be synchronized.

                • (string) --
        • DatabaseName (string) --

          The name of the database in which the crawler's output is stored.

        • Description (string) --

          A description of the crawler.

        • Classifiers (list) --

          A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.

          • (string) --
        • SchemaChangePolicy (dict) --

          The policy that specifies update and delete behaviors for the crawler.

          • UpdateBehavior (string) --

            The update behavior when the crawler finds a changed schema.

          • DeleteBehavior (string) --

            The deletion behavior when the crawler finds a deleted object.

        • State (string) --

          Indicates whether the crawler is running, or whether a run is pending.

        • TablePrefix (string) --

          The prefix added to the names of tables that are created.

        • Schedule (dict) --

          For scheduled crawlers, the schedule when the crawler runs.

          • ScheduleExpression (string) --

            A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *) .

          • State (string) --

            The state of the schedule.

        • CrawlElapsedTime (integer) --

          If the crawler is running, contains the total time elapsed since the last crawl began.

        • CreationTime (datetime) --

          The time that the crawler was created.

        • LastUpdated (datetime) --

          The time that the crawler was last updated.

        • LastCrawl (dict) --

          The status of the last crawl, and potentially error information if an error occurred.

          • Status (string) --

            Status of the last crawl.

          • ErrorMessage (string) --

            If an error occurred, the error information about the last crawl.

          • LogGroup (string) --

            The log group for the last crawl.

          • LogStream (string) --

            The log stream for the last crawl.

          • MessagePrefix (string) --

            The prefix for a message about this crawl.

          • StartTime (datetime) --

            The time at which the crawl started.

        • Version (integer) --

          The version of the crawler.

        • Configuration (string) --

          Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler .

        • CrawlerSecurityConfiguration (string) --

          The name of the SecurityConfiguration structure to be used by this crawler.

    • NextToken (string) --

      A continuation token, if the returned list has not reached the end of those defined in this customer account.

get_data_catalog_encryption_settings(**kwargs)

Retrieves the security configuration for a specified catalog.

See also: AWS API Documentation

Request Syntax

response = client.get_data_catalog_encryption_settings(
    CatalogId='string'
)
Parameters
CatalogId (string) -- The ID of the Data Catalog for which to retrieve the security configuration. If none is provided, the AWS account ID is used by default.
Return type
dict
Returns
Response Syntax
{
    'DataCatalogEncryptionSettings': {
        'EncryptionAtRest': {
            'CatalogEncryptionMode': 'DISABLED'|'SSE-KMS',
            'SseAwsKmsKeyId': 'string'
        },
        'ConnectionPasswordEncryption': {
            'ReturnConnectionPasswordEncrypted': True|False,
            'AwsKmsKeyId': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • DataCatalogEncryptionSettings (dict) --

      The requested security configuration.

      • EncryptionAtRest (dict) --

        Specifies the encryption-at-rest configuration for the Data Catalog.

        • CatalogEncryptionMode (string) --

          The encryption-at-rest mode for encrypting Data Catalog data.

        • SseAwsKmsKeyId (string) --

          The ID of the AWS KMS key to use for encryption at rest.

      • ConnectionPasswordEncryption (dict) --

        When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption.

        • ReturnConnectionPasswordEncrypted (boolean) --

          When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords remain encrypted in the responses of GetConnection and GetConnections . This encryption takes effect independently from catalog encryption.

        • AwsKmsKeyId (string) --

          An AWS KMS key that is used to encrypt the connection password.

          If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog.

          You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.

get_database(**kwargs)

Retrieves the definition of a specified database.

See also: AWS API Documentation

Request Syntax

response = client.get_database(
    CatalogId='string',
    Name='string'
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog in which the database resides. If none is supplied, the AWS account ID is used by default.
  • Name (string) --

    [REQUIRED]

    The name of the database to retrieve. For Hive compatibility, this should be all lowercase.

Return type

dict

Returns

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. For Hive compatibility, this is folded to lowercase when it is stored.

      • Description (string) --

        Description of the database.

      • LocationUri (string) --

        The location of the database (for example, an HDFS path).

      • Parameters (dict) --

        These key-value pairs define parameters and properties of the database.

        • (string) --
          • (string) --
      • CreateTime (datetime) --

        The time at which the metadata database was created in the catalog.

get_databases(**kwargs)

Retrieves all Databases defined in a given Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.get_databases(
    CatalogId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog from which to retrieve Databases . If none is supplied, the AWS account ID is used by default.
  • NextToken (string) -- A continuation token, if this is a continuation call.
  • MaxResults (integer) -- The maximum number of databases to return in one response.
Return type

dict

Returns

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. For Hive compatibility, this is folded to lowercase when it is stored.

        • Description (string) --

          Description of the database.

        • LocationUri (string) --

          The location of the database (for example, an HDFS path).

        • Parameters (dict) --

          These key-value pairs define parameters and properties of the database.

          • (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.

get_dataflow_graph(**kwargs)

Transforms a Python script into a directed acyclic graph (DAG).

See also: AWS API Documentation

Request Syntax

response = client.get_dataflow_graph(
    PythonScript='string'
)
Parameters
PythonScript (string) -- The Python script to transform.
Return type
dict
Returns
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 that 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.

get_dev_endpoint(**kwargs)

Retrieves information about a specified DevEndpoint.

Note

When you create a development endpoint in a virtual private cloud (VPC), AWS Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, AWS Glue returns only a public IP address.

See also: AWS API Documentation

Request Syntax

response = client.get_dev_endpoint(
    EndpointName='string'
)
Parameters
EndpointName (string) --

[REQUIRED]

Name of the DevEndpoint for which to retrieve information.

Return type
dict
Returns
Response Syntax
{
    'DevEndpoint': {
        'EndpointName': 'string',
        'RoleArn': 'string',
        'SecurityGroupIds': [
            'string',
        ],
        'SubnetId': 'string',
        'YarnEndpointAddress': 'string',
        'PrivateAddress': 'string',
        'ZeppelinRemoteSparkInterpreterPort': 123,
        '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',
        'PublicKeys': [
            'string',
        ],
        'SecurityConfiguration': 'string',
        'Arguments': {
            'string': '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.

      • PrivateAddress (string) --

        A private IP address to access the DevEndpoint within a VPC, if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your virtual private cloud (VPC).

      • ZeppelinRemoteSparkInterpreterPort (integer) --

        The Apache Zeppelin port for the remote Apache Spark interpreter.

      • PublicAddress (string) --

        The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-VPC (virtual private cloud) DevEndpoint.

      • Status (string) --

        The current status of this DevEndpoint.

      • NumberOfNodes (integer) --

        The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

      • AvailabilityZone (string) --

        The AWS availability zone where this DevEndpoint is located.

      • VpcId (string) --

        The ID of the virtual private cloud (VPC) used by this DevEndpoint.

      • ExtraPythonLibsS3Path (string) --

        Path(s) to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

        Please note that only pure Python libraries can currently be used on a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.

      • ExtraJarsS3Path (string) --

        Path to one or more Java Jars in an S3 bucket that should be loaded in your DevEndpoint.

        Please note that only pure Java/Scala libraries can currently be used on a DevEndpoint.

      • FailureReason (string) --

        The reason for a current failure in this DevEndpoint.

      • LastUpdateStatus (string) --

        The status of the last update.

      • CreatedTimestamp (datetime) --

        The point in time at which this DevEndpoint was created.

      • LastModifiedTimestamp (datetime) --

        The point in time at which this DevEndpoint was last modified.

      • PublicKey (string) --

        The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility, as the recommended attribute to use is public keys.

      • PublicKeys (list) --

        A list of public keys to be used by the DevEndpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.

        Note

        If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys: call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.

        • (string) --
      • SecurityConfiguration (string) --

        The name of the SecurityConfiguration structure to be used with this DevEndpoint.

      • Arguments (dict) --

        A map of arguments used to configure the DevEndpoint.

        Note that currently, we only support "--enable-glue-datacatalog": "" as a valid argument.

        • (string) --
          • (string) --
get_dev_endpoints(**kwargs)

Retrieves all the DevEndpoints in this AWS account.

Note

When you create a development endpoint in a virtual private cloud (VPC), AWS Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, AWS Glue returns only a public IP address.

See also: AWS API Documentation

Request Syntax

response = client.get_dev_endpoints(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum size of information to return.
  • NextToken (string) -- A continuation token, if this is a continuation call.
Return type

dict

Returns

Response Syntax

{
    'DevEndpoints': [
        {
            'EndpointName': 'string',
            'RoleArn': 'string',
            'SecurityGroupIds': [
                'string',
            ],
            'SubnetId': 'string',
            'YarnEndpointAddress': 'string',
            'PrivateAddress': 'string',
            'ZeppelinRemoteSparkInterpreterPort': 123,
            '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',
            'PublicKeys': [
                'string',
            ],
            'SecurityConfiguration': 'string',
            'Arguments': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • DevEndpoints (list) --

      A list of DevEndpoint definitions.

      • (dict) --

        A development endpoint where a developer can remotely debug 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.

        • PrivateAddress (string) --

          A private IP address to access the DevEndpoint within a VPC, if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your virtual private cloud (VPC).

        • ZeppelinRemoteSparkInterpreterPort (integer) --

          The Apache Zeppelin port for the remote Apache Spark interpreter.

        • PublicAddress (string) --

          The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-VPC (virtual private cloud) DevEndpoint.

        • Status (string) --

          The current status of this DevEndpoint.

        • NumberOfNodes (integer) --

          The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

        • AvailabilityZone (string) --

          The AWS availability zone where this DevEndpoint is located.

        • VpcId (string) --

          The ID of the virtual private cloud (VPC) used by this DevEndpoint.

        • ExtraPythonLibsS3Path (string) --

          Path(s) to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

          Please note that only pure Python libraries can currently be used on a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.

        • ExtraJarsS3Path (string) --

          Path to one or more Java Jars in an S3 bucket that should be loaded in your DevEndpoint.

          Please note that only pure Java/Scala libraries can currently be used on a DevEndpoint.

        • FailureReason (string) --

          The reason for a current failure in this DevEndpoint.

        • LastUpdateStatus (string) --

          The status of the last update.

        • CreatedTimestamp (datetime) --

          The point in time at which this DevEndpoint was created.

        • LastModifiedTimestamp (datetime) --

          The point in time at which this DevEndpoint was last modified.

        • PublicKey (string) --

          The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility, as the recommended attribute to use is public keys.

        • PublicKeys (list) --

          A list of public keys to be used by the DevEndpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.

          Note

          If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys: call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.

          • (string) --
        • SecurityConfiguration (string) --

          The name of the SecurityConfiguration structure to be used with this DevEndpoint.

        • Arguments (dict) --

          A map of arguments used to configure the DevEndpoint.

          Note that currently, we only support "--enable-glue-datacatalog": "" as a valid argument.

          • (string) --
            • (string) --
    • NextToken (string) --

      A continuation token, if not all DevEndpoint definitions have yet been returned.

get_job(**kwargs)

Retrieves an existing job definition.

See also: AWS API Documentation

Request Syntax

response = client.get_job(
    JobName='string'
)
Parameters
JobName (string) --

[REQUIRED]

The name of the job definition to retrieve.

Return type
dict
Returns
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',
            'PythonVersion': 'string'
        },
        'DefaultArguments': {
            'string': 'string'
        },
        'Connections': {
            'Connections': [
                'string',
            ]
        },
        'MaxRetries': 123,
        'AllocatedCapacity': 123,
        'Timeout': 123,
        'MaxCapacity': 123.0,
        'WorkerType': 'Standard'|'G.1X'|'G.2X',
        'NumberOfWorkers': 123,
        'SecurityConfiguration': 'string',
        'NotificationProperty': {
            'NotifyDelayAfter': 123
        }
    }
}

Response Structure

  • (dict) --
    • Job (dict) --

      The requested job definition.

      • Name (string) --

        The name you assign to this job definition.

      • Description (string) --

        A description of the job.

      • LogUri (string) --

        This field is reserved for future use.

      • Role (string) --

        The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

      • CreatedOn (datetime) --

        The time and date that this job definition was created.

      • LastModifiedOn (datetime) --

        The last point in time when this job definition was modified.

      • ExecutionProperty (dict) --

        An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

        • MaxConcurrentRuns (integer) --

          The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

      • Command (dict) --

        The JobCommand that executes this job.

        • Name (string) --

          The name of the job command. For an Apache Spark ETL job, this must be glueetl . For a Python shell job, it must be pythonshell .

        • ScriptLocation (string) --

          Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that executes a job.

        • PythonVersion (string) --

          The Python version being used to execute a Python shell job. Allowed values are 2 or 3.

      • DefaultArguments (dict) --

        The default arguments for this job, specified as name-value pairs.

        You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

        For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

        For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

        • (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 after a JobRun fails.

      • AllocatedCapacity (integer) --

        This field is deprecated. Use MaxCapacity instead.

        The number of AWS Glue data processing units (DPUs) allocated to runs of this job. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

      • Timeout (integer) --

        The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

      • MaxCapacity (float) --

        The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

        Do not set Max Capacity if using WorkerType and NumberOfWorkers .

        The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

        • When you specify a Python shell job (JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
        • When you specify an Apache Spark ETL job (JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
      • WorkerType (string) --

        The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

        • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
        • For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
        • For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
      • NumberOfWorkers (integer) --

        The number of workers of a defined workerType that are allocated when a job runs.

        The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

      • SecurityConfiguration (string) --

        The name of the SecurityConfiguration structure to be used with this job.

      • NotificationProperty (dict) --

        Specifies configuration properties of a job notification.

        • NotifyDelayAfter (integer) --

          After a job run starts, the number of minutes to wait before sending a job run delay notification.

get_job_run(**kwargs)

Retrieves the metadata for a given job run.

See also: AWS API Documentation

Request Syntax

response = client.get_job_run(
    JobName='string',
    RunId='string',
    PredecessorsIncluded=True|False
)
Parameters
  • JobName (string) --

    [REQUIRED]

    Name of the job definition being run.

  • RunId (string) --

    [REQUIRED]

    The ID of the job run.

  • PredecessorsIncluded (boolean) -- True if a list of predecessor runs should be returned.
Return type

dict

Returns

Response Syntax

{
    'JobRun': {
        'Id': 'string',
        'Attempt': 123,
        'PreviousRunId': 'string',
        'TriggerName': 'string',
        'JobName': 'string',
        'StartedOn': datetime(2015, 1, 1),
        'LastModifiedOn': datetime(2015, 1, 1),
        'CompletedOn': datetime(2015, 1, 1),
        'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
        'Arguments': {
            'string': 'string'
        },
        'ErrorMessage': 'string',
        'PredecessorRuns': [
            {
                'JobName': 'string',
                'RunId': 'string'
            },
        ],
        'AllocatedCapacity': 123,
        'ExecutionTime': 123,
        'Timeout': 123,
        'MaxCapacity': 123.0,
        'WorkerType': 'Standard'|'G.1X'|'G.2X',
        'NumberOfWorkers': 123,
        'SecurityConfiguration': 'string',
        'LogGroupName': 'string',
        'NotificationProperty': {
            'NotifyDelayAfter': 123
        }
    }
}

Response Structure

  • (dict) --

    • JobRun (dict) --

      The requested job-run metadata.

      • Id (string) --

        The ID of this job run.

      • Attempt (integer) --

        The number of the attempt to run this job.

      • PreviousRunId (string) --

        The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

      • TriggerName (string) --

        The name of the trigger that started this job run.

      • JobName (string) --

        The name of the job definition being used in this run.

      • StartedOn (datetime) --

        The date and time at which this job run was started.

      • LastModifiedOn (datetime) --

        The last time that this job run was modified.

      • CompletedOn (datetime) --

        The date and time that this job run completed.

      • JobRunState (string) --

        The current state of the job run.

      • Arguments (dict) --

        The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.

        You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

        For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

        For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

        • (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 was used in the predicate of a conditional trigger that triggered this job run.

          • JobName (string) --

            The name of the job definition used by the predecessor job run.

          • RunId (string) --

            The job-run ID of the predecessor job run.

      • AllocatedCapacity (integer) --

        This field is deprecated. Use MaxCapacity instead.

        The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

      • ExecutionTime (integer) --

        The amount of time (in seconds) that the job run consumed resources.

      • Timeout (integer) --

        The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

      • MaxCapacity (float) --

        The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

        Do not set Max Capacity if using WorkerType and NumberOfWorkers .

        The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

        • When you specify a Python shell job (JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
        • When you specify an Apache Spark ETL job (JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
      • WorkerType (string) --

        The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

        • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
        • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
        • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
      • NumberOfWorkers (integer) --

        The number of workers of a defined workerType that are allocated when a job runs.

        The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

      • SecurityConfiguration (string) --

        The name of the SecurityConfiguration structure to be used with this job run.

      • LogGroupName (string) --

        The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using AWS KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.

      • NotificationProperty (dict) --

        Specifies configuration properties of a job run notification.

        • NotifyDelayAfter (integer) --

          After a job run starts, the number of minutes to wait before sending a job run delay notification.

get_job_runs(**kwargs)

Retrieves metadata for all runs of a given job definition.

See also: AWS API Documentation

Request Syntax

response = client.get_job_runs(
    JobName='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • JobName (string) --

    [REQUIRED]

    The name of the job definition for which to retrieve all job runs.

  • NextToken (string) -- A continuation token, if this is a continuation call.
  • MaxResults (integer) -- The maximum size of the response.
Return type

dict

Returns

Response Syntax

{
    'JobRuns': [
        {
            'Id': 'string',
            'Attempt': 123,
            'PreviousRunId': 'string',
            'TriggerName': 'string',
            'JobName': 'string',
            'StartedOn': datetime(2015, 1, 1),
            'LastModifiedOn': datetime(2015, 1, 1),
            'CompletedOn': datetime(2015, 1, 1),
            'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
            'Arguments': {
                'string': 'string'
            },
            'ErrorMessage': 'string',
            'PredecessorRuns': [
                {
                    'JobName': 'string',
                    'RunId': 'string'
                },
            ],
            'AllocatedCapacity': 123,
            'ExecutionTime': 123,
            'Timeout': 123,
            'MaxCapacity': 123.0,
            'WorkerType': 'Standard'|'G.1X'|'G.2X',
            'NumberOfWorkers': 123,
            'SecurityConfiguration': 'string',
            'LogGroupName': 'string',
            'NotificationProperty': {
                'NotifyDelayAfter': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • JobRuns (list) --

      A list of job-run metadata objects.

      • (dict) --

        Contains information about a job run.

        • Id (string) --

          The ID of this job run.

        • Attempt (integer) --

          The number of the attempt to run this job.

        • PreviousRunId (string) --

          The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

        • TriggerName (string) --

          The name of the trigger that started this job run.

        • JobName (string) --

          The name of the job definition being used in this run.

        • StartedOn (datetime) --

          The date and time at which this job run was started.

        • LastModifiedOn (datetime) --

          The last time that this job run was modified.

        • CompletedOn (datetime) --

          The date and time that this job run completed.

        • JobRunState (string) --

          The current state of the job run.

        • Arguments (dict) --

          The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.

          You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

          For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

          For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

          • (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 was used in the predicate of a conditional trigger that triggered this job run.

            • JobName (string) --

              The name of the job definition used by the predecessor job run.

            • RunId (string) --

              The job-run ID of the predecessor job run.

        • AllocatedCapacity (integer) --

          This field is deprecated. Use MaxCapacity instead.

          The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

        • ExecutionTime (integer) --

          The amount of time (in seconds) that the job run consumed resources.

        • Timeout (integer) --

          The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

        • MaxCapacity (float) --

          The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

          Do not set Max Capacity if using WorkerType and NumberOfWorkers .

          The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

          • When you specify a Python shell job (JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
          • When you specify an Apache Spark ETL job (JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
        • WorkerType (string) --

          The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

          • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
          • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
          • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
        • NumberOfWorkers (integer) --

          The number of workers of a defined workerType that are allocated when a job runs.

          The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

        • SecurityConfiguration (string) --

          The name of the SecurityConfiguration structure to be used with this job run.

        • LogGroupName (string) --

          The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using AWS KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.

        • NotificationProperty (dict) --

          Specifies configuration properties of a job run notification.

          • NotifyDelayAfter (integer) --

            After a job run starts, the number of minutes to wait before sending a job run delay notification.

    • NextToken (string) --

      A continuation token, if not all requested job runs have been returned.

get_jobs(**kwargs)

Retrieves all current job definitions.

See also: AWS API Documentation

Request Syntax

response = client.get_jobs(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- A continuation token, if this is a continuation call.
  • MaxResults (integer) -- The maximum size of the response.
Return type

dict

Returns

Response Syntax

{
    'Jobs': [
        {
            'Name': 'string',
            'Description': 'string',
            'LogUri': 'string',
            'Role': 'string',
            'CreatedOn': datetime(2015, 1, 1),
            'LastModifiedOn': datetime(2015, 1, 1),
            'ExecutionProperty': {
                'MaxConcurrentRuns': 123
            },
            'Command': {
                'Name': 'string',
                'ScriptLocation': 'string',
                'PythonVersion': 'string'
            },
            'DefaultArguments': {
                'string': 'string'
            },
            'Connections': {
                'Connections': [
                    'string',
                ]
            },
            'MaxRetries': 123,
            'AllocatedCapacity': 123,
            'Timeout': 123,
            'MaxCapacity': 123.0,
            'WorkerType': 'Standard'|'G.1X'|'G.2X',
            'NumberOfWorkers': 123,
            'SecurityConfiguration': 'string',
            'NotificationProperty': {
                'NotifyDelayAfter': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Jobs (list) --

      A list of job definitions.

      • (dict) --

        Specifies a job definition.

        • Name (string) --

          The name you assign to this job definition.

        • Description (string) --

          A description of the job.

        • LogUri (string) --

          This field is reserved for future use.

        • Role (string) --

          The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

        • CreatedOn (datetime) --

          The time and date that this job definition was created.

        • LastModifiedOn (datetime) --

          The last point in time when this job definition was modified.

        • ExecutionProperty (dict) --

          An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

          • MaxConcurrentRuns (integer) --

            The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

        • Command (dict) --

          The JobCommand that executes this job.

          • Name (string) --

            The name of the job command. For an Apache Spark ETL job, this must be glueetl . For a Python shell job, it must be pythonshell .

          • ScriptLocation (string) --

            Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that executes a job.

          • PythonVersion (string) --

            The Python version being used to execute a Python shell job. Allowed values are 2 or 3.

        • DefaultArguments (dict) --

          The default arguments for this job, specified as name-value pairs.

          You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

          For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

          For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

          • (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 after a JobRun fails.

        • AllocatedCapacity (integer) --

          This field is deprecated. Use MaxCapacity instead.

          The number of AWS Glue data processing units (DPUs) allocated to runs of this job. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

        • Timeout (integer) --

          The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

        • MaxCapacity (float) --

          The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

          Do not set Max Capacity if using WorkerType and NumberOfWorkers .

          The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

          • When you specify a Python shell job (JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
          • When you specify an Apache Spark ETL job (JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
        • WorkerType (string) --

          The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

          • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
          • For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
          • For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
        • NumberOfWorkers (integer) --

          The number of workers of a defined workerType that are allocated when a job runs.

          The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

        • SecurityConfiguration (string) --

          The name of the SecurityConfiguration structure to be used with this job.

        • NotificationProperty (dict) --

          Specifies configuration properties of a job notification.

          • NotifyDelayAfter (integer) --

            After a job run starts, the number of minutes to wait before sending a job run delay notification.

    • NextToken (string) --

      A continuation token, if not all job definitions have yet been returned.

get_mapping(**kwargs)

Creates mappings.

See also: AWS API Documentation

Request Syntax

response = client.get_mapping(
    Source={
        'DatabaseName': 'string',
        'TableName': 'string'
    },
    Sinks=[
        {
            'DatabaseName': 'string',
            'TableName': 'string'
        },
    ],
    Location={
        'Jdbc': [
            {
                'Name': 'string',
                'Value': 'string',
                'Param': True|False
            },
        ],
        'S3': [
            {
                'Name': 'string',
                'Value': 'string',
                'Param': True|False
            },
        ],
        'DynamoDB': [
            {
                'Name': 'string',
                'Value': 'string',
                'Param': True|False
            },
        ]
    }
)
Parameters
  • Source (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.

  • Sinks (list) --

    A list of target tables.

    • (dict) --

      Specifies a table definition in the AWS Glue Data Catalog.

      • DatabaseName (string) -- [REQUIRED]

        The database in which the table metadata resides.

      • TableName (string) -- [REQUIRED]

        The name of the table in question.

  • Location (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 Amazon Simple Storage Service (Amazon 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.

    • DynamoDB (list) --

      An Amazon DynamoDB table 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.

Return type

dict

Returns

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.

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_partition(**kwargs)

Retrieves information about a specified partition.

See also: AWS API Documentation

Request Syntax

response = client.get_partition(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    PartitionValues=[
        'string',
    ]
)
Parameters
  • CatalogId (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.
  • DatabaseName (string) --

    [REQUIRED]

    The name of the catalog database where the partition resides.

  • TableName (string) --

    [REQUIRED]

    The name of the partition's table.

  • PartitionValues (list) --

    [REQUIRED]

    The values that define the partition.

    • (string) --
Return type

dict

Returns

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) --

            These key-value pairs define initialization parameters for the SerDe.

            • (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) --

        These key-value pairs define partition parameters.

        • (string) --
          • (string) --
      • LastAnalyzedTime (datetime) --

        The last time at which column statistics were computed for this partition.

get_partitions(**kwargs)

Retrieves information about the partitions in a table.

See also: AWS API Documentation

Request Syntax

response = client.get_partitions(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    Expression='string',
    NextToken='string',
    Segment={
        'SegmentNumber': 123,
        'TotalSegments': 123
    },
    MaxResults=123
)
Parameters
  • CatalogId (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.
  • DatabaseName (string) --

    [REQUIRED]

    The name of the catalog database where the partitions reside.

  • TableName (string) --

    [REQUIRED]

    The name of the partitions' table.

  • Expression (string) --

    An expression filtering the partitions to be returned.

    The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser JSQLParser parses the expression.

    Operators : The following are the operators that you can use in the Expression API call:
    =

    Checks if the values of the two operands are equal or not; if yes, then the condition becomes true.

    Example: Assume 'variable a' holds 10 and 'variable b' holds 20.

    (a = b) is not true.

    < >

    Checks if the values of two operands are equal or not; if the values are not equal, then the condition becomes true.

    Example: (a < > b) is true.

    >

    Checks if the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.

    Example: (a > b) is not true.

    <

    Checks if the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.

    Example: (a < b) is true.

    >=

    Checks if the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.

    Example: (a >= b) is not true.

    <=

    Checks if the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.

    Example: (a <= b) is true.

    AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL

    Logical operators.

    Supported Partition Key Types : The following are the the supported partition keys.
    • string
    • date
    • timestamp
    • int
    • bigint
    • long
    • tinyint
    • smallint
    • decimal

    If an invalid type is encountered, an exception is thrown.

    The following list shows the valid operators on each type. When you define a crawler, the partitionKey type is created as a STRING , to be compatible with the catalog partitions.

    Sample API Call :
  • NextToken (string) -- A continuation token, if this is not the first call to retrieve these partitions.
  • Segment (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.

  • MaxResults (integer) -- The maximum number of partitions to return in a single response.
Return type

dict

Returns

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) --

              These key-value pairs define initialization parameters for the SerDe.

              • (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) --

          These key-value pairs define partition parameters.

          • (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.

get_plan(**kwargs)

Gets code to perform a specified mapping.

See also: AWS API Documentation

Request Syntax

response = client.get_plan(
    Mapping=[
        {
            'SourceTable': 'string',
            'SourcePath': 'string',
            'SourceType': 'string',
            'TargetTable': 'string',
            'TargetPath': 'string',
            'TargetType': 'string'
        },
    ],
    Source={
        'DatabaseName': 'string',
        'TableName': 'string'
    },
    Sinks=[
        {
            'DatabaseName': 'string',
            'TableName': 'string'
        },
    ],
    Location={
        'Jdbc': [
            {
                'Name': 'string',
                'Value': 'string',
                'Param': True|False
            },
        ],
        'S3': [
            {
                'Name': 'string',
                'Value': 'string',
                'Param': True|False
            },
        ],
        'DynamoDB': [
            {
                'Name': 'string',
                'Value': 'string',
                'Param': True|False
            },
        ]
    },
    Language='PYTHON'|'SCALA'
)
Parameters
  • Mapping (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.

  • Source (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.

  • Sinks (list) --

    The target tables.

    • (dict) --

      Specifies a table definition in the AWS Glue Data Catalog.

      • DatabaseName (string) -- [REQUIRED]

        The database in which the table metadata resides.

      • TableName (string) -- [REQUIRED]

        The name of the table in question.

  • Location (dict) --

    The 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 Amazon Simple Storage Service (Amazon 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.

    • DynamoDB (list) --

      An Amazon DynamoDB table 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.

  • Language (string) -- The programming language of the code to perform the mapping.
Return type

dict

Returns

Response Syntax

{
    'PythonScript': 'string',
    'ScalaCode': 'string'
}

Response Structure

  • (dict) --

    • PythonScript (string) --

      A Python script to perform the mapping.

    • ScalaCode (string) --

      The Scala code to perform the mapping.

get_resource_policy()

Retrieves a specified resource policy.

See also: AWS API Documentation

Request Syntax

response = client.get_resource_policy()
Return type
dict
Returns
Response Syntax
{
    'PolicyInJson': 'string',
    'PolicyHash': 'string',
    'CreateTime': datetime(2015, 1, 1),
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • PolicyInJson (string) --

      Contains the requested policy document, in JSON format.

    • PolicyHash (string) --

      Contains the hash value associated with this policy.

    • CreateTime (datetime) --

      The date and time at which the policy was created.

    • UpdateTime (datetime) --

      The date and time at which the policy was last updated.

get_security_configuration(**kwargs)

Retrieves a specified security configuration.

See also: AWS API Documentation

Request Syntax

response = client.get_security_configuration(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the security configuration to retrieve.

Return type
dict
Returns
Response Syntax
{
    'SecurityConfiguration': {
        'Name': 'string',
        'CreatedTimeStamp': datetime(2015, 1, 1),
        'EncryptionConfiguration': {
            'S3Encryption': [
                {
                    'S3EncryptionMode': 'DISABLED'|'SSE-KMS'|'SSE-S3',
                    'KmsKeyArn': 'string'
                },
            ],
            'CloudWatchEncryption': {
                'CloudWatchEncryptionMode': 'DISABLED'|'SSE-KMS',
                'KmsKeyArn': 'string'
            },
            'JobBookmarksEncryption': {
                'JobBookmarksEncryptionMode': 'DISABLED'|'CSE-KMS',
                'KmsKeyArn': 'string'
            }
        }
    }
}

Response Structure

  • (dict) --
    • SecurityConfiguration (dict) --

      The requested security configuration

      • Name (string) --

        The name of the security configuration.

      • CreatedTimeStamp (datetime) --

        The time at which this security configuration was created.

      • EncryptionConfiguration (dict) --

        The encryption configuration associated with this security configuration.

        • S3Encryption (list) --

          The encryption configuration for S3 data.

          • (dict) --

            Specifies how S3 data should be encrypted.

            • S3EncryptionMode (string) --

              The encryption mode to use for S3 data.

            • KmsKeyArn (string) --

              The AWS ARN of the KMS key to be used to encrypt the data.

        • CloudWatchEncryption (dict) --

          The encryption configuration for CloudWatch.

          • CloudWatchEncryptionMode (string) --

            The encryption mode to use for CloudWatch data.

          • KmsKeyArn (string) --

            The AWS ARN of the KMS key to be used to encrypt the data.

        • JobBookmarksEncryption (dict) --

          The encryption configuration for Job Bookmarks.

          • JobBookmarksEncryptionMode (string) --

            The encryption mode to use for Job bookmarks data.

          • KmsKeyArn (string) --

            The AWS ARN of the KMS key to be used to encrypt the data.

get_security_configurations(**kwargs)

Retrieves a list of all security configurations.

See also: AWS API Documentation

Request Syntax

response = client.get_security_configurations(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- A continuation token, if this is a continuation call.
Return type

dict

Returns

Response Syntax

{
    'SecurityConfigurations': [
        {
            'Name': 'string',
            'CreatedTimeStamp': datetime(2015, 1, 1),
            'EncryptionConfiguration': {
                'S3Encryption': [
                    {
                        'S3EncryptionMode': 'DISABLED'|'SSE-KMS'|'SSE-S3',
                        'KmsKeyArn': 'string'
                    },
                ],
                'CloudWatchEncryption': {
                    'CloudWatchEncryptionMode': 'DISABLED'|'SSE-KMS',
                    'KmsKeyArn': 'string'
                },
                'JobBookmarksEncryption': {
                    'JobBookmarksEncryptionMode': 'DISABLED'|'CSE-KMS',
                    'KmsKeyArn': 'string'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • SecurityConfigurations (list) --

      A list of security configurations.

      • (dict) --

        Specifies a security configuration.

        • Name (string) --

          The name of the security configuration.

        • CreatedTimeStamp (datetime) --

          The time at which this security configuration was created.

        • EncryptionConfiguration (dict) --

          The encryption configuration associated with this security configuration.

          • S3Encryption (list) --

            The encryption configuration for S3 data.

            • (dict) --

              Specifies how S3 data should be encrypted.

              • S3EncryptionMode (string) --

                The encryption mode to use for S3 data.

              • KmsKeyArn (string) --

                The AWS ARN of the KMS key to be used to encrypt the data.

          • CloudWatchEncryption (dict) --

            The encryption configuration for CloudWatch.

            • CloudWatchEncryptionMode (string) --

              The encryption mode to use for CloudWatch data.

            • KmsKeyArn (string) --

              The AWS ARN of the KMS key to be used to encrypt the data.

          • JobBookmarksEncryption (dict) --

            The encryption configuration for Job Bookmarks.

            • JobBookmarksEncryptionMode (string) --

              The encryption mode to use for Job bookmarks data.

            • KmsKeyArn (string) --

              The AWS ARN of the KMS key to be used to encrypt the data.

    • NextToken (string) --

      A continuation token, if there are more security configurations to return.

get_table(**kwargs)

Retrieves the Table definition in a Data Catalog for a specified table.

See also: AWS API Documentation

Request Syntax

response = client.get_table(
    CatalogId='string',
    DatabaseName='string',
    Name='string'
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default.
  • DatabaseName (string) --

    [REQUIRED]

    The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

  • Name (string) --

    [REQUIRED]

    The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.

Return type

dict

Returns

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. For Hive compatibility, this must be entirely lowercase.

      • DatabaseName (string) --

        Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.

      • 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) --

            These key-value pairs define initialization parameters for the SerDe.

            • (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.

        When creating a table used by Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:

        "PartitionKeys": []

        • (dict) --

          A column in a Table .

          • Name (string) --

            The name of the Column .

          • Type (string) --

            The 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) --

        These key-value pairs define properties associated with the table.

        • (string) --
          • (string) --
      • CreatedBy (string) --

        Person or entity who created the table.

get_table_version(**kwargs)

Retrieves a specified version of a table.

See also: AWS API Documentation

Request Syntax

response = client.get_table_version(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    VersionId='string'
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.
  • DatabaseName (string) --

    [REQUIRED]

    The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

  • TableName (string) --

    [REQUIRED]

    The name of the table. For Hive compatibility, this name is entirely lowercase.

  • VersionId (string) -- The ID value of the table version to be retrieved. A VersionID is a string representation of an integer. Each version is incremented by 1.
Return type

dict

Returns

Response Syntax

{
    'TableVersion': {
        'Table': {
            'Name': 'string',
            'DatabaseName': 'string',
            'Description': 'string',
            'Owner': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'UpdateTime': datetime(2015, 1, 1),
            'LastAccessTime': datetime(2015, 1, 1),
            'LastAnalyzedTime': datetime(2015, 1, 1),
            'Retention': 123,
            'StorageDescriptor': {
                'Columns': [
                    {
                        'Name': 'string',
                        'Type': 'string',
                        'Comment': 'string'
                    },
                ],
                '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'
    }
}

Response Structure

  • (dict) --

    • TableVersion (dict) --

      The requested table version.

      • Table (dict) --

        The table in question

        • Name (string) --

          Name of the table. For Hive compatibility, this must be entirely lowercase.

        • DatabaseName (string) --

          Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.

        • 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) --

              These key-value pairs define initialization parameters for the SerDe.

              • (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.

          When creating a table used by Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:

          "PartitionKeys": []

          • (dict) --

            A column in a Table .

            • Name (string) --

              The name of the Column .

            • Type (string) --

              The 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) --

          These key-value pairs define properties associated with the table.

          • (string) --
            • (string) --
        • CreatedBy (string) --

          Person or entity who created the table.

      • VersionId (string) --

        The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1.

get_table_versions(**kwargs)

Retrieves a list of strings that identify available versions of a specified table.

See also: AWS API Documentation

Request Syntax

response = client.get_table_versions(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.
  • DatabaseName (string) --

    [REQUIRED]

    The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

  • TableName (string) --

    [REQUIRED]

    The name of the table. For Hive compatibility, this name is entirely lowercase.

  • NextToken (string) -- A continuation token, if this is not the first call.
  • MaxResults (integer) -- The maximum number of table versions to return in one response.
Return type

dict

Returns

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) --

        Specifies a version of a table.

        • Table (dict) --

          The table in question

          • Name (string) --

            Name of the table. For Hive compatibility, this must be entirely lowercase.

          • DatabaseName (string) --

            Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.

          • 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) --

                These key-value pairs define initialization parameters for the SerDe.

                • (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.

            When creating a table used by Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:

            "PartitionKeys": []

            • (dict) --

              A column in a Table .

              • Name (string) --

                The name of the Column .

              • Type (string) --

                The 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) --

            These key-value pairs define properties associated with the table.

            • (string) --
              • (string) --
          • CreatedBy (string) --

            Person or entity who created the table.

        • VersionId (string) --

          The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1.

    • NextToken (string) --

      A continuation token, if the list of available versions does not include the last one.

get_tables(**kwargs)

Retrieves the definitions of some or all of the tables in a given Database .

See also: AWS API Documentation

Request Syntax

response = client.get_tables(
    CatalogId='string',
    DatabaseName='string',
    Expression='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.
  • DatabaseName (string) --

    [REQUIRED]

    The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.

  • Expression (string) -- A regular expression pattern. If present, only those tables whose names match the pattern are returned.
  • NextToken (string) -- A continuation token, included if this is a continuation call.
  • MaxResults (integer) -- The maximum number of tables to return in a single response.
Return type

dict

Returns

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. For Hive compatibility, this must be entirely lowercase.

        • DatabaseName (string) --

          Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.

        • 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) --

              These key-value pairs define initialization parameters for the SerDe.

              • (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.

          When creating a table used by Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:

          "PartitionKeys": []

          • (dict) --

            A column in a Table .

            • Name (string) --

              The name of the Column .

            • Type (string) --

              The 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) --

          These key-value pairs define properties associated with the table.

          • (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.

get_tags(**kwargs)

Retrieves a list of tags associated with a resource.

See also: AWS API Documentation

Request Syntax

response = client.get_tags(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource for which to retrieve tags.

Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • Tags (dict) --

      The requested tags.

      • (string) --
        • (string) --
get_trigger(**kwargs)

Retrieves the definition of a trigger.

See also: AWS API Documentation

Request Syntax

response = client.get_trigger(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the trigger to retrieve.

Return type
dict
Returns
Response Syntax
{
    'Trigger': {
        'Name': 'string',
        'WorkflowName': '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'
                },
                'Timeout': 123,
                'SecurityConfiguration': 'string',
                'NotificationProperty': {
                    'NotifyDelayAfter': 123
                },
                'CrawlerName': 'string'
            },
        ],
        'Predicate': {
            'Logical': 'AND'|'ANY',
            'Conditions': [
                {
                    'LogicalOperator': 'EQUALS',
                    'JobName': 'string',
                    'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                    'CrawlerName': 'string',
                    'CrawlState': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED'
                },
            ]
        }
    }
}

Response Structure

  • (dict) --
    • Trigger (dict) --

      The requested trigger definition.

      • Name (string) --

        The name of the trigger.

      • WorkflowName (string) --

        The name of the workflow associated with the trigger.

      • Id (string) --

        Reserved for future use.

      • Type (string) --

        The type of trigger that this is.

      • State (string) --

        The current state of the trigger.

      • Description (string) --

        A description of this trigger.

      • Schedule (string) --

        A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .

      • Actions (list) --

        The actions initiated by this trigger.

        • (dict) --

          Defines an action to be initiated by a trigger.

          • JobName (string) --

            The name of a job to be executed.

          • Arguments (dict) --

            The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

            You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

            For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

            For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

            • (string) --
              • (string) --
          • Timeout (integer) --

            The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

          • SecurityConfiguration (string) --

            The name of the SecurityConfiguration structure to be used with this action.

          • NotificationProperty (dict) --

            Specifies configuration properties of a job run notification.

            • NotifyDelayAfter (integer) --

              After a job run starts, the number of minutes to wait before sending a job run delay notification.

          • CrawlerName (string) --

            The name of the crawler to be used with this action.

      • Predicate (dict) --

        The predicate of this trigger, which defines when it will fire.

        • Logical (string) --

          An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

        • Conditions (list) --

          A list of the conditions that determine when the trigger will fire.

          • (dict) --

            Defines a condition under which a trigger fires.

            • LogicalOperator (string) --

              A logical operator.

            • JobName (string) --

              The name of the job whose JobRuns this condition applies to, and on which this trigger waits.

            • State (string) --

              The condition state. Currently, the values supported are SUCCEEDED , STOPPED , TIMEOUT , and FAILED .

            • CrawlerName (string) --

              The name of the crawler to which this condition applies.

            • CrawlState (string) --

              The state of the crawler to which this condition applies.

get_triggers(**kwargs)

Gets all the triggers associated with a job.

See also: AWS API Documentation

Request Syntax

response = client.get_triggers(
    NextToken='string',
    DependentJobName='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- A continuation token, if this is a continuation call.
  • DependentJobName (string) -- The name of the job to retrieve triggers for. The trigger that can start this job is returned, and if there is no such trigger, all triggers are returned.
  • MaxResults (integer) -- The maximum size of the response.
Return type

dict

Returns

Response Syntax

{
    'Triggers': [
        {
            'Name': 'string',
            'WorkflowName': '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'
                    },
                    'Timeout': 123,
                    'SecurityConfiguration': 'string',
                    'NotificationProperty': {
                        'NotifyDelayAfter': 123
                    },
                    'CrawlerName': 'string'
                },
            ],
            'Predicate': {
                'Logical': 'AND'|'ANY',
                'Conditions': [
                    {
                        'LogicalOperator': 'EQUALS',
                        'JobName': 'string',
                        'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                        'CrawlerName': 'string',
                        'CrawlState': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED'
                    },
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Triggers (list) --

      A list of triggers for the specified job.

      • (dict) --

        Information about a specific trigger.

        • Name (string) --

          The name of the trigger.

        • WorkflowName (string) --

          The name of the workflow associated with the trigger.

        • Id (string) --

          Reserved for future use.

        • Type (string) --

          The type of trigger that this is.

        • State (string) --

          The current state of the trigger.

        • Description (string) --

          A description of this trigger.

        • Schedule (string) --

          A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .

        • Actions (list) --

          The actions initiated by this trigger.

          • (dict) --

            Defines an action to be initiated by a trigger.

            • JobName (string) --

              The name of a job to be executed.

            • Arguments (dict) --

              The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

              You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

              For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

              For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

              • (string) --
                • (string) --
            • Timeout (integer) --

              The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

            • SecurityConfiguration (string) --

              The name of the SecurityConfiguration structure to be used with this action.

            • NotificationProperty (dict) --

              Specifies configuration properties of a job run notification.

              • NotifyDelayAfter (integer) --

                After a job run starts, the number of minutes to wait before sending a job run delay notification.

            • CrawlerName (string) --

              The name of the crawler to be used with this action.

        • Predicate (dict) --

          The predicate of this trigger, which defines when it will fire.

          • Logical (string) --

            An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

          • Conditions (list) --

            A list of the conditions that determine when the trigger will fire.

            • (dict) --

              Defines a condition under which a trigger fires.

              • LogicalOperator (string) --

                A logical operator.

              • JobName (string) --

                The name of the job whose JobRuns this condition applies to, and on which this trigger waits.

              • State (string) --

                The condition state. Currently, the values supported are SUCCEEDED , STOPPED , TIMEOUT , and FAILED .

              • CrawlerName (string) --

                The name of the crawler to which this condition applies.

              • CrawlState (string) --

                The state of the crawler to which this condition applies.

    • NextToken (string) --

      A continuation token, if not all the requested triggers have yet been returned.

get_user_defined_function(**kwargs)

Retrieves a specified function definition from the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.get_user_defined_function(
    CatalogId='string',
    DatabaseName='string',
    FunctionName='string'
)
Parameters
  • CatalogId (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.
  • DatabaseName (string) --

    [REQUIRED]

    The name of the catalog database where the function is located.

  • FunctionName (string) --

    [REQUIRED]

    The name of the function.

Return type

dict

Returns

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.

get_user_defined_functions(**kwargs)

Retrieves a multiple function definitions from the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.get_user_defined_functions(
    CatalogId='string',
    DatabaseName='string',
    Pattern='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • CatalogId (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.
  • DatabaseName (string) --

    [REQUIRED]

    The name of the catalog database where the functions are located.

  • Pattern (string) --

    [REQUIRED]

    An optional function-name pattern string that filters the function definitions returned.

  • NextToken (string) -- A continuation token, if this is a continuation call.
  • MaxResults (integer) -- The maximum number of functions to return in one response.
Return type

dict

Returns

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.

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
get_workflow(**kwargs)

Retrieves resource metadata for a workflow.

See also: AWS API Documentation

Request Syntax

response = client.get_workflow(
    Name='string',
    IncludeGraph=True|False
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the workflow to retrieve.

  • IncludeGraph (boolean) -- Specifies whether to include a graph when returning the workflow resource metadata.
Return type

dict

Returns

Response Syntax

{
    'Workflow': {
        'Name': 'string',
        'Description': 'string',
        'DefaultRunProperties': {
            'string': 'string'
        },
        'CreatedOn': datetime(2015, 1, 1),
        'LastModifiedOn': datetime(2015, 1, 1),
        'LastRun': {
            'Name': 'string',
            'WorkflowRunId': 'string',
            'WorkflowRunProperties': {
                'string': 'string'
            },
            'StartedOn': datetime(2015, 1, 1),
            'CompletedOn': datetime(2015, 1, 1),
            'Status': 'RUNNING'|'COMPLETED',
            'Statistics': {
                'TotalActions': 123,
                'TimeoutActions': 123,
                'FailedActions': 123,
                'StoppedActions': 123,
                'SucceededActions': 123,
                'RunningActions': 123
            },
            'Graph': {
                'Nodes': [
                    {
                        'Type': 'CRAWLER'|'JOB'|'TRIGGER',
                        'Name': 'string',
                        'UniqueId': 'string',
                        'TriggerDetails': {
                            'Trigger': {
                                'Name': 'string',
                                'WorkflowName': 'string',
                                'Id': 'string',
                                'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND',
                                'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
                                'Description': 'string',
                                'Schedule': 'string',
                                'Actions': [
                                    {
                                        'JobName': 'string',
                                        'Arguments': {
                                            'string': 'string'
                                        },
                                        'Timeout': 123,
                                        'SecurityConfiguration': 'string',
                                        'NotificationProperty': {
                                            'NotifyDelayAfter': 123
                                        },
                                        'CrawlerName': 'string'
                                    },
                                ],
                                'Predicate': {
                                    'Logical': 'AND'|'ANY',
                                    'Conditions': [
                                        {
                                            'LogicalOperator': 'EQUALS',
                                            'JobName': 'string',
                                            'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                                            'CrawlerName': 'string',
                                            'CrawlState': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED'
                                        },
                                    ]
                                }
                            }
                        },
                        'JobDetails': {
                            'JobRuns': [
                                {
                                    'Id': 'string',
                                    'Attempt': 123,
                                    'PreviousRunId': 'string',
                                    'TriggerName': 'string',
                                    'JobName': 'string',
                                    'StartedOn': datetime(2015, 1, 1),
                                    'LastModifiedOn': datetime(2015, 1, 1),
                                    'CompletedOn': datetime(2015, 1, 1),
                                    'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                                    'Arguments': {
                                        'string': 'string'
                                    },
                                    'ErrorMessage': 'string',
                                    'PredecessorRuns': [
                                        {
                                            'JobName': 'string',
                                            'RunId': 'string'
                                        },
                                    ],
                                    'AllocatedCapacity': 123,
                                    'ExecutionTime': 123,
                                    'Timeout': 123,
                                    'MaxCapacity': 123.0,
                                    'WorkerType': 'Standard'|'G.1X'|'G.2X',
                                    'NumberOfWorkers': 123,
                                    'SecurityConfiguration': 'string',
                                    'LogGroupName': 'string',
                                    'NotificationProperty': {
                                        'NotifyDelayAfter': 123
                                    }
                                },
                            ]
                        },
                        'CrawlerDetails': {
                            'Crawls': [
                                {
                                    'State': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED',
                                    'StartedOn': datetime(2015, 1, 1),
                                    'CompletedOn': datetime(2015, 1, 1),
                                    'ErrorMessage': 'string',
                                    'LogGroup': 'string',
                                    'LogStream': 'string'
                                },
                            ]
                        }
                    },
                ],
                'Edges': [
                    {
                        'SourceId': 'string',
                        'DestinationId': 'string'
                    },
                ]
            }
        },
        'Graph': {
            'Nodes': [
                {
                    'Type': 'CRAWLER'|'JOB'|'TRIGGER',
                    'Name': 'string',
                    'UniqueId': 'string',
                    'TriggerDetails': {
                        'Trigger': {
                            'Name': 'string',
                            'WorkflowName': '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'
                                    },
                                    'Timeout': 123,
                                    'SecurityConfiguration': 'string',
                                    'NotificationProperty': {
                                        'NotifyDelayAfter': 123
                                    },
                                    'CrawlerName': 'string'
                                },
                            ],
                            'Predicate': {
                                'Logical': 'AND'|'ANY',
                                'Conditions': [
                                    {
                                        'LogicalOperator': 'EQUALS',
                                        'JobName': 'string',
                                        'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                                        'CrawlerName': 'string',
                                        'CrawlState': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED'
                                    },
                                ]
                            }
                        }
                    },
                    'JobDetails': {
                        'JobRuns': [
                            {
                                'Id': 'string',
                                'Attempt': 123,
                                'PreviousRunId': 'string',
                                'TriggerName': 'string',
                                'JobName': 'string',
                                'StartedOn': datetime(2015, 1, 1),
                                'LastModifiedOn': datetime(2015, 1, 1),
                                'CompletedOn': datetime(2015, 1, 1),
                                'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                                'Arguments': {
                                    'string': 'string'
                                },
                                'ErrorMessage': 'string',
                                'PredecessorRuns': [
                                    {
                                        'JobName': 'string',
                                        'RunId': 'string'
                                    },
                                ],
                                'AllocatedCapacity': 123,
                                'ExecutionTime': 123,
                                'Timeout': 123,
                                'MaxCapacity': 123.0,
                                'WorkerType': 'Standard'|'G.1X'|'G.2X',
                                'NumberOfWorkers': 123,
                                'SecurityConfiguration': 'string',
                                'LogGroupName': 'string',
                                'NotificationProperty': {
                                    'NotifyDelayAfter': 123
                                }
                            },
                        ]
                    },
                    'CrawlerDetails': {
                        'Crawls': [
                            {
                                'State': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED',
                                'StartedOn': datetime(2015, 1, 1),
                                'CompletedOn': datetime(2015, 1, 1),
                                'ErrorMessage': 'string',
                                'LogGroup': 'string',
                                'LogStream': 'string'
                            },
                        ]
                    }
                },
            ],
            'Edges': [
                {
                    'SourceId': 'string',
                    'DestinationId': 'string'
                },
            ]
        }
    }
}

Response Structure

  • (dict) --

    • Workflow (dict) --

      The resource metadata for the workflow.

      • Name (string) --

        The name of the workflow representing the flow.

      • Description (string) --

        A description of the workflow.

      • DefaultRunProperties (dict) --

        A collection of properties to be used as part of each execution of the workflow.

        • (string) --
          • (string) --
      • CreatedOn (datetime) --

        The date and time when the workflow was created.

      • LastModifiedOn (datetime) --

        The date and time when the workflow was last modified.

      • LastRun (dict) --

        The information about the last execution of the workflow.

        • Name (string) --

          Name of the workflow which was executed.

        • WorkflowRunId (string) --

          The ID of this workflow run.

        • WorkflowRunProperties (dict) --

          The workflow run properties which were set during the run.

          • (string) --
            • (string) --
        • StartedOn (datetime) --

          The date and time when the workflow run was started.

        • CompletedOn (datetime) --

          The date and time when the workflow run completed.

        • Status (string) --

          The status of the workflow run.

        • Statistics (dict) --

          The statistics of the run.

          • TotalActions (integer) --

            Total number of Actions in the workflow run.

          • TimeoutActions (integer) --

            Total number of Actions which timed out.

          • FailedActions (integer) --

            Total number of Actions which have failed.

          • StoppedActions (integer) --

            Total number of Actions which have stopped.

          • SucceededActions (integer) --

            Total number of Actions which have succeeded.

          • RunningActions (integer) --

            Total number Actions in running state.

        • Graph (dict) --

          The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.

          • Nodes (list) --

            A list of the the AWS Glue components belong to the workflow represented as nodes.

            • (dict) --

              A node represents an AWS Glue component like Trigger, Job etc. which is part of a workflow.

              • Type (string) --

                The type of AWS Glue component represented by the node.

              • Name (string) --

                The name of the AWS Glue component represented by the node.

              • UniqueId (string) --

                The unique Id assigned to the node within the workflow.

              • TriggerDetails (dict) --

                Details of the Trigger when the node represents a Trigger.

                • Trigger (dict) --

                  The information of the trigger represented by the trigger node.

                  • Name (string) --

                    The name of the trigger.

                  • WorkflowName (string) --

                    The name of the workflow associated with the trigger.

                  • Id (string) --

                    Reserved for future use.

                  • Type (string) --

                    The type of trigger that this is.

                  • State (string) --

                    The current state of the trigger.

                  • Description (string) --

                    A description of this trigger.

                  • Schedule (string) --

                    A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .

                  • Actions (list) --

                    The actions initiated by this trigger.

                    • (dict) --

                      Defines an action to be initiated by a trigger.

                      • JobName (string) --

                        The name of a job to be executed.

                      • Arguments (dict) --

                        The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

                        You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

                        For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

                        For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

                        • (string) --
                          • (string) --
                      • Timeout (integer) --

                        The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

                      • SecurityConfiguration (string) --

                        The name of the SecurityConfiguration structure to be used with this action.

                      • NotificationProperty (dict) --

                        Specifies configuration properties of a job run notification.

                        • NotifyDelayAfter (integer) --

                          After a job run starts, the number of minutes to wait before sending a job run delay notification.

                      • CrawlerName (string) --

                        The name of the crawler to be used with this action.

                  • Predicate (dict) --

                    The predicate of this trigger, which defines when it will fire.

                    • Logical (string) --

                      An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

                    • Conditions (list) --

                      A list of the conditions that determine when the trigger will fire.

                      • (dict) --

                        Defines a condition under which a trigger fires.

                        • LogicalOperator (string) --

                          A logical operator.

                        • JobName (string) --

                          The name of the job whose JobRuns this condition applies to, and on which this trigger waits.

                        • State (string) --

                          The condition state. Currently, the values supported are SUCCEEDED , STOPPED , TIMEOUT , and FAILED .

                        • CrawlerName (string) --

                          The name of the crawler to which this condition applies.

                        • CrawlState (string) --

                          The state of the crawler to which this condition applies.

              • JobDetails (dict) --

                Details of the Job when the node represents a Job.

                • JobRuns (list) --

                  The information for the job runs represented by the job node.

                  • (dict) --

                    Contains information about a job run.

                    • Id (string) --

                      The ID of this job run.

                    • Attempt (integer) --

                      The number of the attempt to run this job.

                    • PreviousRunId (string) --

                      The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

                    • TriggerName (string) --

                      The name of the trigger that started this job run.

                    • JobName (string) --

                      The name of the job definition being used in this run.

                    • StartedOn (datetime) --

                      The date and time at which this job run was started.

                    • LastModifiedOn (datetime) --

                      The last time that this job run was modified.

                    • CompletedOn (datetime) --

                      The date and time that this job run completed.

                    • JobRunState (string) --

                      The current state of the job run.

                    • Arguments (dict) --

                      The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.

                      You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

                      For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

                      For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

                      • (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 was used in the predicate of a conditional trigger that triggered this job run.

                        • JobName (string) --

                          The name of the job definition used by the predecessor job run.

                        • RunId (string) --

                          The job-run ID of the predecessor job run.

                    • AllocatedCapacity (integer) --

                      This field is deprecated. Use MaxCapacity instead.

                      The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

                    • ExecutionTime (integer) --

                      The amount of time (in seconds) that the job run consumed resources.

                    • Timeout (integer) --

                      The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

                    • MaxCapacity (float) --

                      The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

                      Do not set Max Capacity if using WorkerType and NumberOfWorkers .

                      The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

                      • When you specify a Python shell job (JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
                      • When you specify an Apache Spark ETL job (JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
                    • WorkerType (string) --

                      The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

                      • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
                      • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
                      • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
                    • NumberOfWorkers (integer) --

                      The number of workers of a defined workerType that are allocated when a job runs.

                      The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

                    • SecurityConfiguration (string) --

                      The name of the SecurityConfiguration structure to be used with this job run.

                    • LogGroupName (string) --

                      The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using AWS KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.

                    • NotificationProperty (dict) --

                      Specifies configuration properties of a job run notification.

                      • NotifyDelayAfter (integer) --

                        After a job run starts, the number of minutes to wait before sending a job run delay notification.

              • CrawlerDetails (dict) --

                Details of the crawler when the node represents a crawler.

                • Crawls (list) --

                  A list of crawls represented by the crawl node.

                  • (dict) --

                    The details of a crawl in the workflow.

                    • State (string) --

                      The state of the crawler.

                    • StartedOn (datetime) --

                      The date and time on which the crawl started.

                    • CompletedOn (datetime) --

                      The date and time on which the crawl completed.

                    • ErrorMessage (string) --

                      The error message associated with the crawl.

                    • LogGroup (string) --

                      The log group associated with the crawl.

                    • LogStream (string) --

                      The log stream associated with the crawl.

          • Edges (list) --

            A list of all the directed connections between the nodes belonging to the workflow.

            • (dict) --

              An edge represents a directed connection between two AWS Glue components which are part of the workflow the edge belongs to.

              • SourceId (string) --

                The unique of the node within the workflow where the edge starts.

              • DestinationId (string) --

                The unique of the node within the workflow where the edge ends.

      • Graph (dict) --

        The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.

        • Nodes (list) --

          A list of the the AWS Glue components belong to the workflow represented as nodes.

          • (dict) --

            A node represents an AWS Glue component like Trigger, Job etc. which is part of a workflow.

            • Type (string) --

              The type of AWS Glue component represented by the node.

            • Name (string) --

              The name of the AWS Glue component represented by the node.

            • UniqueId (string) --

              The unique Id assigned to the node within the workflow.

            • TriggerDetails (dict) --

              Details of the Trigger when the node represents a Trigger.

              • Trigger (dict) --

                The information of the trigger represented by the trigger node.

                • Name (string) --

                  The name of the trigger.

                • WorkflowName (string) --

                  The name of the workflow associated with the trigger.

                • Id (string) --

                  Reserved for future use.

                • Type (string) --

                  The type of trigger that this is.

                • State (string) --

                  The current state of the trigger.

                • Description (string) --

                  A description of this trigger.

                • Schedule (string) --

                  A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .

                • Actions (list) --

                  The actions initiated by this trigger.

                  • (dict) --

                    Defines an action to be initiated by a trigger.

                    • JobName (string) --

                      The name of a job to be executed.

                    • Arguments (dict) --

                      The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

                      You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

                      For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

                      For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

                      • (string) --
                        • (string) --
                    • Timeout (integer) --

                      The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

                    • SecurityConfiguration (string) --

                      The name of the SecurityConfiguration structure to be used with this action.

                    • NotificationProperty (dict) --

                      Specifies configuration properties of a job run notification.

                      • NotifyDelayAfter (integer) --

                        After a job run starts, the number of minutes to wait before sending a job run delay notification.

                    • CrawlerName (string) --

                      The name of the crawler to be used with this action.

                • Predicate (dict) --

                  The predicate of this trigger, which defines when it will fire.

                  • Logical (string) --

                    An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

                  • Conditions (list) --

                    A list of the conditions that determine when the trigger will fire.

                    • (dict) --

                      Defines a condition under which a trigger fires.

                      • LogicalOperator (string) --

                        A logical operator.

                      • JobName (string) --

                        The name of the job whose JobRuns this condition applies to, and on which this trigger waits.

                      • State (string) --

                        The condition state. Currently, the values supported are SUCCEEDED , STOPPED , TIMEOUT , and FAILED .

                      • CrawlerName (string) --

                        The name of the crawler to which this condition applies.

                      • CrawlState (string) --

                        The state of the crawler to which this condition applies.

            • JobDetails (dict) --

              Details of the Job when the node represents a Job.

              • JobRuns (list) --

                The information for the job runs represented by the job node.

                • (dict) --

                  Contains information about a job run.

                  • Id (string) --

                    The ID of this job run.

                  • Attempt (integer) --

                    The number of the attempt to run this job.

                  • PreviousRunId (string) --

                    The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

                  • TriggerName (string) --

                    The name of the trigger that started this job run.

                  • JobName (string) --

                    The name of the job definition being used in this run.

                  • StartedOn (datetime) --

                    The date and time at which this job run was started.

                  • LastModifiedOn (datetime) --

                    The last time that this job run was modified.

                  • CompletedOn (datetime) --

                    The date and time that this job run completed.

                  • JobRunState (string) --

                    The current state of the job run.

                  • Arguments (dict) --

                    The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.

                    You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

                    For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

                    For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

                    • (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 was used in the predicate of a conditional trigger that triggered this job run.

                      • JobName (string) --

                        The name of the job definition used by the predecessor job run.

                      • RunId (string) --

                        The job-run ID of the predecessor job run.

                  • AllocatedCapacity (integer) --

                    This field is deprecated. Use MaxCapacity instead.

                    The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

                  • ExecutionTime (integer) --

                    The amount of time (in seconds) that the job run consumed resources.

                  • Timeout (integer) --

                    The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

                  • MaxCapacity (float) --

                    The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

                    Do not set Max Capacity if using WorkerType and NumberOfWorkers .

                    The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

                    • When you specify a Python shell job (JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
                    • When you specify an Apache Spark ETL job (JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
                  • WorkerType (string) --

                    The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

                    • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
                    • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
                    • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
                  • NumberOfWorkers (integer) --

                    The number of workers of a defined workerType that are allocated when a job runs.

                    The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

                  • SecurityConfiguration (string) --

                    The name of the SecurityConfiguration structure to be used with this job run.

                  • LogGroupName (string) --

                    The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using AWS KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.

                  • NotificationProperty (dict) --

                    Specifies configuration properties of a job run notification.

                    • NotifyDelayAfter (integer) --

                      After a job run starts, the number of minutes to wait before sending a job run delay notification.

            • CrawlerDetails (dict) --

              Details of the crawler when the node represents a crawler.

              • Crawls (list) --

                A list of crawls represented by the crawl node.

                • (dict) --

                  The details of a crawl in the workflow.

                  • State (string) --

                    The state of the crawler.

                  • StartedOn (datetime) --

                    The date and time on which the crawl started.

                  • CompletedOn (datetime) --

                    The date and time on which the crawl completed.

                  • ErrorMessage (string) --

                    The error message associated with the crawl.

                  • LogGroup (string) --

                    The log group associated with the crawl.

                  • LogStream (string) --

                    The log stream associated with the crawl.

        • Edges (list) --

          A list of all the directed connections between the nodes belonging to the workflow.

          • (dict) --

            An edge represents a directed connection between two AWS Glue components which are part of the workflow the edge belongs to.

            • SourceId (string) --

              The unique of the node within the workflow where the edge starts.

            • DestinationId (string) --

              The unique of the node within the workflow where the edge ends.

get_workflow_run(**kwargs)

Retrieves the metadata for a given workflow run.

See also: AWS API Documentation

Request Syntax

response = client.get_workflow_run(
    Name='string',
    RunId='string',
    IncludeGraph=True|False
)
Parameters
  • Name (string) --

    [REQUIRED]

    Name of the workflow being run.

  • RunId (string) --

    [REQUIRED]

    The ID of the workflow run.

  • IncludeGraph (boolean) -- Specifies whether to include the workflow graph in response or not.
Return type

dict

Returns

Response Syntax

{
    'Run': {
        'Name': 'string',
        'WorkflowRunId': 'string',
        'WorkflowRunProperties': {
            'string': 'string'
        },
        'StartedOn': datetime(2015, 1, 1),
        'CompletedOn': datetime(2015, 1, 1),
        'Status': 'RUNNING'|'COMPLETED',
        'Statistics': {
            'TotalActions': 123,
            'TimeoutActions': 123,
            'FailedActions': 123,
            'StoppedActions': 123,
            'SucceededActions': 123,
            'RunningActions': 123
        },
        'Graph': {
            'Nodes': [
                {
                    'Type': 'CRAWLER'|'JOB'|'TRIGGER',
                    'Name': 'string',
                    'UniqueId': 'string',
                    'TriggerDetails': {
                        'Trigger': {
                            'Name': 'string',
                            'WorkflowName': 'string',
                            'Id': 'string',
                            'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND',
                            'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
                            'Description': 'string',
                            'Schedule': 'string',
                            'Actions': [
                                {
                                    'JobName': 'string',
                                    'Arguments': {
                                        'string': 'string'
                                    },
                                    'Timeout': 123,
                                    'SecurityConfiguration': 'string',
                                    'NotificationProperty': {
                                        'NotifyDelayAfter': 123
                                    },
                                    'CrawlerName': 'string'
                                },
                            ],
                            'Predicate': {
                                'Logical': 'AND'|'ANY',
                                'Conditions': [
                                    {
                                        'LogicalOperator': 'EQUALS',
                                        'JobName': 'string',
                                        'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                                        'CrawlerName': 'string',
                                        'CrawlState': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED'
                                    },
                                ]
                            }
                        }
                    },
                    'JobDetails': {
                        'JobRuns': [
                            {
                                'Id': 'string',
                                'Attempt': 123,
                                'PreviousRunId': 'string',
                                'TriggerName': 'string',
                                'JobName': 'string',
                                'StartedOn': datetime(2015, 1, 1),
                                'LastModifiedOn': datetime(2015, 1, 1),
                                'CompletedOn': datetime(2015, 1, 1),
                                'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                                'Arguments': {
                                    'string': 'string'
                                },
                                'ErrorMessage': 'string',
                                'PredecessorRuns': [
                                    {
                                        'JobName': 'string',
                                        'RunId': 'string'
                                    },
                                ],
                                'AllocatedCapacity': 123,
                                'ExecutionTime': 123,
                                'Timeout': 123,
                                'MaxCapacity': 123.0,
                                'WorkerType': 'Standard'|'G.1X'|'G.2X',
                                'NumberOfWorkers': 123,
                                'SecurityConfiguration': 'string',
                                'LogGroupName': 'string',
                                'NotificationProperty': {
                                    'NotifyDelayAfter': 123
                                }
                            },
                        ]
                    },
                    'CrawlerDetails': {
                        'Crawls': [
                            {
                                'State': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED',
                                'StartedOn': datetime(2015, 1, 1),
                                'CompletedOn': datetime(2015, 1, 1),
                                'ErrorMessage': 'string',
                                'LogGroup': 'string',
                                'LogStream': 'string'
                            },
                        ]
                    }
                },
            ],
            'Edges': [
                {
                    'SourceId': 'string',
                    'DestinationId': 'string'
                },
            ]
        }
    }
}

Response Structure

  • (dict) --

    • Run (dict) --

      The requested workflow run metadata.

      • Name (string) --

        Name of the workflow which was executed.

      • WorkflowRunId (string) --

        The ID of this workflow run.

      • WorkflowRunProperties (dict) --

        The workflow run properties which were set during the run.

        • (string) --
          • (string) --
      • StartedOn (datetime) --

        The date and time when the workflow run was started.

      • CompletedOn (datetime) --

        The date and time when the workflow run completed.

      • Status (string) --

        The status of the workflow run.

      • Statistics (dict) --

        The statistics of the run.

        • TotalActions (integer) --

          Total number of Actions in the workflow run.

        • TimeoutActions (integer) --

          Total number of Actions which timed out.

        • FailedActions (integer) --

          Total number of Actions which have failed.

        • StoppedActions (integer) --

          Total number of Actions which have stopped.

        • SucceededActions (integer) --

          Total number of Actions which have succeeded.

        • RunningActions (integer) --

          Total number Actions in running state.

      • Graph (dict) --

        The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.

        • Nodes (list) --

          A list of the the AWS Glue components belong to the workflow represented as nodes.

          • (dict) --

            A node represents an AWS Glue component like Trigger, Job etc. which is part of a workflow.

            • Type (string) --

              The type of AWS Glue component represented by the node.

            • Name (string) --

              The name of the AWS Glue component represented by the node.

            • UniqueId (string) --

              The unique Id assigned to the node within the workflow.

            • TriggerDetails (dict) --

              Details of the Trigger when the node represents a Trigger.

              • Trigger (dict) --

                The information of the trigger represented by the trigger node.

                • Name (string) --

                  The name of the trigger.

                • WorkflowName (string) --

                  The name of the workflow associated with the trigger.

                • Id (string) --

                  Reserved for future use.

                • Type (string) --

                  The type of trigger that this is.

                • State (string) --

                  The current state of the trigger.

                • Description (string) --

                  A description of this trigger.

                • Schedule (string) --

                  A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .

                • Actions (list) --

                  The actions initiated by this trigger.

                  • (dict) --

                    Defines an action to be initiated by a trigger.

                    • JobName (string) --

                      The name of a job to be executed.

                    • Arguments (dict) --

                      The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

                      You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

                      For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

                      For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

                      • (string) --
                        • (string) --
                    • Timeout (integer) --

                      The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

                    • SecurityConfiguration (string) --

                      The name of the SecurityConfiguration structure to be used with this action.

                    • NotificationProperty (dict) --

                      Specifies configuration properties of a job run notification.

                      • NotifyDelayAfter (integer) --

                        After a job run starts, the number of minutes to wait before sending a job run delay notification.

                    • CrawlerName (string) --

                      The name of the crawler to be used with this action.

                • Predicate (dict) --

                  The predicate of this trigger, which defines when it will fire.

                  • Logical (string) --

                    An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

                  • Conditions (list) --

                    A list of the conditions that determine when the trigger will fire.

                    • (dict) --

                      Defines a condition under which a trigger fires.

                      • LogicalOperator (string) --

                        A logical operator.

                      • JobName (string) --

                        The name of the job whose JobRuns this condition applies to, and on which this trigger waits.

                      • State (string) --

                        The condition state. Currently, the values supported are SUCCEEDED , STOPPED , TIMEOUT , and FAILED .

                      • CrawlerName (string) --

                        The name of the crawler to which this condition applies.

                      • CrawlState (string) --

                        The state of the crawler to which this condition applies.

            • JobDetails (dict) --

              Details of the Job when the node represents a Job.

              • JobRuns (list) --

                The information for the job runs represented by the job node.

                • (dict) --

                  Contains information about a job run.

                  • Id (string) --

                    The ID of this job run.

                  • Attempt (integer) --

                    The number of the attempt to run this job.

                  • PreviousRunId (string) --

                    The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

                  • TriggerName (string) --

                    The name of the trigger that started this job run.

                  • JobName (string) --

                    The name of the job definition being used in this run.

                  • StartedOn (datetime) --

                    The date and time at which this job run was started.

                  • LastModifiedOn (datetime) --

                    The last time that this job run was modified.

                  • CompletedOn (datetime) --

                    The date and time that this job run completed.

                  • JobRunState (string) --

                    The current state of the job run.

                  • Arguments (dict) --

                    The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.

                    You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

                    For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

                    For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

                    • (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 was used in the predicate of a conditional trigger that triggered this job run.

                      • JobName (string) --

                        The name of the job definition used by the predecessor job run.

                      • RunId (string) --

                        The job-run ID of the predecessor job run.

                  • AllocatedCapacity (integer) --

                    This field is deprecated. Use MaxCapacity instead.

                    The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

                  • ExecutionTime (integer) --

                    The amount of time (in seconds) that the job run consumed resources.

                  • Timeout (integer) --

                    The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

                  • MaxCapacity (float) --

                    The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

                    Do not set Max Capacity if using WorkerType and NumberOfWorkers .

                    The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

                    • When you specify a Python shell job (JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
                    • When you specify an Apache Spark ETL job (JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
                  • WorkerType (string) --

                    The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

                    • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
                    • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
                    • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
                  • NumberOfWorkers (integer) --

                    The number of workers of a defined workerType that are allocated when a job runs.

                    The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

                  • SecurityConfiguration (string) --

                    The name of the SecurityConfiguration structure to be used with this job run.

                  • LogGroupName (string) --

                    The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using AWS KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.

                  • NotificationProperty (dict) --

                    Specifies configuration properties of a job run notification.

                    • NotifyDelayAfter (integer) --

                      After a job run starts, the number of minutes to wait before sending a job run delay notification.

            • CrawlerDetails (dict) --

              Details of the crawler when the node represents a crawler.

              • Crawls (list) --

                A list of crawls represented by the crawl node.

                • (dict) --

                  The details of a crawl in the workflow.

                  • State (string) --

                    The state of the crawler.

                  • StartedOn (datetime) --

                    The date and time on which the crawl started.

                  • CompletedOn (datetime) --

                    The date and time on which the crawl completed.

                  • ErrorMessage (string) --

                    The error message associated with the crawl.

                  • LogGroup (string) --

                    The log group associated with the crawl.

                  • LogStream (string) --

                    The log stream associated with the crawl.

        • Edges (list) --

          A list of all the directed connections between the nodes belonging to the workflow.

          • (dict) --

            An edge represents a directed connection between two AWS Glue components which are part of the workflow the edge belongs to.

            • SourceId (string) --

              The unique of the node within the workflow where the edge starts.

            • DestinationId (string) --

              The unique of the node within the workflow where the edge ends.

get_workflow_run_properties(**kwargs)

Retrieves the workflow run properties which were set during the run.

See also: AWS API Documentation

Request Syntax

response = client.get_workflow_run_properties(
    Name='string',
    RunId='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

    Name of the workflow which was run.

  • RunId (string) --

    [REQUIRED]

    The ID of the workflow run whose run properties should be returned.

Return type

dict

Returns

Response Syntax

{
    'RunProperties': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • RunProperties (dict) --

      The workflow run properties which were set during the specified run.

      • (string) --
        • (string) --

get_workflow_runs(**kwargs)

Retrieves metadata for all runs of a given workflow.

See also: AWS API Documentation

Request Syntax

response = client.get_workflow_runs(
    Name='string',
    IncludeGraph=True|False,
    NextToken='string',
    MaxResults=123
)
Parameters
  • Name (string) --

    [REQUIRED]

    Name of the workflow whose metadata of runs should be returned.

  • IncludeGraph (boolean) -- Specifies whether to include the workflow graph in response or not.
  • NextToken (string) -- The maximum size of the response.
  • MaxResults (integer) -- The maximum number of workflow runs to be included in the response.
Return type

dict

Returns

Response Syntax

{
    'Runs': [
        {
            'Name': 'string',
            'WorkflowRunId': 'string',
            'WorkflowRunProperties': {
                'string': 'string'
            },
            'StartedOn': datetime(2015, 1, 1),
            'CompletedOn': datetime(2015, 1, 1),
            'Status': 'RUNNING'|'COMPLETED',
            'Statistics': {
                'TotalActions': 123,
                'TimeoutActions': 123,
                'FailedActions': 123,
                'StoppedActions': 123,
                'SucceededActions': 123,
                'RunningActions': 123
            },
            'Graph': {
                'Nodes': [
                    {
                        'Type': 'CRAWLER'|'JOB'|'TRIGGER',
                        'Name': 'string',
                        'UniqueId': 'string',
                        'TriggerDetails': {
                            'Trigger': {
                                'Name': 'string',
                                'WorkflowName': 'string',
                                'Id': 'string',
                                'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND',
                                'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
                                'Description': 'string',
                                'Schedule': 'string',
                                'Actions': [
                                    {
                                        'JobName': 'string',
                                        'Arguments': {
                                            'string': 'string'
                                        },
                                        'Timeout': 123,
                                        'SecurityConfiguration': 'string',
                                        'NotificationProperty': {
                                            'NotifyDelayAfter': 123
                                        },
                                        'CrawlerName': 'string'
                                    },
                                ],
                                'Predicate': {
                                    'Logical': 'AND'|'ANY',
                                    'Conditions': [
                                        {
                                            'LogicalOperator': 'EQUALS',
                                            'JobName': 'string',
                                            'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                                            'CrawlerName': 'string',
                                            'CrawlState': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED'
                                        },
                                    ]
                                }
                            }
                        },
                        'JobDetails': {
                            'JobRuns': [
                                {
                                    'Id': 'string',
                                    'Attempt': 123,
                                    'PreviousRunId': 'string',
                                    'TriggerName': 'string',
                                    'JobName': 'string',
                                    'StartedOn': datetime(2015, 1, 1),
                                    'LastModifiedOn': datetime(2015, 1, 1),
                                    'CompletedOn': datetime(2015, 1, 1),
                                    'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                                    'Arguments': {
                                        'string': 'string'
                                    },
                                    'ErrorMessage': 'string',
                                    'PredecessorRuns': [
                                        {
                                            'JobName': 'string',
                                            'RunId': 'string'
                                        },
                                    ],
                                    'AllocatedCapacity': 123,
                                    'ExecutionTime': 123,
                                    'Timeout': 123,
                                    'MaxCapacity': 123.0,
                                    'WorkerType': 'Standard'|'G.1X'|'G.2X',
                                    'NumberOfWorkers': 123,
                                    'SecurityConfiguration': 'string',
                                    'LogGroupName': 'string',
                                    'NotificationProperty': {
                                        'NotifyDelayAfter': 123
                                    }
                                },
                            ]
                        },
                        'CrawlerDetails': {
                            'Crawls': [
                                {
                                    'State': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED',
                                    'StartedOn': datetime(2015, 1, 1),
                                    'CompletedOn': datetime(2015, 1, 1),
                                    'ErrorMessage': 'string',
                                    'LogGroup': 'string',
                                    'LogStream': 'string'
                                },
                            ]
                        }
                    },
                ],
                'Edges': [
                    {
                        'SourceId': 'string',
                        'DestinationId': 'string'
                    },
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Runs (list) --

      A list of workflow run metadata objects.

      • (dict) --

        A workflow run is an execution of a workflow providing all the runtime information.

        • Name (string) --

          Name of the workflow which was executed.

        • WorkflowRunId (string) --

          The ID of this workflow run.

        • WorkflowRunProperties (dict) --

          The workflow run properties which were set during the run.

          • (string) --
            • (string) --
        • StartedOn (datetime) --

          The date and time when the workflow run was started.

        • CompletedOn (datetime) --

          The date and time when the workflow run completed.

        • Status (string) --

          The status of the workflow run.

        • Statistics (dict) --

          The statistics of the run.

          • TotalActions (integer) --

            Total number of Actions in the workflow run.

          • TimeoutActions (integer) --

            Total number of Actions which timed out.

          • FailedActions (integer) --

            Total number of Actions which have failed.

          • StoppedActions (integer) --

            Total number of Actions which have stopped.

          • SucceededActions (integer) --

            Total number of Actions which have succeeded.

          • RunningActions (integer) --

            Total number Actions in running state.

        • Graph (dict) --

          The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.

          • Nodes (list) --

            A list of the the AWS Glue components belong to the workflow represented as nodes.

            • (dict) --

              A node represents an AWS Glue component like Trigger, Job etc. which is part of a workflow.

              • Type (string) --

                The type of AWS Glue component represented by the node.

              • Name (string) --

                The name of the AWS Glue component represented by the node.

              • UniqueId (string) --

                The unique Id assigned to the node within the workflow.

              • TriggerDetails (dict) --

                Details of the Trigger when the node represents a Trigger.

                • Trigger (dict) --

                  The information of the trigger represented by the trigger node.

                  • Name (string) --

                    The name of the trigger.

                  • WorkflowName (string) --

                    The name of the workflow associated with the trigger.

                  • Id (string) --

                    Reserved for future use.

                  • Type (string) --

                    The type of trigger that this is.

                  • State (string) --

                    The current state of the trigger.

                  • Description (string) --

                    A description of this trigger.

                  • Schedule (string) --

                    A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .

                  • Actions (list) --

                    The actions initiated by this trigger.

                    • (dict) --

                      Defines an action to be initiated by a trigger.

                      • JobName (string) --

                        The name of a job to be executed.

                      • Arguments (dict) --

                        The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

                        You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

                        For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

                        For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

                        • (string) --
                          • (string) --
                      • Timeout (integer) --

                        The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

                      • SecurityConfiguration (string) --

                        The name of the SecurityConfiguration structure to be used with this action.

                      • NotificationProperty (dict) --

                        Specifies configuration properties of a job run notification.

                        • NotifyDelayAfter (integer) --

                          After a job run starts, the number of minutes to wait before sending a job run delay notification.

                      • CrawlerName (string) --

                        The name of the crawler to be used with this action.

                  • Predicate (dict) --

                    The predicate of this trigger, which defines when it will fire.

                    • Logical (string) --

                      An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

                    • Conditions (list) --

                      A list of the conditions that determine when the trigger will fire.

                      • (dict) --

                        Defines a condition under which a trigger fires.

                        • LogicalOperator (string) --

                          A logical operator.

                        • JobName (string) --

                          The name of the job whose JobRuns this condition applies to, and on which this trigger waits.

                        • State (string) --

                          The condition state. Currently, the values supported are SUCCEEDED , STOPPED , TIMEOUT , and FAILED .

                        • CrawlerName (string) --

                          The name of the crawler to which this condition applies.

                        • CrawlState (string) --

                          The state of the crawler to which this condition applies.

              • JobDetails (dict) --

                Details of the Job when the node represents a Job.

                • JobRuns (list) --

                  The information for the job runs represented by the job node.

                  • (dict) --

                    Contains information about a job run.

                    • Id (string) --

                      The ID of this job run.

                    • Attempt (integer) --

                      The number of the attempt to run this job.

                    • PreviousRunId (string) --

                      The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

                    • TriggerName (string) --

                      The name of the trigger that started this job run.

                    • JobName (string) --

                      The name of the job definition being used in this run.

                    • StartedOn (datetime) --

                      The date and time at which this job run was started.

                    • LastModifiedOn (datetime) --

                      The last time that this job run was modified.

                    • CompletedOn (datetime) --

                      The date and time that this job run completed.

                    • JobRunState (string) --

                      The current state of the job run.

                    • Arguments (dict) --

                      The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.

                      You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

                      For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

                      For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

                      • (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 was used in the predicate of a conditional trigger that triggered this job run.

                        • JobName (string) --

                          The name of the job definition used by the predecessor job run.

                        • RunId (string) --

                          The job-run ID of the predecessor job run.

                    • AllocatedCapacity (integer) --

                      This field is deprecated. Use MaxCapacity instead.

                      The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

                    • ExecutionTime (integer) --

                      The amount of time (in seconds) that the job run consumed resources.

                    • Timeout (integer) --

                      The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

                    • MaxCapacity (float) --

                      The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

                      Do not set Max Capacity if using WorkerType and NumberOfWorkers .

                      The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

                      • When you specify a Python shell job (JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
                      • When you specify an Apache Spark ETL job (JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
                    • WorkerType (string) --

                      The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

                      • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
                      • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
                      • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
                    • NumberOfWorkers (integer) --

                      The number of workers of a defined workerType that are allocated when a job runs.

                      The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

                    • SecurityConfiguration (string) --

                      The name of the SecurityConfiguration structure to be used with this job run.

                    • LogGroupName (string) --

                      The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using AWS KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration is used to encrypt the log group.

                    • NotificationProperty (dict) --

                      Specifies configuration properties of a job run notification.

                      • NotifyDelayAfter (integer) --

                        After a job run starts, the number of minutes to wait before sending a job run delay notification.

              • CrawlerDetails (dict) --

                Details of the crawler when the node represents a crawler.

                • Crawls (list) --

                  A list of crawls represented by the crawl node.

                  • (dict) --

                    The details of a crawl in the workflow.

                    • State (string) --

                      The state of the crawler.

                    • StartedOn (datetime) --

                      The date and time on which the crawl started.

                    • CompletedOn (datetime) --

                      The date and time on which the crawl completed.

                    • ErrorMessage (string) --

                      The error message associated with the crawl.

                    • LogGroup (string) --

                      The log group associated with the crawl.

                    • LogStream (string) --

                      The log stream associated with the crawl.

          • Edges (list) --

            A list of all the directed connections between the nodes belonging to the workflow.

            • (dict) --

              An edge represents a directed connection between two AWS Glue components which are part of the workflow the edge belongs to.

              • SourceId (string) --

                The unique of the node within the workflow where the edge starts.

              • DestinationId (string) --

                The unique of the node within the workflow where the edge ends.

    • NextToken (string) --

      A continuation token, if not all requested workflow runs have been returned.

import_catalog_to_glue(**kwargs)

Imports an existing Athena Data Catalog to AWS Glue

See also: AWS API Documentation

Request Syntax

response = client.import_catalog_to_glue(
    CatalogId='string'
)
Parameters
CatalogId (string) -- The ID of the catalog to import. Currently, this should be the AWS account ID.
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
list_crawlers(**kwargs)

Retrieves the names of all crawler resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

See also: AWS API Documentation

Request Syntax

response = client.list_crawlers(
    MaxResults=123,
    NextToken='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • MaxResults (integer) -- The maximum size of a list to return.
  • NextToken (string) -- A continuation token, if this is a continuation request.
  • Tags (dict) --

    Specifies to return only these tagged resources.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'CrawlerNames': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CrawlerNames (list) --

      The names of all crawlers in the account, or the crawlers with the specified tags.

      • (string) --
    • NextToken (string) --

      A continuation token, if the returned list does not contain the last metric available.

list_dev_endpoints(**kwargs)

Retrieves the names of all DevEndpoint resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

See also: AWS API Documentation

Request Syntax

response = client.list_dev_endpoints(
    NextToken='string',
    MaxResults=123,
    Tags={
        'string': 'string'
    }
)
Parameters
  • NextToken (string) -- A continuation token, if this is a continuation request.
  • MaxResults (integer) -- The maximum size of a list to return.
  • Tags (dict) --

    Specifies to return only these tagged resources.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'DevEndpointNames': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • DevEndpointNames (list) --

      The names of all the DevEndpoint s in the account, or the DevEndpoint s with the specified tags.

      • (string) --
    • NextToken (string) --

      A continuation token, if the returned list does not contain the last metric available.

list_jobs(**kwargs)

Retrieves the names of all job resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

See also: AWS API Documentation

Request Syntax

response = client.list_jobs(
    NextToken='string',
    MaxResults=123,
    Tags={
        'string': 'string'
    }
)
Parameters
  • NextToken (string) -- A continuation token, if this is a continuation request.
  • MaxResults (integer) -- The maximum size of a list to return.
  • Tags (dict) --

    Specifies to return only these tagged resources.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'JobNames': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • JobNames (list) --

      The names of all jobs in the account, or the jobs with the specified tags.

      • (string) --
    • NextToken (string) --

      A continuation token, if the returned list does not contain the last metric available.

list_triggers(**kwargs)

Retrieves the names of all trigger resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

See also: AWS API Documentation

Request Syntax

response = client.list_triggers(
    NextToken='string',
    DependentJobName='string',
    MaxResults=123,
    Tags={
        'string': 'string'
    }
)
Parameters
  • NextToken (string) -- A continuation token, if this is a continuation request.
  • DependentJobName (string) -- The name of the job for which to retrieve triggers. The trigger that can start this job is returned. If there is no such trigger, all triggers are returned.
  • MaxResults (integer) -- The maximum size of a list to return.
  • Tags (dict) --

    Specifies to return only these tagged resources.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'TriggerNames': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • TriggerNames (list) --

      The names of all triggers in the account, or the triggers with the specified tags.

      • (string) --
    • NextToken (string) --

      A continuation token, if the returned list does not contain the last metric available.

list_workflows(**kwargs)

Lists names of workflows created in the account.

See also: AWS API Documentation

Request Syntax

response = client.list_workflows(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- A continuation token, if this is a continuation request.
  • MaxResults (integer) -- The maximum size of a list to return.
Return type

dict

Returns

Response Syntax

{
    'Workflows': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Workflows (list) --

      List of names of workflows in the account.

      • (string) --
    • NextToken (string) --

      A continuation token, if not all workflow names have been returned.

put_data_catalog_encryption_settings(**kwargs)

Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter.

See also: AWS API Documentation

Request Syntax

response = client.put_data_catalog_encryption_settings(
    CatalogId='string',
    DataCatalogEncryptionSettings={
        'EncryptionAtRest': {
            'CatalogEncryptionMode': 'DISABLED'|'SSE-KMS',
            'SseAwsKmsKeyId': 'string'
        },
        'ConnectionPasswordEncryption': {
            'ReturnConnectionPasswordEncrypted': True|False,
            'AwsKmsKeyId': 'string'
        }
    }
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog for which to set the security configuration. If none is provided, the AWS account ID is used by default.
  • DataCatalogEncryptionSettings (dict) --

    [REQUIRED]

    The security configuration to set.

    • EncryptionAtRest (dict) --

      Specifies the encryption-at-rest configuration for the Data Catalog.

      • CatalogEncryptionMode (string) -- [REQUIRED]

        The encryption-at-rest mode for encrypting Data Catalog data.

      • SseAwsKmsKeyId (string) --

        The ID of the AWS KMS key to use for encryption at rest.

    • ConnectionPasswordEncryption (dict) --

      When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption.

      • ReturnConnectionPasswordEncrypted (boolean) -- [REQUIRED]

        When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords remain encrypted in the responses of GetConnection and GetConnections . This encryption takes effect independently from catalog encryption.

      • AwsKmsKeyId (string) --

        An AWS KMS key that is used to encrypt the connection password.

        If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog.

        You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

put_resource_policy(**kwargs)

Sets the Data Catalog resource policy for access control.

See also: AWS API Documentation

Request Syntax

response = client.put_resource_policy(
    PolicyInJson='string',
    PolicyHashCondition='string',
    PolicyExistsCondition='MUST_EXIST'|'NOT_EXIST'|'NONE'
)
Parameters
  • PolicyInJson (string) --

    [REQUIRED]

    Contains the policy document to set, in JSON format.

  • PolicyHashCondition (string) -- The hash value returned when the previous policy was set using PutResourcePolicy . Its purpose is to prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set.
  • PolicyExistsCondition (string) -- A value of MUST_EXIST is used to update a policy. A value of NOT_EXIST is used to create a new policy. If a value of NONE or a null value is used, the call will not depend on the existence of a policy.
Return type

dict

Returns

Response Syntax

{
    'PolicyHash': 'string'
}

Response Structure

  • (dict) --

    • PolicyHash (string) --

      A hash of the policy that has just been set. This must be included in a subsequent call that overwrites or updates this policy.

put_workflow_run_properties(**kwargs)

Puts the specified workflow run properties for the given workflow run. If a property already exists for the specified run, then it overrides the value otherwise adds the property to existing properties.

See also: AWS API Documentation

Request Syntax

response = client.put_workflow_run_properties(
    Name='string',
    RunId='string',
    RunProperties={
        'string': 'string'
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

    Name of the workflow which was run.

  • RunId (string) --

    [REQUIRED]

    The ID of the workflow run for which the run properties should be updated.

  • RunProperties (dict) --

    [REQUIRED]

    The properties to put for the specified run.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

reset_job_bookmark(**kwargs)

Resets a bookmark entry.

See also: AWS API Documentation

Request Syntax

response = client.reset_job_bookmark(
    JobName='string'
)
Parameters
JobName (string) --

[REQUIRED]

The name of the job in question.

Return type
dict
Returns
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.

start_crawler(**kwargs)

Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException .

See also: AWS API Documentation

Request Syntax

response = client.start_crawler(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

Name of the crawler to start.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
start_crawler_schedule(**kwargs)

Changes the schedule state of the specified crawler to SCHEDULED , unless the crawler is already running or the schedule state is already SCHEDULED .

See also: AWS API Documentation

Request Syntax

response = client.start_crawler_schedule(
    CrawlerName='string'
)
Parameters
CrawlerName (string) --

[REQUIRED]

Name of the crawler to schedule.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
start_job_run(**kwargs)

Starts a job run using a job definition.

See also: AWS API Documentation

Request Syntax

response = client.start_job_run(
    JobName='string',
    JobRunId='string',
    Arguments={
        'string': 'string'
    },
    AllocatedCapacity=123,
    Timeout=123,
    MaxCapacity=123.0,
    SecurityConfiguration='string',
    NotificationProperty={
        'NotifyDelayAfter': 123
    },
    WorkerType='string',
    NumberOfWorkers=123
)
Parameters
  • JobName (string) --

    [REQUIRED]

    The name of the job definition to use.

  • JobRunId (string) -- The ID of a previous JobRun to retry.
  • Arguments (dict) --

    The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

    You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

    For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

    For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

    • (string) --
      • (string) --
  • AllocatedCapacity (integer) --

    This field is deprecated. Use MaxCapacity instead.

    The number of AWS Glue data processing units (DPUs) to allocate to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

  • Timeout (integer) -- The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
  • MaxCapacity (float) --

    The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

    Do not set Max Capacity if using WorkerType and NumberOfWorkers .

    The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, or an Apache Spark ETL job:

    • When you specify a Python shell job (JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
    • When you specify an Apache Spark ETL job (JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
  • SecurityConfiguration (string) -- The name of the SecurityConfiguration structure to be used with this job run.
  • NotificationProperty (dict) --

    Specifies configuration properties of a job run notification.

    • NotifyDelayAfter (integer) --

      After a job run starts, the number of minutes to wait before sending a job run delay notification.

  • WorkerType (string) --

    The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

    • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
    • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
    • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
  • NumberOfWorkers (integer) --

    The number of workers of a defined workerType that are allocated when a job runs.

    The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

Return type

dict

Returns

Response Syntax

{
    'JobRunId': 'string'
}

Response Structure

  • (dict) --

    • JobRunId (string) --

      The ID assigned to this job run.

start_trigger(**kwargs)

Starts an existing trigger. See Triggering Jobs for information about how different types of trigger are started.

See also: AWS API Documentation

Request Syntax

response = client.start_trigger(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the trigger to start.

Return type
dict
Returns
Response Syntax
{
    'Name': 'string'
}

Response Structure

  • (dict) --
    • Name (string) --

      The name of the trigger that was started.

start_workflow_run(**kwargs)

Starts a new run of the specified workflow.

See also: AWS API Documentation

Request Syntax

response = client.start_workflow_run(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the workflow to start.

Return type
dict
Returns
Response Syntax
{
    'RunId': 'string'
}

Response Structure

  • (dict) --
    • RunId (string) --

      An Id for the new run.

stop_crawler(**kwargs)

If the specified crawler is running, stops the crawl.

See also: AWS API Documentation

Request Syntax

response = client.stop_crawler(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

Name of the crawler to stop.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
stop_crawler_schedule(**kwargs)

Sets the schedule state of the specified crawler to NOT_SCHEDULED , but does not stop the crawler if it is already running.

See also: AWS API Documentation

Request Syntax

response = client.stop_crawler_schedule(
    CrawlerName='string'
)
Parameters
CrawlerName (string) --

[REQUIRED]

Name of the crawler whose schedule state to set.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
stop_trigger(**kwargs)

Stops a specified trigger.

See also: AWS API Documentation

Request Syntax

response = client.stop_trigger(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the trigger to stop.

Return type
dict
Returns
Response Syntax
{
    'Name': 'string'
}

Response Structure

  • (dict) --
    • Name (string) --

      The name of the trigger that was stopped.

tag_resource(**kwargs)

Adds tags to a resource. A tag is a label you can assign to an AWS resource. In AWS Glue, you can tag only certain resources. For information about what resources you can tag, see AWS Tags in AWS Glue .

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    TagsToAdd={
        'string': 'string'
    }
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The ARN of the AWS Glue resource to which to add the tags. For more information about AWS Glue resource ARNs, see the AWS Glue ARN string pattern .

  • TagsToAdd (dict) --

    [REQUIRED]

    Tags to add to this resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

untag_resource(**kwargs)

Removes tags from a resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagsToRemove=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource from which to remove the tags.

  • TagsToRemove (list) --

    [REQUIRED]

    Tags to remove from this resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_classifier(**kwargs)

Modifies an existing classifier (a GrokClassifier , an XMLClassifier , a JsonClassifier , or a CsvClassifier , depending on which field is present).

See also: AWS API Documentation

Request Syntax

response = client.update_classifier(
    GrokClassifier={
        'Name': 'string',
        'Classification': 'string',
        'GrokPattern': 'string',
        'CustomPatterns': 'string'
    },
    XMLClassifier={
        'Name': 'string',
        'Classification': 'string',
        'RowTag': 'string'
    },
    JsonClassifier={
        'Name': 'string',
        'JsonPath': 'string'
    },
    CsvClassifier={
        'Name': 'string',
        'Delimiter': 'string',
        'QuoteSymbol': 'string',
        'ContainsHeader': 'UNKNOWN'|'PRESENT'|'ABSENT',
        'Header': [
            'string',
        ],
        'DisableValueTrimming': True|False,
        'AllowSingleColumn': True|False
    }
)
Parameters
  • GrokClassifier (dict) --

    A GrokClassifier object with updated fields.

    • Name (string) -- [REQUIRED]

      The name of the GrokClassifier .

    • Classification (string) --

      An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.

    • GrokPattern (string) --

      The grok pattern used by this classifier.

    • CustomPatterns (string) --

      Optional custom grok patterns used by this classifier.

  • XMLClassifier (dict) --

    An XMLClassifier object with updated fields.

    • Name (string) -- [REQUIRED]

      The name of the classifier.

    • Classification (string) --

      An identifier of the data format that the classifier matches.

    • RowTag (string) --

      The XML tag designating the element that contains each record in an XML document being parsed. This cannot identify a self-closing element (closed by /> ). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).

  • JsonClassifier (dict) --

    A JsonClassifier object with updated fields.

    • Name (string) -- [REQUIRED]

      The name of the classifier.

    • JsonPath (string) --

      A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath , as described in Writing JsonPath Custom Classifiers .

  • CsvClassifier (dict) --

    A CsvClassifier object with updated fields.

    • Name (string) -- [REQUIRED]

      The name of the classifier.

    • Delimiter (string) --

      A custom symbol to denote what separates each column entry in the row.

    • QuoteSymbol (string) --

      A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.

    • ContainsHeader (string) --

      Indicates whether the CSV file contains a header.

    • Header (list) --

      A list of strings representing column names.

      • (string) --
    • DisableValueTrimming (boolean) --

      Specifies not to trim values before identifying the type of column values. The default value is true.

    • AllowSingleColumn (boolean) --

      Enables the processing of files that contain only one column.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_connection(**kwargs)

Updates a connection definition in the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.update_connection(
    CatalogId='string',
    Name='string',
    ConnectionInput={
        'Name': 'string',
        'Description': 'string',
        'ConnectionType': 'JDBC'|'SFTP',
        'MatchCriteria': [
            'string',
        ],
        'ConnectionProperties': {
            'string': 'string'
        },
        'PhysicalConnectionRequirements': {
            'SubnetId': 'string',
            'SecurityGroupIdList': [
                'string',
            ],
            'AvailabilityZone': 'string'
        }
    }
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default.
  • Name (string) --

    [REQUIRED]

    The name of the connection definition to update.

  • ConnectionInput (dict) --

    [REQUIRED]

    A ConnectionInput object that redefines the connection in question.

    • Name (string) -- [REQUIRED]

      The name of the connection.

    • Description (string) --

      The description of the connection.

    • ConnectionType (string) -- [REQUIRED]

      The type of the connection. Currently, only JDBC is supported; SFTP is not supported.

    • MatchCriteria (list) --

      A list of criteria that can be used in selecting this connection.

      • (string) --
    • ConnectionProperties (dict) -- [REQUIRED]

      These key-value pairs define parameters for the connection.

      • (string) --
        • (string) --
    • PhysicalConnectionRequirements (dict) --

      A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to successfully make this connection.

      • 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. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_crawler(**kwargs)

Updates a crawler. If a crawler is running, you must stop it using StopCrawler before updating it.

See also: AWS API Documentation

Request Syntax

response = client.update_crawler(
    Name='string',
    Role='string',
    DatabaseName='string',
    Description='string',
    Targets={
        'S3Targets': [
            {
                'Path': 'string',
                'Exclusions': [
                    'string',
                ]
            },
        ],
        'JdbcTargets': [
            {
                'ConnectionName': 'string',
                'Path': 'string',
                'Exclusions': [
                    'string',
                ]
            },
        ],
        'DynamoDBTargets': [
            {
                'Path': 'string'
            },
        ],
        'CatalogTargets': [
            {
                'DatabaseName': 'string',
                'Tables': [
                    'string',
                ]
            },
        ]
    },
    Schedule='string',
    Classifiers=[
        'string',
    ],
    TablePrefix='string',
    SchemaChangePolicy={
        'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
        'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
    },
    Configuration='string',
    CrawlerSecurityConfiguration='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

    Name of the new crawler.

  • Role (string) -- The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.
  • DatabaseName (string) -- The AWS Glue database where results are stored, such as: arn:aws:daylight:us-east-1::database/sometable/* .
  • Description (string) -- A description of the new crawler.
  • Targets (dict) --

    A list of targets to crawl.

    • S3Targets (list) --

      Specifies Amazon Simple Storage Service (Amazon S3) targets.

      • (dict) --

        Specifies a data store in Amazon Simple Storage Service (Amazon S3).

        • Path (string) --

          The path to the Amazon S3 target.

        • Exclusions (list) --

          A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .

          • (string) --
    • JdbcTargets (list) --

      Specifies JDBC targets.

      • (dict) --

        Specifies a JDBC data store to crawl.

        • ConnectionName (string) --

          The name of the connection to use to connect to the JDBC target.

        • Path (string) --

          The path of the JDBC target.

        • Exclusions (list) --

          A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .

          • (string) --
    • DynamoDBTargets (list) --

      Specifies Amazon DynamoDB targets.

      • (dict) --

        Specifies an Amazon DynamoDB table to crawl.

        • Path (string) --

          The name of the DynamoDB table to crawl.

    • CatalogTargets (list) --

      Specifies AWS Glue Data Catalog targets.

      • (dict) --

        Specifies an AWS Glue Data Catalog target.

        • DatabaseName (string) -- [REQUIRED]

          The name of the database to be synchronized.

        • Tables (list) -- [REQUIRED]

          A list of the tables to be synchronized.

          • (string) --
  • Schedule (string) -- A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *) .
  • Classifiers (list) --

    A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.

    • (string) --
  • TablePrefix (string) -- The table prefix used for catalog tables that are created.
  • SchemaChangePolicy (dict) --

    The policy for the crawler's update and deletion behavior.

    • UpdateBehavior (string) --

      The update behavior when the crawler finds a changed schema.

    • DeleteBehavior (string) --

      The deletion behavior when the crawler finds a deleted object.

  • Configuration (string) -- The crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler .
  • CrawlerSecurityConfiguration (string) -- The name of the SecurityConfiguration structure to be used by this crawler.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_crawler_schedule(**kwargs)

Updates the schedule of a crawler using a cron expression.

See also: AWS API Documentation

Request Syntax

response = client.update_crawler_schedule(
    CrawlerName='string',
    Schedule='string'
)
Parameters
  • CrawlerName (string) --

    [REQUIRED]

    The name of the crawler whose schedule to update.

  • Schedule (string) -- The updated cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *) .
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_database(**kwargs)

Updates an existing database definition in a Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.update_database(
    CatalogId='string',
    Name='string',
    DatabaseInput={
        'Name': 'string',
        'Description': 'string',
        'LocationUri': 'string',
        'Parameters': {
            'string': 'string'
        }
    }
)
Parameters
  • CatalogId (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.
  • Name (string) --

    [REQUIRED]

    The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.

  • DatabaseInput (dict) --

    [REQUIRED]

    A DatabaseInput object specifying the new definition of the metadata database in the catalog.

    • Name (string) -- [REQUIRED]

      Name of the database. For Hive compatibility, this is folded to lowercase when it is stored.

    • Description (string) --

      Description of the database

    • LocationUri (string) --

      The location of the database (for example, an HDFS path).

    • Parameters (dict) --

      Thes key-value pairs define parameters and properties of the database.

      • (string) --
        • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_dev_endpoint(**kwargs)

Updates a specified DevEndpoint.

See also: AWS API Documentation

Request Syntax

response = client.update_dev_endpoint(
    EndpointName='string',
    PublicKey='string',
    AddPublicKeys=[
        'string',
    ],
    DeletePublicKeys=[
        'string',
    ],
    CustomLibraries={
        'ExtraPythonLibsS3Path': 'string',
        'ExtraJarsS3Path': 'string'
    },
    UpdateEtlLibraries=True|False,
    DeleteArguments=[
        'string',
    ],
    AddArguments={
        'string': 'string'
    }
)
Parameters
  • EndpointName (string) --

    [REQUIRED]

    The name of the DevEndpoint to be updated.

  • PublicKey (string) -- The public key for the DevEndpoint to use.
  • AddPublicKeys (list) --

    The list of public keys for the DevEndpoint to use.

    • (string) --
  • DeletePublicKeys (list) --

    The list of public keys to be deleted from the DevEndpoint.

    • (string) --
  • CustomLibraries (dict) --

    Custom Python or Java libraries to be loaded in the DevEndpoint.

    • ExtraPythonLibsS3Path (string) --

      Path(s) to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

      Please note that only pure Python libraries can currently be used on a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.

    • ExtraJarsS3Path (string) --

      Path to one or more Java Jars in an S3 bucket that should be loaded in your DevEndpoint.

      Please note that only pure Java/Scala libraries can currently be used on a DevEndpoint.

  • UpdateEtlLibraries (boolean) -- True if the list of custom libraries to be loaded in the development endpoint needs to be updated, or False otherwise.
  • DeleteArguments (list) --

    The list of argument keys to be deleted from the map of arguments used to configure the DevEndpoint.

    • (string) --
  • AddArguments (dict) --

    The map of arguments to add the map of arguments used to configure the DevEndpoint.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_job(**kwargs)

Updates an existing job definition.

See also: AWS API Documentation

Request Syntax

response = client.update_job(
    JobName='string',
    JobUpdate={
        'Description': 'string',
        'LogUri': 'string',
        'Role': 'string',
        'ExecutionProperty': {
            'MaxConcurrentRuns': 123
        },
        'Command': {
            'Name': 'string',
            'ScriptLocation': 'string',
            'PythonVersion': 'string'
        },
        'DefaultArguments': {
            'string': 'string'
        },
        'Connections': {
            'Connections': [
                'string',
            ]
        },
        'MaxRetries': 123,
        'AllocatedCapacity': 123,
        'Timeout': 123,
        'MaxCapacity': 123.0,
        'WorkerType': 'Standard'|'G.1X'|'G.2X',
        'NumberOfWorkers': 123,
        'SecurityConfiguration': 'string',
        'NotificationProperty': {
            'NotifyDelayAfter': 123
        }
    }
)
Parameters
  • JobName (string) --

    [REQUIRED]

    The name of the job definition to update.

  • JobUpdate (dict) --

    [REQUIRED]

    Specifies the values with which to update the job definition.

    • Description (string) --

      Description of the job being defined.

    • LogUri (string) --

      This field is reserved for future use.

    • Role (string) --

      The name or Amazon Resource Name (ARN) of the IAM role associated with this job (required).

    • ExecutionProperty (dict) --

      An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

      • MaxConcurrentRuns (integer) --

        The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

    • Command (dict) --

      The JobCommand that executes this job (required).

      • Name (string) --

        The name of the job command. For an Apache Spark ETL job, this must be glueetl . For a Python shell job, it must be pythonshell .

      • ScriptLocation (string) --

        Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that executes a job.

      • PythonVersion (string) --

        The Python version being used to execute a Python shell job. Allowed values are 2 or 3.

    • DefaultArguments (dict) --

      The default arguments for this job.

      You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

      For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

      For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

      • (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) --

      This field is deprecated. Use MaxCapacity instead.

      The number of AWS Glue data processing units (DPUs) to allocate to this job. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

    • Timeout (integer) --

      The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

    • MaxCapacity (float) --

      The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

      Do not set Max Capacity if using WorkerType and NumberOfWorkers .

      The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

      • When you specify a Python shell job (JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
      • When you specify an Apache Spark ETL job (JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
    • WorkerType (string) --

      The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

      • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
      • For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
      • For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
    • NumberOfWorkers (integer) --

      The number of workers of a defined workerType that are allocated when a job runs.

      The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

    • SecurityConfiguration (string) --

      The name of the SecurityConfiguration structure to be used with this job.

    • NotificationProperty (dict) --

      Specifies the configuration properties of a job notification.

      • NotifyDelayAfter (integer) --

        After a job run starts, the number of minutes to wait before sending a job run delay notification.

Return type

dict

Returns

Response Syntax

{
    'JobName': 'string'
}

Response Structure

  • (dict) --

    • JobName (string) --

      Returns the name of the updated job definition.

update_partition(**kwargs)

Updates a partition.

See also: AWS API Documentation

Request Syntax

response = client.update_partition(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    PartitionValueList=[
        'string',
    ],
    PartitionInput={
        'Values': [
            'string',
        ],
        'LastAccessTime': datetime(2015, 1, 1),
        'StorageDescriptor': {
            'Columns': [
                {
                    'Name': 'string',
                    'Type': 'string',
                    'Comment': 'string'
                },
            ],
            '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)
    }
)
Parameters
  • CatalogId (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.
  • DatabaseName (string) --

    [REQUIRED]

    The name of the catalog database in which the table in question resides.

  • TableName (string) --

    [REQUIRED]

    The name of the table where the partition to be updated is located.

  • PartitionValueList (list) --

    [REQUIRED]

    A list of the values defining the partition.

    • (string) --
  • PartitionInput (dict) --

    [REQUIRED]

    The new partition object to which to update the partition.

    • Values (list) --

      The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.

      • (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) --

          These key-value pairs define initialization parameters for the SerDe.

          • (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) --

      These key-value pairs define partition parameters.

      • (string) --
        • (string) --
    • LastAnalyzedTime (datetime) --

      The last time at which column statistics were computed for this partition.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_table(**kwargs)

Updates a metadata table in the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.update_table(
    CatalogId='string',
    DatabaseName='string',
    TableInput={
        'Name': 'string',
        'Description': 'string',
        'Owner': 'string',
        'LastAccessTime': datetime(2015, 1, 1),
        'LastAnalyzedTime': datetime(2015, 1, 1),
        'Retention': 123,
        'StorageDescriptor': {
            'Columns': [
                {
                    'Name': 'string',
                    'Type': 'string',
                    'Comment': 'string'
                },
            ],
            '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'
        }
    },
    SkipArchive=True|False
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default.
  • DatabaseName (string) --

    [REQUIRED]

    The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.

  • TableInput (dict) --

    [REQUIRED]

    An updated TableInput object to define the metadata table in the catalog.

    • Name (string) -- [REQUIRED]

      Name of the table. For Hive compatibility, this is folded to lowercase when it is stored.

    • 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