Glue

Table of Contents

Client

class Glue.Client

A low-level client representing AWS Glue

Defines the public endpoint for the Glue service.

import boto3

client = boto3.client('glue')

These are the available methods:

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',
                        'Parameters': {
                            'string': 'string'
                        }
                    },
                ],
                'Location': 'string',
                'AdditionalLocations': [
                    'string',
                ],
                'InputFormat': 'string',
                'OutputFormat': 'string',
                'Compressed': True|False,
                'NumberOfBuckets': 123,
                'SerdeInfo': {
                    'Name': 'string',
                    'SerializationLibrary': 'string',
                    'Parameters': {
                        'string': 'string'
                    }
                },
                'BucketColumns': [
                    'string',
                ],
                'SortColumns': [
                    {
                        'Column': 'string',
                        'SortOrder': 123
                    },
                ],
                'Parameters': {
                    'string': 'string'
                },
                'SkewedInfo': {
                    'SkewedColumnNames': [
                        'string',
                    ],
                    'SkewedColumnValues': [
                        'string',
                    ],
                    'SkewedColumnValueLocationMaps': {
                        'string': 'string'
                    }
                },
                'StoredAsSubDirectories': True|False,
                'SchemaReference': {
                    'SchemaId': {
                        'SchemaArn': 'string',
                        'SchemaName': 'string',
                        'RegistryName': 'string'
                    },
                    'SchemaVersionId': 'string',
                    'SchemaVersionNumber': 123
                }
            },
            'Parameters': {
                'string': 'string'
            },
            'LastAnalyzedTime': datetime(2015, 1, 1)
        },
    ]
)
Parameters
  • CatalogId (string) -- The ID of the catalog in which the partition is to be created. Currently, this should be the Amazon Web Services 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 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.

        The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.

        • (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 data type of the Column .

            • Comment (string) --

              A free-form text comment.

            • Parameters (dict) --

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

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

        • AdditionalLocations (list) --

          A list of locations that point to the path where a Delta table is located.

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

          The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.

        • OutputFormat (string) --

          The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.

        • Compressed (boolean) --
          True if the data in the table is compressed, or False if not.
        • NumberOfBuckets (integer) --

          Must be specified if the table contains any dimension columns.

        • SerdeInfo (dict) --

          The serialization/deserialization (SerDe) information.

          • Name (string) --

            Name of the SerDe.

          • SerializationLibrary (string) --

            Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .

          • Parameters (dict) --

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

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

          The user-supplied properties in key-value form.

          • (string) --
            • (string) --
        • SkewedInfo (dict) --

          The information about values that appear frequently in a column (skewed values).

          • SkewedColumnNames (list) --

            A list of names of columns that contain skewed values.

            • (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.
        • SchemaReference (dict) --

          An object that references a schema stored in the Glue Schema Registry.

          When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

          • SchemaId (dict) --

            A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.

            • SchemaArn (string) --

              The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.

            • SchemaName (string) --

              The name of the schema. One of SchemaArn or SchemaName has to be provided.

            • RegistryName (string) --

              The name of the schema registry that contains the schema.

          • SchemaVersionId (string) --

            The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.

          • SchemaVersionNumber (integer) --

            The version number of the schema.

      • Parameters (dict) --

        These key-value pairs define partition parameters.

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

      The errors encountered when trying to create the requested partitions.

      • (dict) --

        Contains information about a partition error.

        • PartitionValues (list) --

          The values that define the partition.

          • (string) --
        • ErrorDetail (dict) --

          The details about the partition error.

          • ErrorCode (string) --

            The code associated with this error.

          • ErrorMessage (string) --

            A message describing the error.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.GlueEncryptionException
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 Amazon Web Services 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.

Exceptions

  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
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 provided, the Amazon Web Services 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 that contains the partitions to be deleted.

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

      The errors encountered when trying to delete the requested partitions.

      • (dict) --

        Contains information about a partition error.

        • PartitionValues (list) --

          The values that define the partition.

          • (string) --
        • ErrorDetail (dict) --

          The details about the partition error.

          • ErrorCode (string) --

            The code associated with this error.

          • ErrorMessage (string) --

            A message describing the error.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
batch_delete_table(**kwargs)

Deletes multiple tables at once.

Note

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

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

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

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

  • TablesToDelete (list) --

    [REQUIRED]

    A list of the table to delete.

    • (string) --
  • TransactionId (string) -- The transaction ID at which to delete the table contents.
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) --

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

        • ErrorDetail (dict) --

          The details about the error.

          • ErrorCode (string) --

            The code associated with this error.

          • ErrorMessage (string) --

            A message describing the error.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.GlueEncryptionException
  • Glue.Client.exceptions.ResourceNotReadyException
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 provided, the Amazon Web Services 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) --

          The details about the error.

          • ErrorCode (string) --

            The code associated with this error.

          • ErrorMessage (string) --

            A message describing the error.

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
batch_get_blueprints(**kwargs)

Retrieves information about a list of blueprints.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_blueprints(
    Names=[
        'string',
    ],
    IncludeBlueprint=True|False,
    IncludeParameterSpec=True|False
)
Parameters
  • Names (list) --

    [REQUIRED]

    A list of blueprint names.

    • (string) --
  • IncludeBlueprint (boolean) -- Specifies whether or not to include the blueprint in the response.
  • IncludeParameterSpec (boolean) -- Specifies whether or not to include the parameters, as a JSON string, for the blueprint in the response.
Return type

dict

Returns

Response Syntax

{
    'Blueprints': [
        {
            'Name': 'string',
            'Description': 'string',
            'CreatedOn': datetime(2015, 1, 1),
            'LastModifiedOn': datetime(2015, 1, 1),
            'ParameterSpec': 'string',
            'BlueprintLocation': 'string',
            'BlueprintServiceLocation': 'string',
            'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'FAILED',
            'ErrorMessage': 'string',
            'LastActiveDefinition': {
                'Description': 'string',
                'LastModifiedOn': datetime(2015, 1, 1),
                'ParameterSpec': 'string',
                'BlueprintLocation': 'string',
                'BlueprintServiceLocation': 'string'
            }
        },
    ],
    'MissingBlueprints': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • Blueprints (list) --

      Returns a list of blueprint as a Blueprints object.

      • (dict) --

        The details of a blueprint.

        • Name (string) --

          The name of the blueprint.

        • Description (string) --

          The description of the blueprint.

        • CreatedOn (datetime) --

          The date and time the blueprint was registered.

        • LastModifiedOn (datetime) --

          The date and time the blueprint was last modified.

        • ParameterSpec (string) --

          A JSON string that indicates the list of parameter specifications for the blueprint.

        • BlueprintLocation (string) --

          Specifies the path in Amazon S3 where the blueprint is published.

        • BlueprintServiceLocation (string) --

          Specifies a path in Amazon S3 where the blueprint is copied when you call CreateBlueprint/UpdateBlueprint to register the blueprint in Glue.

        • Status (string) --

          The status of the blueprint registration.

          • Creating — The blueprint registration is in progress.
          • Active — The blueprint has been successfully registered.
          • Updating — An update to the blueprint registration is in progress.
          • Failed — The blueprint registration failed.
        • ErrorMessage (string) --

          An error message.

        • LastActiveDefinition (dict) --

          When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.

          • Description (string) --

            The description of the blueprint.

          • LastModifiedOn (datetime) --

            The date and time the blueprint was last modified.

          • ParameterSpec (string) --

            A JSON string specifying the parameters for the blueprint.

          • BlueprintLocation (string) --

            Specifies a path in Amazon S3 where the blueprint is published by the Glue developer.

          • BlueprintServiceLocation (string) --

            Specifies a path in Amazon S3 where the blueprint is copied when you create or update the blueprint.

    • MissingBlueprints (list) --

      Returns a list of BlueprintNames that were not found.

      • (string) --

Exceptions

  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InvalidInputException
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',
                        ],
                        'ConnectionName': 'string',
                        'SampleSize': 123,
                        'EventQueueArn': 'string',
                        'DlqEventQueueArn': 'string'
                    },
                ],
                'JdbcTargets': [
                    {
                        'ConnectionName': 'string',
                        'Path': 'string',
                        'Exclusions': [
                            'string',
                        ]
                    },
                ],
                'MongoDBTargets': [
                    {
                        'ConnectionName': 'string',
                        'Path': 'string',
                        'ScanAll': True|False
                    },
                ],
                'DynamoDBTargets': [
                    {
                        'Path': 'string',
                        'scanAll': True|False,
                        'scanRate': 123.0
                    },
                ],
                'CatalogTargets': [
                    {
                        'DatabaseName': 'string',
                        'Tables': [
                            'string',
                        ],
                        'ConnectionName': 'string'
                    },
                ],
                'DeltaTargets': [
                    {
                        'DeltaTables': [
                            'string',
                        ],
                        'ConnectionName': 'string',
                        'WriteManifest': True|False
                    },
                ]
            },
            'DatabaseName': 'string',
            'Description': 'string',
            'Classifiers': [
                'string',
            ],
            'RecrawlPolicy': {
                'RecrawlBehavior': 'CRAWL_EVERYTHING'|'CRAWL_NEW_FOLDERS_ONLY'|'CRAWL_EVENT_MODE'
            },
            'SchemaChangePolicy': {
                'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
                'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
            },
            'LineageConfiguration': {
                'CrawlerLineageSettings': 'ENABLE'|'DISABLE'
            },
            'State': 'READY'|'RUNNING'|'STOPPING',
            'TablePrefix': 'string',
            'Schedule': {
                'ScheduleExpression': 'string',
                'State': 'SCHEDULED'|'NOT_SCHEDULED'|'TRANSITIONING'
            },
            'CrawlElapsedTime': 123,
            'CreationTime': datetime(2015, 1, 1),
            'LastUpdated': datetime(2015, 1, 1),
            'LastCrawl': {
                'Status': 'SUCCEEDED'|'CANCELLED'|'FAILED',
                'ErrorMessage': 'string',
                'LogGroup': 'string',
                'LogStream': 'string',
                'MessagePrefix': 'string',
                'StartTime': datetime(2015, 1, 1)
            },
            'Version': 123,
            'Configuration': 'string',
            'CrawlerSecurityConfiguration': 'string',
            'LakeFormationConfiguration': {
                'UseLakeFormationCredentials': True|False,
                'AccountId': '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 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) --
              • ConnectionName (string) --

                The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).

              • SampleSize (integer) --

                Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.

              • EventQueueArn (string) --

                A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs .

              • DlqEventQueueArn (string) --

                A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue .

          • JdbcTargets (list) --

            Specifies JDBC targets.

            • (dict) --

              Specifies a JDBC data store to crawl.

              • ConnectionName (string) --

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

              • Path (string) --

                The path of the JDBC target.

              • Exclusions (list) --

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

                • (string) --
          • MongoDBTargets (list) --

            Specifies Amazon DocumentDB or MongoDB targets.

            • (dict) --

              Specifies an Amazon DocumentDB or MongoDB data store to crawl.

              • ConnectionName (string) --

                The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.

              • Path (string) --

                The path of the Amazon DocumentDB or MongoDB target (database/collection).

              • ScanAll (boolean) --

                Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.

                A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .

          • DynamoDBTargets (list) --

            Specifies Amazon DynamoDB targets.

            • (dict) --

              Specifies an Amazon DynamoDB table to crawl.

              • Path (string) --

                The name of the DynamoDB table to crawl.

              • scanAll (boolean) --

                Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.

                A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .

              • scanRate (float) --

                The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.

                The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).

          • CatalogTargets (list) --

            Specifies Glue Data Catalog targets.

            • (dict) --

              Specifies an Glue Data Catalog target.

              • DatabaseName (string) --

                The name of the database to be synchronized.

              • Tables (list) --

                A list of the tables to be synchronized.

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

                The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type.

          • DeltaTargets (list) --

            Specifies Delta data store targets.

            • (dict) --

              Specifies a Delta data store to crawl one or more Delta tables.

              • DeltaTables (list) --

                A list of the Amazon S3 paths to the Delta tables.

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

                The name of the connection to use to connect to the Delta table target.

              • WriteManifest (boolean) --

                Specifies whether to write the manifest files to the Delta table path.

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

          A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.

          • RecrawlBehavior (string) --

            Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.

            A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.

            A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.

            A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.

        • SchemaChangePolicy (dict) --

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

          • UpdateBehavior (string) --

            The update behavior when the crawler finds a changed schema.

          • DeleteBehavior (string) --

            The deletion behavior when the crawler finds a deleted object.

        • LineageConfiguration (dict) --

          A configuration that specifies whether data lineage is enabled for the crawler.

          • CrawlerLineageSettings (string) --

            Specifies whether data lineage is enabled for the crawler. Valid values are:

            • ENABLE: enables data lineage for the crawler
            • DISABLE: disables data lineage for the crawler
        • State (string) --

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

        • TablePrefix (string) --

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

        • Schedule (dict) --

          For scheduled crawlers, the schedule when the crawler runs.

          • ScheduleExpression (string) --

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

          • State (string) --

            The state of the schedule.

        • CrawlElapsedTime (integer) --

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

        • CreationTime (datetime) --

          The time that the crawler was created.

        • LastUpdated (datetime) --

          The time that the crawler was last updated.

        • LastCrawl (dict) --

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

          • Status (string) --

            Status of the last crawl.

          • ErrorMessage (string) --

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

          • LogGroup (string) --

            The log group for the last crawl.

          • LogStream (string) --

            The log stream for the last crawl.

          • MessagePrefix (string) --

            The prefix for a message about this crawl.

          • StartTime (datetime) --

            The time at which the crawl started.

        • Version (integer) --

          The version of the crawler.

        • Configuration (string) --

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

        • CrawlerSecurityConfiguration (string) --

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

        • LakeFormationConfiguration (dict) --

          Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.

          • UseLakeFormationCredentials (boolean) --

            Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.

          • AccountId (string) --

            Required for cross account crawls. For same account crawls as the target data, this can be left as null.

    • CrawlersNotFound (list) --

      A list of names of crawlers that were not found.

      • (string) --

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.OperationTimeoutException
batch_get_custom_entity_types(**kwargs)

Retrieves the details for the custom patterns specified by a list of names.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_custom_entity_types(
    Names=[
        'string',
    ]
)
Parameters
Names (list) --

[REQUIRED]

A list of names of the custom patterns that you want to retrieve.

  • (string) --
Return type
dict
Returns
Response Syntax
{
    'CustomEntityTypes': [
        {
            'Name': 'string',
            'RegexString': 'string',
            'ContextWords': [
                'string',
            ]
        },
    ],
    'CustomEntityTypesNotFound': [
        'string',
    ]
}

Response Structure

  • (dict) --
    • CustomEntityTypes (list) --

      A list of CustomEntityType objects representing the custom patterns that have been created.

      • (dict) --

        An object representing a custom pattern for detecting sensitive data across the columns and rows of your structured data.

        • Name (string) --

          A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.

        • RegexString (string) --

          A regular expression string that is used for detecting sensitive data in a custom pattern.

        • ContextWords (list) --

          A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.

          If no context words are passed only a regular expression is checked.

          • (string) --
    • CustomEntityTypesNotFound (list) --

      A list of the names of custom patterns that were not found.

      • (string) --

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
batch_get_dev_endpoints(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

The list of DevEndpoint names, which might 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',
            'WorkerType': 'Standard'|'G.1X'|'G.2X'|'G.025X',
            'GlueVersion': 'string',
            'NumberOfWorkers': 123,
            'NumberOfNodes': 123,
            'AvailabilityZone': 'string',
            'VpcId': 'string',
            'ExtraPythonLibsS3Path': 'string',
            'ExtraJarsS3Path': 'string',
            'FailureReason': 'string',
            'LastUpdateStatus': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'LastModifiedTimestamp': datetime(2015, 1, 1),
            'PublicKey': 'string',
            'PublicKeys': [
                'string',
            ],
            'SecurityConfiguration': 'string',
            'Arguments': {
                'string': 'string'
            }
        },
    ],
    'DevEndpointsNotFound': [
        'string',
    ]
}

Response Structure

  • (dict) --
    • DevEndpoints (list) --

      A list of DevEndpoint definitions.

      • (dict) --

        A development endpoint where a developer can remotely debug extract, transform, and load (ETL) scripts.

        • EndpointName (string) --

          The name of the DevEndpoint .

        • RoleArn (string) --

          The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint .

        • SecurityGroupIds (list) --

          A list of security group identifiers used in this DevEndpoint .

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

        • ZeppelinRemoteSparkInterpreterPort (integer) --

          The Apache Zeppelin port for the remote Apache Spark interpreter.

        • PublicAddress (string) --

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

        • Status (string) --

          The current status of this DevEndpoint .

        • WorkerType (string) --

          The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.

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

          Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.

        • GlueVersion (string) --

          Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

          For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

          Development endpoints that are created without specifying a Glue version default to Glue 0.9.

          You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

        • NumberOfWorkers (integer) --

          The number of workers of a defined workerType that are allocated to the development endpoint.

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

        • NumberOfNodes (integer) --

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

        • AvailabilityZone (string) --

          The AWS Availability Zone where this DevEndpoint is located.

        • VpcId (string) --

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

        • ExtraPythonLibsS3Path (string) --

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

          Note

          You can only use pure Python libraries with a DevEndpoint . Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.

        • ExtraJarsS3Path (string) --

          The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint .

          Note

          You can only use pure Java/Scala libraries with a DevEndpoint .

        • FailureReason (string) --

          The reason for a current failure in this DevEndpoint .

        • LastUpdateStatus (string) --

          The status of the last update.

        • CreatedTimestamp (datetime) --

          The point in time at which this DevEndpoint was created.

        • LastModifiedTimestamp (datetime) --

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

        • PublicKey (string) --

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

        • PublicKeys (list) --

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

          Note

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

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

          Valid arguments are:

          • "--enable-glue-datacatalog": ""

          You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

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

      A list of DevEndpoints not found.

      • (string) --

Exceptions

  • Glue.Client.exceptions.AccessDeniedException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InvalidInputException
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'
            },
            'NonOverridableArguments': {
                'string': 'string'
            },
            'Connections': {
                'Connections': [
                    'string',
                ]
            },
            'MaxRetries': 123,
            'AllocatedCapacity': 123,
            'Timeout': 123,
            'MaxCapacity': 123.0,
            'WorkerType': 'Standard'|'G.1X'|'G.2X'|'G.025X',
            'NumberOfWorkers': 123,
            'SecurityConfiguration': 'string',
            'NotificationProperty': {
                'NotifyDelayAfter': 123
            },
            'GlueVersion': 'string',
            'CodeGenConfigurationNodes': {
                'string': {
                    'AthenaConnectorSource': {
                        'Name': 'string',
                        'ConnectionName': 'string',
                        'ConnectorName': 'string',
                        'ConnectionType': 'string',
                        'ConnectionTable': 'string',
                        'SchemaName': 'string',
                        'OutputSchemas': [
                            {
                                'Columns': [
                                    {
                                        'Name': 'string',
                                        'Type': 'string'
                                    },
                                ]
                            },
                        ]
                    },
                    'JDBCConnectorSource': {
                        'Name': 'string',
                        'ConnectionName': 'string',
                        'ConnectorName': 'string',
                        'ConnectionType': 'string',
                        'AdditionalOptions': {
                            'FilterPredicate': 'string',
                            'PartitionColumn': 'string',
                            'LowerBound': 123,
                            'UpperBound': 123,
                            'NumPartitions': 123,
                            'JobBookmarkKeys': [
                                'string',
                            ],
                            'JobBookmarkKeysSortOrder': 'string',
                            'DataTypeMapping': {
                                'string': 'DATE'|'STRING'|'TIMESTAMP'|'INT'|'FLOAT'|'LONG'|'BIGDECIMAL'|'BYTE'|'SHORT'|'DOUBLE'
                            }
                        },
                        'ConnectionTable': 'string',
                        'Query': 'string',
                        'OutputSchemas': [
                            {
                                'Columns': [
                                    {
                                        'Name': 'string',
                                        'Type': 'string'
                                    },
                                ]
                            },
                        ]
                    },
                    'SparkConnectorSource': {
                        'Name': 'string',
                        'ConnectionName': 'string',
                        'ConnectorName': 'string',
                        'ConnectionType': 'string',
                        'AdditionalOptions': {
                            'string': 'string'
                        },
                        'OutputSchemas': [
                            {
                                'Columns': [
                                    {
                                        'Name': 'string',
                                        'Type': 'string'
                                    },
                                ]
                            },
                        ]
                    },
                    'CatalogSource': {
                        'Name': 'string',
                        'Database': 'string',
                        'Table': 'string'
                    },
                    'RedshiftSource': {
                        'Name': 'string',
                        'Database': 'string',
                        'Table': 'string',
                        'RedshiftTmpDir': 'string',
                        'TmpDirIAMRole': 'string'
                    },
                    'S3CatalogSource': {
                        'Name': 'string',
                        'Database': 'string',
                        'Table': 'string',
                        'PartitionPredicate': 'string',
                        'AdditionalOptions': {
                            'BoundedSize': 123,
                            'BoundedFiles': 123
                        }
                    },
                    'S3CsvSource': {
                        'Name': 'string',
                        'Paths': [
                            'string',
                        ],
                        'CompressionType': 'gzip'|'bzip2',
                        'Exclusions': [
                            'string',
                        ],
                        'GroupSize': 'string',
                        'GroupFiles': 'string',
                        'Recurse': True|False,
                        'MaxBand': 123,
                        'MaxFilesInBand': 123,
                        'AdditionalOptions': {
                            'BoundedSize': 123,
                            'BoundedFiles': 123,
                            'EnableSamplePath': True|False,
                            'SamplePath': 'string'
                        },
                        'Separator': 'comma'|'ctrla'|'pipe'|'semicolon'|'tab',
                        'Escaper': 'string',
                        'QuoteChar': 'quote'|'quillemet'|'single_quote'|'disabled',
                        'Multiline': True|False,
                        'WithHeader': True|False,
                        'WriteHeader': True|False,
                        'SkipFirst': True|False,
                        'OptimizePerformance': True|False,
                        'OutputSchemas': [
                            {
                                'Columns': [
                                    {
                                        'Name': 'string',
                                        'Type': 'string'
                                    },
                                ]
                            },
                        ]
                    },
                    'S3JsonSource': {
                        'Name': 'string',
                        'Paths': [
                            'string',
                        ],
                        'CompressionType': 'gzip'|'bzip2',
                        'Exclusions': [
                            'string',
                        ],
                        'GroupSize': 'string',
                        'GroupFiles': 'string',
                        'Recurse': True|False,
                        'MaxBand': 123,
                        'MaxFilesInBand': 123,
                        'AdditionalOptions': {
                            'BoundedSize': 123,
                            'BoundedFiles': 123,
                            'EnableSamplePath': True|False,
                            'SamplePath': 'string'
                        },
                        'JsonPath': 'string',
                        'Multiline': True|False,
                        'OutputSchemas': [
                            {
                                'Columns': [
                                    {
                                        'Name': 'string',
                                        'Type': 'string'
                                    },
                                ]
                            },
                        ]
                    },
                    'S3ParquetSource': {
                        'Name': 'string',
                        'Paths': [
                            'string',
                        ],
                        'CompressionType': 'snappy'|'lzo'|'gzip'|'uncompressed'|'none',
                        'Exclusions': [
                            'string',
                        ],
                        'GroupSize': 'string',
                        'GroupFiles': 'string',
                        'Recurse': True|False,
                        'MaxBand': 123,
                        'MaxFilesInBand': 123,
                        'AdditionalOptions': {
                            'BoundedSize': 123,
                            'BoundedFiles': 123,
                            'EnableSamplePath': True|False,
                            'SamplePath': 'string'
                        },
                        'OutputSchemas': [
                            {
                                'Columns': [
                                    {
                                        'Name': 'string',
                                        'Type': 'string'
                                    },
                                ]
                            },
                        ]
                    },
                    'RelationalCatalogSource': {
                        'Name': 'string',
                        'Database': 'string',
                        'Table': 'string'
                    },
                    'DynamoDBCatalogSource': {
                        'Name': 'string',
                        'Database': 'string',
                        'Table': 'string'
                    },
                    'JDBCConnectorTarget': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'ConnectionName': 'string',
                        'ConnectionTable': 'string',
                        'ConnectorName': 'string',
                        'ConnectionType': 'string',
                        'AdditionalOptions': {
                            'string': 'string'
                        },
                        'OutputSchemas': [
                            {
                                'Columns': [
                                    {
                                        'Name': 'string',
                                        'Type': 'string'
                                    },
                                ]
                            },
                        ]
                    },
                    'SparkConnectorTarget': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'ConnectionName': 'string',
                        'ConnectorName': 'string',
                        'ConnectionType': 'string',
                        'AdditionalOptions': {
                            'string': 'string'
                        },
                        'OutputSchemas': [
                            {
                                'Columns': [
                                    {
                                        'Name': 'string',
                                        'Type': 'string'
                                    },
                                ]
                            },
                        ]
                    },
                    'CatalogTarget': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'Database': 'string',
                        'Table': 'string'
                    },
                    'RedshiftTarget': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'Database': 'string',
                        'Table': 'string',
                        'RedshiftTmpDir': 'string',
                        'TmpDirIAMRole': 'string',
                        'UpsertRedshiftOptions': {
                            'TableLocation': 'string',
                            'ConnectionName': 'string',
                            'UpsertKeys': [
                                'string',
                            ]
                        }
                    },
                    'S3CatalogTarget': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'PartitionKeys': [
                            [
                                'string',
                            ],
                        ],
                        'Table': 'string',
                        'Database': 'string',
                        'SchemaChangePolicy': {
                            'EnableUpdateCatalog': True|False,
                            'UpdateBehavior': 'UPDATE_IN_DATABASE'|'LOG'
                        }
                    },
                    'S3GlueParquetTarget': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'PartitionKeys': [
                            [
                                'string',
                            ],
                        ],
                        'Path': 'string',
                        'Compression': 'snappy'|'lzo'|'gzip'|'uncompressed'|'none',
                        'SchemaChangePolicy': {
                            'EnableUpdateCatalog': True|False,
                            'UpdateBehavior': 'UPDATE_IN_DATABASE'|'LOG',
                            'Table': 'string',
                            'Database': 'string'
                        }
                    },
                    'S3DirectTarget': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'PartitionKeys': [
                            [
                                'string',
                            ],
                        ],
                        'Path': 'string',
                        'Compression': 'string',
                        'Format': 'json'|'csv'|'avro'|'orc'|'parquet',
                        'SchemaChangePolicy': {
                            'EnableUpdateCatalog': True|False,
                            'UpdateBehavior': 'UPDATE_IN_DATABASE'|'LOG',
                            'Table': 'string',
                            'Database': 'string'
                        }
                    },
                    'ApplyMapping': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'Mapping': [
                            {
                                'ToKey': 'string',
                                'FromPath': [
                                    'string',
                                ],
                                'FromType': 'string',
                                'ToType': 'string',
                                'Dropped': True|False,
                                'Children': {'... recursive ...'}
                            },
                        ]
                    },
                    'SelectFields': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'Paths': [
                            [
                                'string',
                            ],
                        ]
                    },
                    'DropFields': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'Paths': [
                            [
                                'string',
                            ],
                        ]
                    },
                    'RenameField': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'SourcePath': [
                            'string',
                        ],
                        'TargetPath': [
                            'string',
                        ]
                    },
                    'Spigot': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'Path': 'string',
                        'Topk': 123,
                        'Prob': 123.0
                    },
                    'Join': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'JoinType': 'equijoin'|'left'|'right'|'outer'|'leftsemi'|'leftanti',
                        'Columns': [
                            {
                                'From': 'string',
                                'Keys': [
                                    [
                                        'string',
                                    ],
                                ]
                            },
                        ]
                    },
                    'SplitFields': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'Paths': [
                            [
                                'string',
                            ],
                        ]
                    },
                    'SelectFromCollection': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'Index': 123
                    },
                    'FillMissingValues': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'ImputedPath': 'string',
                        'FilledPath': 'string'
                    },
                    'Filter': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'LogicalOperator': 'AND'|'OR',
                        'Filters': [
                            {
                                'Operation': 'EQ'|'LT'|'GT'|'LTE'|'GTE'|'REGEX'|'ISNULL',
                                'Negated': True|False,
                                'Values': [
                                    {
                                        'Type': 'COLUMNEXTRACTED'|'CONSTANT',
                                        'Value': [
                                            'string',
                                        ]
                                    },
                                ]
                            },
                        ]
                    },
                    'CustomCode': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'Code': 'string',
                        'ClassName': 'string',
                        'OutputSchemas': [
                            {
                                'Columns': [
                                    {
                                        'Name': 'string',
                                        'Type': 'string'
                                    },
                                ]
                            },
                        ]
                    },
                    'SparkSQL': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'SqlQuery': 'string',
                        'SqlAliases': [
                            {
                                'From': 'string',
                                'Alias': 'string'
                            },
                        ],
                        'OutputSchemas': [
                            {
                                'Columns': [
                                    {
                                        'Name': 'string',
                                        'Type': 'string'
                                    },
                                ]
                            },
                        ]
                    },
                    'DirectKinesisSource': {
                        'Name': 'string',
                        'WindowSize': 123,
                        'DetectSchema': True|False,
                        'StreamingOptions': {
                            'EndpointUrl': 'string',
                            'StreamName': 'string',
                            'Classification': 'string',
                            'Delimiter': 'string',
                            'StartingPosition': 'latest'|'trim_horizon'|'earliest',
                            'MaxFetchTimeInMs': 123,
                            'MaxFetchRecordsPerShard': 123,
                            'MaxRecordPerRead': 123,
                            'AddIdleTimeBetweenReads': True|False,
                            'IdleTimeBetweenReadsInMs': 123,
                            'DescribeShardInterval': 123,
                            'NumRetries': 123,
                            'RetryIntervalMs': 123,
                            'MaxRetryIntervalMs': 123,
                            'AvoidEmptyBatches': True|False,
                            'StreamArn': 'string',
                            'RoleArn': 'string',
                            'RoleSessionName': 'string'
                        },
                        'DataPreviewOptions': {
                            'PollingTime': 123,
                            'RecordPollingLimit': 123
                        }
                    },
                    'DirectKafkaSource': {
                        'Name': 'string',
                        'StreamingOptions': {
                            'BootstrapServers': 'string',
                            'SecurityProtocol': 'string',
                            'ConnectionName': 'string',
                            'TopicName': 'string',
                            'Assign': 'string',
                            'SubscribePattern': 'string',
                            'Classification': 'string',
                            'Delimiter': 'string',
                            'StartingOffsets': 'string',
                            'EndingOffsets': 'string',
                            'PollTimeoutMs': 123,
                            'NumRetries': 123,
                            'RetryIntervalMs': 123,
                            'MaxOffsetsPerTrigger': 123,
                            'MinPartitions': 123
                        },
                        'WindowSize': 123,
                        'DetectSchema': True|False,
                        'DataPreviewOptions': {
                            'PollingTime': 123,
                            'RecordPollingLimit': 123
                        }
                    },
                    'CatalogKinesisSource': {
                        'Name': 'string',
                        'WindowSize': 123,
                        'DetectSchema': True|False,
                        'Table': 'string',
                        'Database': 'string',
                        'StreamingOptions': {
                            'EndpointUrl': 'string',
                            'StreamName': 'string',
                            'Classification': 'string',
                            'Delimiter': 'string',
                            'StartingPosition': 'latest'|'trim_horizon'|'earliest',
                            'MaxFetchTimeInMs': 123,
                            'MaxFetchRecordsPerShard': 123,
                            'MaxRecordPerRead': 123,
                            'AddIdleTimeBetweenReads': True|False,
                            'IdleTimeBetweenReadsInMs': 123,
                            'DescribeShardInterval': 123,
                            'NumRetries': 123,
                            'RetryIntervalMs': 123,
                            'MaxRetryIntervalMs': 123,
                            'AvoidEmptyBatches': True|False,
                            'StreamArn': 'string',
                            'RoleArn': 'string',
                            'RoleSessionName': 'string'
                        },
                        'DataPreviewOptions': {
                            'PollingTime': 123,
                            'RecordPollingLimit': 123
                        }
                    },
                    'CatalogKafkaSource': {
                        'Name': 'string',
                        'WindowSize': 123,
                        'DetectSchema': True|False,
                        'Table': 'string',
                        'Database': 'string',
                        'StreamingOptions': {
                            'BootstrapServers': 'string',
                            'SecurityProtocol': 'string',
                            'ConnectionName': 'string',
                            'TopicName': 'string',
                            'Assign': 'string',
                            'SubscribePattern': 'string',
                            'Classification': 'string',
                            'Delimiter': 'string',
                            'StartingOffsets': 'string',
                            'EndingOffsets': 'string',
                            'PollTimeoutMs': 123,
                            'NumRetries': 123,
                            'RetryIntervalMs': 123,
                            'MaxOffsetsPerTrigger': 123,
                            'MinPartitions': 123
                        },
                        'DataPreviewOptions': {
                            'PollingTime': 123,
                            'RecordPollingLimit': 123
                        }
                    },
                    'DropNullFields': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'NullCheckBoxList': {
                            'IsEmpty': True|False,
                            'IsNullString': True|False,
                            'IsNegOne': True|False
                        },
                        'NullTextList': [
                            {
                                'Value': 'string',
                                'Datatype': {
                                    'Id': 'string',
                                    'Label': 'string'
                                }
                            },
                        ]
                    },
                    'Merge': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'Source': 'string',
                        'PrimaryKeys': [
                            [
                                'string',
                            ],
                        ]
                    },
                    'Union': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'UnionType': 'ALL'|'DISTINCT'
                    },
                    'PIIDetection': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'PiiType': 'RowAudit'|'RowMasking'|'ColumnAudit'|'ColumnMasking',
                        'EntityTypesToDetect': [
                            'string',
                        ],
                        'OutputColumnName': 'string',
                        'SampleFraction': 123.0,
                        'ThresholdFraction': 123.0,
                        'MaskValue': 'string'
                    },
                    'Aggregate': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'Groups': [
                            [
                                'string',
                            ],
                        ],
                        'Aggs': [
                            {
                                'Column': [
                                    'string',
                                ],
                                'AggFunc': 'avg'|'countDistinct'|'count'|'first'|'last'|'kurtosis'|'max'|'min'|'skewness'|'stddev_samp'|'stddev_pop'|'sum'|'sumDistinct'|'var_samp'|'var_pop'
                            },
                        ]
                    },
                    'DropDuplicates': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'Columns': [
                            [
                                'string',
                            ],
                        ]
                    },
                    'GovernedCatalogTarget': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'PartitionKeys': [
                            [
                                'string',
                            ],
                        ],
                        'Table': 'string',
                        'Database': 'string',
                        'SchemaChangePolicy': {
                            'EnableUpdateCatalog': True|False,
                            'UpdateBehavior': 'UPDATE_IN_DATABASE'|'LOG'
                        }
                    },
                    'GovernedCatalogSource': {
                        'Name': 'string',
                        'Database': 'string',
                        'Table': 'string',
                        'PartitionPredicate': 'string',
                        'AdditionalOptions': {
                            'BoundedSize': 123,
                            'BoundedFiles': 123
                        }
                    },
                    'MicrosoftSQLServerCatalogSource': {
                        'Name': 'string',
                        'Database': 'string',
                        'Table': 'string'
                    },
                    'MySQLCatalogSource': {
                        'Name': 'string',
                        'Database': 'string',
                        'Table': 'string'
                    },
                    'OracleSQLCatalogSource': {
                        'Name': 'string',
                        'Database': 'string',
                        'Table': 'string'
                    },
                    'PostgreSQLCatalogSource': {
                        'Name': 'string',
                        'Database': 'string',
                        'Table': 'string'
                    },
                    'MicrosoftSQLServerCatalogTarget': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'Database': 'string',
                        'Table': 'string'
                    },
                    'MySQLCatalogTarget': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'Database': 'string',
                        'Table': 'string'
                    },
                    'OracleSQLCatalogTarget': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'Database': 'string',
                        'Table': 'string'
                    },
                    'PostgreSQLCatalogTarget': {
                        'Name': 'string',
                        'Inputs': [
                            'string',
                        ],
                        'Database': 'string',
                        'Table': 'string'
                    }
                }
            },
            'ExecutionClass': 'FLEX'|'STANDARD'
        },
    ],
    '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 runs this job.

          • Name (string) --

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

          • ScriptLocation (string) --

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

          • PythonVersion (string) --

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

        • DefaultArguments (dict) --

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

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

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

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

          • (string) --
            • (string) --
        • NonOverridableArguments (dict) --

          Non-overridable arguments for this job, specified as name-value pairs.

          • (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 Glue data processing units (DPUs) allocated to runs of this job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .

        • Timeout (integer) --

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

        • MaxCapacity (float) --

          For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .

          Do not set Max Capacity if using WorkerType and NumberOfWorkers .

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

          • 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") or Apache Spark streaming ETL job (JobCommand.Name ="gluestreaming"), you can allocate a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

          For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity . Instead, you should specify a Worker type and the Number of workers .

        • WorkerType (string) --

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

          • 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.
          • For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
        • NumberOfWorkers (integer) --

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

        • SecurityConfiguration (string) --

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

        • NotificationProperty (dict) --

          Specifies configuration properties of a job notification.

          • NotifyDelayAfter (integer) --

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

        • GlueVersion (string) --

          Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

          For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

          Jobs that are created without specifying a Glue version default to Glue 0.9.

        • CodeGenConfigurationNodes (dict) --

          The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.

          • (string) --
            • (dict) --
              CodeGenConfigurationNode enumerates all valid Node types. One and only one of its member variables can be populated.
              • AthenaConnectorSource (dict) --

                Specifies a connector to an Amazon Athena data source.

                • Name (string) --

                  The name of the data source.

                • ConnectionName (string) --

                  The name of the connection that is associated with the connector.

                • ConnectorName (string) --

                  The name of a connector that assists with accessing the data store in Glue Studio.

                • ConnectionType (string) --

                  The type of connection, such as marketplace.athena or custom.athena, designating a connection to an Amazon Athena data store.

                • ConnectionTable (string) --

                  The name of the table in the data source.

                • SchemaName (string) --

                  The name of the Cloudwatch log group to read from. For example, /aws-glue/jobs/output .

                • OutputSchemas (list) --

                  Specifies the data schema for the custom Athena source.

                  • (dict) --

                    Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

                    • Columns (list) --

                      Specifies the column definitions that make up a Glue schema.

                      • (dict) --

                        Specifies a single column in a Glue schema definition.

                        • Name (string) --

                          The name of the column in the Glue Studio schema.

                        • Type (string) --

                          The hive type for this column in the Glue Studio schema.

              • JDBCConnectorSource (dict) --

                Specifies a connector to a JDBC data source.

                • Name (string) --

                  The name of the data source.

                • ConnectionName (string) --

                  The name of the connection that is associated with the connector.

                • ConnectorName (string) --

                  The name of a connector that assists with accessing the data store in Glue Studio.

                • ConnectionType (string) --

                  The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data store.

                • AdditionalOptions (dict) --

                  Additional connection options for the connector.

                  • FilterPredicate (string) --

                    Extra condition clause to filter data from source. For example:

                    BillingCity='Mountain View'

                    When using a query instead of a table name, you should validate that the query works with the specified filterPredicate .

                  • PartitionColumn (string) --

                    The name of an integer column that is used for partitioning. This option works only when it's included with lowerBound , upperBound , and numPartitions . This option works the same way as in the Spark SQL JDBC reader.

                  • LowerBound (integer) --

                    The minimum value of partitionColumn that is used to decide partition stride.

                  • UpperBound (integer) --

                    The maximum value of partitionColumn that is used to decide partition stride.

                  • NumPartitions (integer) --

                    The number of partitions. This value, along with lowerBound (inclusive) and upperBound (exclusive), form partition strides for generated WHERE clause expressions that are used to split the partitionColumn .

                  • JobBookmarkKeys (list) --

                    The name of the job bookmark keys on which to sort.

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

                    Specifies an ascending or descending sort order.

                  • DataTypeMapping (dict) --

                    Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option "dataTypeMapping":{"FLOAT":"STRING"} maps data fields of JDBC type FLOAT into the Java String type by calling the ResultSet.getString() method of the driver, and uses it to build the Glue record. The ResultSet object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand how the driver performs the conversions.

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

                  The name of the table in the data source.

                • Query (string) --

                  The table or SQL query to get the data from. You can specify either ConnectionTable or query , but not both.

                • OutputSchemas (list) --

                  Specifies the data schema for the custom JDBC source.

                  • (dict) --

                    Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

                    • Columns (list) --

                      Specifies the column definitions that make up a Glue schema.

                      • (dict) --

                        Specifies a single column in a Glue schema definition.

                        • Name (string) --

                          The name of the column in the Glue Studio schema.

                        • Type (string) --

                          The hive type for this column in the Glue Studio schema.

              • SparkConnectorSource (dict) --

                Specifies a connector to an Apache Spark data source.

                • Name (string) --

                  The name of the data source.

                • ConnectionName (string) --

                  The name of the connection that is associated with the connector.

                • ConnectorName (string) --

                  The name of a connector that assists with accessing the data store in Glue Studio.

                • ConnectionType (string) --

                  The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.

                • AdditionalOptions (dict) --

                  Additional connection options for the connector.

                  • (string) --
                    • (string) --
                • OutputSchemas (list) --

                  Specifies data schema for the custom spark source.

                  • (dict) --

                    Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

                    • Columns (list) --

                      Specifies the column definitions that make up a Glue schema.

                      • (dict) --

                        Specifies a single column in a Glue schema definition.

                        • Name (string) --

                          The name of the column in the Glue Studio schema.

                        • Type (string) --

                          The hive type for this column in the Glue Studio schema.

              • CatalogSource (dict) --

                Specifies a data store in the Glue Data Catalog.

                • Name (string) --

                  The name of the data store.

                • Database (string) --

                  The name of the database to read from.

                • Table (string) --

                  The name of the table in the database to read from.

              • RedshiftSource (dict) --

                Specifies an Amazon Redshift data store.

                • Name (string) --

                  The name of the Amazon Redshift data store.

                • Database (string) --

                  The database to read from.

                • Table (string) --

                  The database table to read from.

                • RedshiftTmpDir (string) --

                  The Amazon S3 path where temporary data can be staged when copying out of the database.

                • TmpDirIAMRole (string) --

                  The IAM role with permissions.

              • S3CatalogSource (dict) --

                Specifies an Amazon S3 data store in the Glue Data Catalog.

                • Name (string) --

                  The name of the data store.

                • Database (string) --

                  The database to read from.

                • Table (string) --

                  The database table to read from.

                • PartitionPredicate (string) --

                  Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to "" – empty by default.

                • AdditionalOptions (dict) --

                  Specifies additional connection options.

                  • BoundedSize (integer) --

                    Sets the upper limit for the target size of the dataset in bytes that will be processed.

                  • BoundedFiles (integer) --

                    Sets the upper limit for the target number of files that will be processed.

              • S3CsvSource (dict) --

                Specifies a command-separated value (CSV) data store stored in Amazon S3.

                • Name (string) --

                  The name of the data store.

                • Paths (list) --

                  A list of the Amazon S3 paths to read from.

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

                  Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip" ).

                • Exclusions (list) --

                  A string containing a JSON list of Unix-style glob patterns to exclude. For example, "["**.pdf"]" excludes all PDF files.

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

                  The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles" must be set to "inPartition" for this to take effect.

                • GroupFiles (string) --

                  Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none" .

                • Recurse (boolean) --

                  If set to true, recursively reads files in all subdirectories under the specified paths.

                • MaxBand (integer) --

                  This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.

                • MaxFilesInBand (integer) --

                  This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.

                • AdditionalOptions (dict) --

                  Specifies additional connection options.

                  • BoundedSize (integer) --

                    Sets the upper limit for the target size of the dataset in bytes that will be processed.

                  • BoundedFiles (integer) --

                    Sets the upper limit for the target number of files that will be processed.

                  • EnableSamplePath (boolean) --

                    Sets option to enable a sample path.

                  • SamplePath (string) --

                    If enabled, specifies the sample path.

                • Separator (string) --

                  Specifies the delimiter character. The default is a comma: ",", but any other character can be specified.

                • Escaper (string) --

                  Specifies a character to use for escaping. This option is used only when reading CSV files. The default value is none . If enabled, the character which immediately follows is used as-is, except for a small set of well-known escapes (\n , \r , \t , and \0 ).

                • QuoteChar (string) --

                  Specifies the character to use for quoting. The default is a double quote: '"' . Set this to -1 to turn off quoting entirely.

                • Multiline (boolean) --

                  A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False , which allows for more aggressive file-splitting during parsing.

                • WithHeader (boolean) --

                  A Boolean value that specifies whether to treat the first line as a header. The default value is False .

                • WriteHeader (boolean) --

                  A Boolean value that specifies whether to write the header to output. The default value is True .

                • SkipFirst (boolean) --

                  A Boolean value that specifies whether to skip the first data line. The default value is False .

                • OptimizePerformance (boolean) --

                  A Boolean value that specifies whether to use the advanced SIMD CSV reader along with Apache Arrow based columnar memory formats. Only available in Glue version 3.0.

                • OutputSchemas (list) --

                  Specifies the data schema for the S3 CSV source.

                  • (dict) --

                    Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

                    • Columns (list) --

                      Specifies the column definitions that make up a Glue schema.

                      • (dict) --

                        Specifies a single column in a Glue schema definition.

                        • Name (string) --

                          The name of the column in the Glue Studio schema.

                        • Type (string) --

                          The hive type for this column in the Glue Studio schema.

              • S3JsonSource (dict) --

                Specifies a JSON data store stored in Amazon S3.

                • Name (string) --

                  The name of the data store.

                • Paths (list) --

                  A list of the Amazon S3 paths to read from.

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

                  Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip" ).

                • Exclusions (list) --

                  A string containing a JSON list of Unix-style glob patterns to exclude. For example, "["**.pdf"]" excludes all PDF files.

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

                  The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles" must be set to "inPartition" for this to take effect.

                • GroupFiles (string) --

                  Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none" .

                • Recurse (boolean) --

                  If set to true, recursively reads files in all subdirectories under the specified paths.

                • MaxBand (integer) --

                  This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.

                • MaxFilesInBand (integer) --

                  This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.

                • AdditionalOptions (dict) --

                  Specifies additional connection options.

                  • BoundedSize (integer) --

                    Sets the upper limit for the target size of the dataset in bytes that will be processed.

                  • BoundedFiles (integer) --

                    Sets the upper limit for the target number of files that will be processed.

                  • EnableSamplePath (boolean) --

                    Sets option to enable a sample path.

                  • SamplePath (string) --

                    If enabled, specifies the sample path.

                • JsonPath (string) --

                  A JsonPath string defining the JSON data.

                • Multiline (boolean) --

                  A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False , which allows for more aggressive file-splitting during parsing.

                • OutputSchemas (list) --

                  Specifies the data schema for the S3 JSON source.

                  • (dict) --

                    Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

                    • Columns (list) --

                      Specifies the column definitions that make up a Glue schema.

                      • (dict) --

                        Specifies a single column in a Glue schema definition.

                        • Name (string) --

                          The name of the column in the Glue Studio schema.

                        • Type (string) --

                          The hive type for this column in the Glue Studio schema.

              • S3ParquetSource (dict) --

                Specifies an Apache Parquet data store stored in Amazon S3.

                • Name (string) --

                  The name of the data store.

                • Paths (list) --

                  A list of the Amazon S3 paths to read from.

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

                  Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip" ).

                • Exclusions (list) --

                  A string containing a JSON list of Unix-style glob patterns to exclude. For example, "["**.pdf"]" excludes all PDF files.

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

                  The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles" must be set to "inPartition" for this to take effect.

                • GroupFiles (string) --

                  Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none" .

                • Recurse (boolean) --

                  If set to true, recursively reads files in all subdirectories under the specified paths.

                • MaxBand (integer) --

                  This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.

                • MaxFilesInBand (integer) --

                  This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.

                • AdditionalOptions (dict) --

                  Specifies additional connection options.

                  • BoundedSize (integer) --

                    Sets the upper limit for the target size of the dataset in bytes that will be processed.

                  • BoundedFiles (integer) --

                    Sets the upper limit for the target number of files that will be processed.

                  • EnableSamplePath (boolean) --

                    Sets option to enable a sample path.

                  • SamplePath (string) --

                    If enabled, specifies the sample path.

                • OutputSchemas (list) --

                  Specifies the data schema for the S3 Parquet source.

                  • (dict) --

                    Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

                    • Columns (list) --

                      Specifies the column definitions that make up a Glue schema.

                      • (dict) --

                        Specifies a single column in a Glue schema definition.

                        • Name (string) --

                          The name of the column in the Glue Studio schema.

                        • Type (string) --

                          The hive type for this column in the Glue Studio schema.

              • RelationalCatalogSource (dict) --

                Specifies a Relational database data source in the Glue Data Catalog.

                • Name (string) --

                  The name of the data source.

                • Database (string) --

                  The name of the database to read from.

                • Table (string) --

                  The name of the table in the database to read from.

              • DynamoDBCatalogSource (dict) --

                Specifies a DynamoDB data source in the Glue Data Catalog.

                • Name (string) --

                  The name of the data source.

                • Database (string) --

                  The name of the database to read from.

                • Table (string) --

                  The name of the table in the database to read from.

              • JDBCConnectorTarget (dict) --

                Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.

                • Name (string) --

                  The name of the data target.

                • Inputs (list) --

                  The nodes that are inputs to the data target.

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

                  The name of the connection that is associated with the connector.

                • ConnectionTable (string) --

                  The name of the table in the data target.

                • ConnectorName (string) --

                  The name of a connector that will be used.

                • ConnectionType (string) --

                  The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data target.

                • AdditionalOptions (dict) --

                  Additional connection options for the connector.

                  • (string) --
                    • (string) --
                • OutputSchemas (list) --

                  Specifies the data schema for the JDBC target.

                  • (dict) --

                    Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

                    • Columns (list) --

                      Specifies the column definitions that make up a Glue schema.

                      • (dict) --

                        Specifies a single column in a Glue schema definition.

                        • Name (string) --

                          The name of the column in the Glue Studio schema.

                        • Type (string) --

                          The hive type for this column in the Glue Studio schema.

              • SparkConnectorTarget (dict) --

                Specifies a target that uses an Apache Spark connector.

                • Name (string) --

                  The name of the data target.

                • Inputs (list) --

                  The nodes that are inputs to the data target.

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

                  The name of a connection for an Apache Spark connector.

                • ConnectorName (string) --

                  The name of an Apache Spark connector.

                • ConnectionType (string) --

                  The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.

                • AdditionalOptions (dict) --

                  Additional connection options for the connector.

                  • (string) --
                    • (string) --
                • OutputSchemas (list) --

                  Specifies the data schema for the custom spark target.

                  • (dict) --

                    Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

                    • Columns (list) --

                      Specifies the column definitions that make up a Glue schema.

                      • (dict) --

                        Specifies a single column in a Glue schema definition.

                        • Name (string) --

                          The name of the column in the Glue Studio schema.

                        • Type (string) --

                          The hive type for this column in the Glue Studio schema.

              • CatalogTarget (dict) --

                Specifies a target that uses a Glue Data Catalog table.

                • Name (string) --

                  The name of your data target.

                • Inputs (list) --

                  The nodes that are inputs to the data target.

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

                  The database that contains the table you want to use as the target. This database must already exist in the Data Catalog.

                • Table (string) --

                  The table that defines the schema of your output data. This table must already exist in the Data Catalog.

              • RedshiftTarget (dict) --

                Specifies a target that uses Amazon Redshift.

                • Name (string) --

                  The name of the data target.

                • Inputs (list) --

                  The nodes that are inputs to the data target.

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

                  The name of the database to write to.

                • Table (string) --

                  The name of the table in the database to write to.

                • RedshiftTmpDir (string) --

                  The Amazon S3 path where temporary data can be staged when copying out of the database.

                • TmpDirIAMRole (string) --

                  The IAM role with permissions.

                • UpsertRedshiftOptions (dict) --

                  The set of options to configure an upsert operation when writing to a Redshift target.

                  • TableLocation (string) --

                    The physical location of the Redshift table.

                  • ConnectionName (string) --

                    The name of the connection to use to write to Redshift.

                  • UpsertKeys (list) --

                    The keys used to determine whether to perform an update or insert.

                    • (string) --
              • S3CatalogTarget (dict) --

                Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.

                • Name (string) --

                  The name of the data target.

                • Inputs (list) --

                  The nodes that are inputs to the data target.

                  • (string) --
                • PartitionKeys (list) --

                  Specifies native partitioning using a sequence of keys.

                  • (list) --
                    • (string) --
                • Table (string) --

                  The name of the table in the database to write to.

                • Database (string) --

                  The name of the database to write to.

                • SchemaChangePolicy (dict) --

                  A policy that specifies update behavior for the crawler.

                  • EnableUpdateCatalog (boolean) --

                    Whether to use the specified update behavior when the crawler finds a changed schema.

                  • UpdateBehavior (string) --

                    The update behavior when the crawler finds a changed schema.

              • S3GlueParquetTarget (dict) --

                Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.

                • Name (string) --

                  The name of the data target.

                • Inputs (list) --

                  The nodes that are inputs to the data target.

                  • (string) --
                • PartitionKeys (list) --

                  Specifies native partitioning using a sequence of keys.

                  • (list) --
                    • (string) --
                • Path (string) --

                  A single Amazon S3 path to write to.

                • Compression (string) --

                  Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip" ).

                • SchemaChangePolicy (dict) --

                  A policy that specifies update behavior for the crawler.

                  • EnableUpdateCatalog (boolean) --

                    Whether to use the specified update behavior when the crawler finds a changed schema.

                  • UpdateBehavior (string) --

                    The update behavior when the crawler finds a changed schema.

                  • Table (string) --

                    Specifies the table in the database that the schema change policy applies to.

                  • Database (string) --

                    Specifies the database that the schema change policy applies to.

              • S3DirectTarget (dict) --

                Specifies a data target that writes to Amazon S3.

                • Name (string) --

                  The name of the data target.

                • Inputs (list) --

                  The nodes that are inputs to the data target.

                  • (string) --
                • PartitionKeys (list) --

                  Specifies native partitioning using a sequence of keys.

                  • (list) --
                    • (string) --
                • Path (string) --

                  A single Amazon S3 path to write to.

                • Compression (string) --

                  Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip" ).

                • Format (string) --

                  Specifies the data output format for the target.

                • SchemaChangePolicy (dict) --

                  A policy that specifies update behavior for the crawler.

                  • EnableUpdateCatalog (boolean) --

                    Whether to use the specified update behavior when the crawler finds a changed schema.

                  • UpdateBehavior (string) --

                    The update behavior when the crawler finds a changed schema.

                  • Table (string) --

                    Specifies the table in the database that the schema change policy applies to.

                  • Database (string) --

                    Specifies the database that the schema change policy applies to.

              • ApplyMapping (dict) --

                Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The data inputs identified by their node names.

                  • (string) --
                • Mapping (list) --

                  Specifies the mapping of data property keys in the data source to data property keys in the data target.

                  • (dict) --

                    Specifies the mapping of data property keys.

                    • ToKey (string) --

                      After the apply mapping, what the name of the column should be. Can be the same as FromPath .

                    • FromPath (list) --

                      The table or column to be modified.

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

                      The type of the data to be modified.

                    • ToType (string) --

                      The data type that the data is to be modified to.

                    • Dropped (boolean) --

                      If true, then the column is removed.

                    • Children (list) --

                      Only applicable to nested data structures. If you want to change the parent structure, but also one of its children, you can fill out this data strucutre. It is also Mapping , but its FromPath will be the parent's FromPath plus the FromPath from this structure.

                      For the children part, suppose you have the structure:

                      { "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }

                      You can specify a Mapping that looks like:

                      { "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }
              • SelectFields (dict) --

                Specifies a transform that chooses the data property keys that you want to keep.

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The data inputs identified by their node names.

                  • (string) --
                • Paths (list) --

                  A JSON path to a variable in the data structure.

                  • (list) --
                    • (string) --
              • DropFields (dict) --

                Specifies a transform that chooses the data property keys that you want to drop.

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The data inputs identified by their node names.

                  • (string) --
                • Paths (list) --

                  A JSON path to a variable in the data structure.

                  • (list) --
                    • (string) --
              • RenameField (dict) --

                Specifies a transform that renames a single data property key.

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The data inputs identified by their node names.

                  • (string) --
                • SourcePath (list) --

                  A JSON path to a variable in the data structure for the source data.

                  • (string) --
                • TargetPath (list) --

                  A JSON path to a variable in the data structure for the target data.

                  • (string) --
              • Spigot (dict) --

                Specifies a transform that writes samples of the data to an Amazon S3 bucket.

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The data inputs identified by their node names.

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

                  A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.

                • Topk (integer) --

                  Specifies a number of records to write starting from the beginning of the dataset.

                • Prob (float) --

                  The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.

              • Join (dict) --

                Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The data inputs identified by their node names.

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

                  Specifies the type of join to be performed on the datasets.

                • Columns (list) --

                  A list of the two columns to be joined.

                  • (dict) --

                    Specifies a column to be joined.

                    • From (string) --

                      The column to be joined.

                    • Keys (list) --

                      The key of the column to be joined.

                      • (list) --
                        • (string) --
              • SplitFields (dict) --

                Specifies a transform that splits data property keys into two DynamicFrames . The output is a collection of DynamicFrames : one with selected data property keys, and one with the remaining data property keys.

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The data inputs identified by their node names.

                  • (string) --
                • Paths (list) --

                  A JSON path to a variable in the data structure.

                  • (list) --
                    • (string) --
              • SelectFromCollection (dict) --

                Specifies a transform that chooses one DynamicFrame from a collection of DynamicFrames . The output is the selected DynamicFrame

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The data inputs identified by their node names.

                  • (string) --
                • Index (integer) --

                  The index for the DynamicFrame to be selected.

              • FillMissingValues (dict) --

                Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The data inputs identified by their node names.

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

                  A JSON path to a variable in the data structure for the dataset that is imputed.

                • FilledPath (string) --

                  A JSON path to a variable in the data structure for the dataset that is filled.

              • Filter (dict) --

                Specifies a transform that splits a dataset into two, based on a filter condition.

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The data inputs identified by their node names.

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

                  The operator used to filter rows by comparing the key value to a specified value.

                • Filters (list) --

                  Specifies a filter expression.

                  • (dict) --

                    Specifies a filter expression.

                    • Operation (string) --

                      The type of operation to perform in the expression.

                    • Negated (boolean) --

                      Whether the expression is to be negated.

                    • Values (list) --

                      A list of filter values.

                      • (dict) --

                        Represents a single entry in the list of values for a FilterExpression .

                        • Type (string) --

                          The type of filter value.

                        • Value (list) --

                          The value to be associated.

                          • (string) --
              • CustomCode (dict) --

                Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The data inputs identified by their node names.

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

                  The custom code that is used to perform the data transformation.

                • ClassName (string) --

                  The name defined for the custom code node class.

                • OutputSchemas (list) --

                  Specifies the data schema for the custom code transform.

                  • (dict) --

                    Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

                    • Columns (list) --

                      Specifies the column definitions that make up a Glue schema.

                      • (dict) --

                        Specifies a single column in a Glue schema definition.

                        • Name (string) --

                          The name of the column in the Glue Studio schema.

                        • Type (string) --

                          The hive type for this column in the Glue Studio schema.

              • SparkSQL (dict) --

                Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single DynamicFrame .

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The data inputs identified by their node names. You can associate a table name with each input node to use in the SQL query. The name you choose must meet the Spark SQL naming restrictions.

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

                  A SQL query that must use Spark SQL syntax and return a single data set.

                • SqlAliases (list) --

                  A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For example, you have a datasource named "MyDataSource". If you specify From as MyDataSource, and Alias as SqlName, then in your SQL you can do:

                  select * from SqlName

                  and that gets data from MyDataSource.

                  • (dict) --

                    Represents a single entry in the list of values for SqlAliases .

                    • From (string) --

                      A table, or a column in a table.

                    • Alias (string) --

                      A temporary name given to a table, or a column in a table.

                • OutputSchemas (list) --

                  Specifies the data schema for the SparkSQL transform.

                  • (dict) --

                    Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

                    • Columns (list) --

                      Specifies the column definitions that make up a Glue schema.

                      • (dict) --

                        Specifies a single column in a Glue schema definition.

                        • Name (string) --

                          The name of the column in the Glue Studio schema.

                        • Type (string) --

                          The hive type for this column in the Glue Studio schema.

              • DirectKinesisSource (dict) --

                Specifies a direct Amazon Kinesis data source.

                • Name (string) --

                  The name of the data source.

                • WindowSize (integer) --

                  The amount of time to spend processing each micro batch.

                • DetectSchema (boolean) --

                  Whether to automatically determine the schema from the incoming data.

                • StreamingOptions (dict) --

                  Additional options for the Kinesis streaming data source.

                  • EndpointUrl (string) --

                    The URL of the Kinesis endpoint.

                  • StreamName (string) --

                    The name of the Kinesis data stream.

                  • Classification (string) --

                    An optional classification.

                  • Delimiter (string) --

                    Specifies the delimiter character.

                  • StartingPosition (string) --

                    The starting position in the Kinesis data stream to read data from. The possible values are "latest" , "trim_horizon" , or "earliest" . The default value is "latest" .

                  • MaxFetchTimeInMs (integer) --

                    The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000 .

                  • MaxFetchRecordsPerShard (integer) --

                    The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000 .

                  • MaxRecordPerRead (integer) --

                    The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000 .

                  • AddIdleTimeBetweenReads (boolean) --

                    Adds a time delay between two consecutive getRecords operations. The default value is "False" . This option is only configurable for Glue version 2.0 and above.

                  • IdleTimeBetweenReadsInMs (integer) --

                    The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000 . This option is only configurable for Glue version 2.0 and above.

                  • DescribeShardInterval (integer) --

                    The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s .

                  • NumRetries (integer) --

                    The maximum number of retries for Kinesis Data Streams API requests. The default value is 3 .

                  • RetryIntervalMs (integer) --

                    The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000 .

                  • MaxRetryIntervalMs (integer) --

                    The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000 .

                  • AvoidEmptyBatches (boolean) --

                    Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False" .

                  • StreamArn (string) --

                    The Amazon Resource Name (ARN) of the Kinesis data stream.

                  • RoleArn (string) --

                    The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSSessionName" .

                  • RoleSessionName (string) --

                    An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSRoleARN" .

                • DataPreviewOptions (dict) --

                  Additional options for data preview.

                  • PollingTime (integer) --

                    The polling time in milliseconds.

                  • RecordPollingLimit (integer) --

                    The limit to the number of records polled.

              • DirectKafkaSource (dict) --

                Specifies an Apache Kafka data store.

                • Name (string) --

                  The name of the data store.

                • StreamingOptions (dict) --

                  Specifies the streaming options.

                  • BootstrapServers (string) --

                    A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094 . This option must be specified in the API call or defined in the table metadata in the Data Catalog.

                  • SecurityProtocol (string) --

                    The protocol used to communicate with brokers. The possible values are "SSL" or "PLAINTEXT" .

                  • ConnectionName (string) --

                    The name of the connection.

                  • TopicName (string) --

                    The topic name as specified in Apache Kafka. You must specify at least one of "topicName" , "assign" or "subscribePattern" .

                  • Assign (string) --

                    The specific TopicPartitions to consume. You must specify at least one of "topicName" , "assign" or "subscribePattern" .

                  • SubscribePattern (string) --

                    A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName" , "assign" or "subscribePattern" .

                  • Classification (string) --

                    An optional classification.

                  • Delimiter (string) --

                    Specifies the delimiter character.

                  • StartingOffsets (string) --

                    The starting position in the Kafka topic to read data from. The possible values are "earliest" or "latest" . The default value is "latest" .

                  • EndingOffsets (string) --

                    The end point when a batch query is ended. Possible values are either "latest" or a JSON string that specifies an ending offset for each TopicPartition .

                  • PollTimeoutMs (integer) --

                    The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512 .

                  • NumRetries (integer) --

                    The number of times to retry before failing to fetch Kafka offsets. The default value is 3 .

                  • RetryIntervalMs (integer) --

                    The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10 .

                  • MaxOffsetsPerTrigger (integer) --

                    The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.

                  • MinPartitions (integer) --

                    The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.

                • WindowSize (integer) --

                  The amount of time to spend processing each micro batch.

                • DetectSchema (boolean) --

                  Whether to automatically determine the schema from the incoming data.

                • DataPreviewOptions (dict) --

                  Specifies options related to data preview for viewing a sample of your data.

                  • PollingTime (integer) --

                    The polling time in milliseconds.

                  • RecordPollingLimit (integer) --

                    The limit to the number of records polled.

              • CatalogKinesisSource (dict) --

                Specifies a Kinesis data source in the Glue Data Catalog.

                • Name (string) --

                  The name of the data source.

                • WindowSize (integer) --

                  The amount of time to spend processing each micro batch.

                • DetectSchema (boolean) --

                  Whether to automatically determine the schema from the incoming data.

                • Table (string) --

                  The name of the table in the database to read from.

                • Database (string) --

                  The name of the database to read from.

                • StreamingOptions (dict) --

                  Additional options for the Kinesis streaming data source.

                  • EndpointUrl (string) --

                    The URL of the Kinesis endpoint.

                  • StreamName (string) --

                    The name of the Kinesis data stream.

                  • Classification (string) --

                    An optional classification.

                  • Delimiter (string) --

                    Specifies the delimiter character.

                  • StartingPosition (string) --

                    The starting position in the Kinesis data stream to read data from. The possible values are "latest" , "trim_horizon" , or "earliest" . The default value is "latest" .

                  • MaxFetchTimeInMs (integer) --

                    The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000 .

                  • MaxFetchRecordsPerShard (integer) --

                    The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000 .

                  • MaxRecordPerRead (integer) --

                    The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000 .

                  • AddIdleTimeBetweenReads (boolean) --

                    Adds a time delay between two consecutive getRecords operations. The default value is "False" . This option is only configurable for Glue version 2.0 and above.

                  • IdleTimeBetweenReadsInMs (integer) --

                    The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000 . This option is only configurable for Glue version 2.0 and above.

                  • DescribeShardInterval (integer) --

                    The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s .

                  • NumRetries (integer) --

                    The maximum number of retries for Kinesis Data Streams API requests. The default value is 3 .

                  • RetryIntervalMs (integer) --

                    The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000 .

                  • MaxRetryIntervalMs (integer) --

                    The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000 .

                  • AvoidEmptyBatches (boolean) --

                    Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False" .

                  • StreamArn (string) --

                    The Amazon Resource Name (ARN) of the Kinesis data stream.

                  • RoleArn (string) --

                    The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSSessionName" .

                  • RoleSessionName (string) --

                    An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSRoleARN" .

                • DataPreviewOptions (dict) --

                  Additional options for data preview.

                  • PollingTime (integer) --

                    The polling time in milliseconds.

                  • RecordPollingLimit (integer) --

                    The limit to the number of records polled.

              • CatalogKafkaSource (dict) --

                Specifies an Apache Kafka data store in the Data Catalog.

                • Name (string) --

                  The name of the data store.

                • WindowSize (integer) --

                  The amount of time to spend processing each micro batch.

                • DetectSchema (boolean) --

                  Whether to automatically determine the schema from the incoming data.

                • Table (string) --

                  The name of the table in the database to read from.

                • Database (string) --

                  The name of the database to read from.

                • StreamingOptions (dict) --

                  Specifies the streaming options.

                  • BootstrapServers (string) --

                    A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094 . This option must be specified in the API call or defined in the table metadata in the Data Catalog.

                  • SecurityProtocol (string) --

                    The protocol used to communicate with brokers. The possible values are "SSL" or "PLAINTEXT" .

                  • ConnectionName (string) --

                    The name of the connection.

                  • TopicName (string) --

                    The topic name as specified in Apache Kafka. You must specify at least one of "topicName" , "assign" or "subscribePattern" .

                  • Assign (string) --

                    The specific TopicPartitions to consume. You must specify at least one of "topicName" , "assign" or "subscribePattern" .

                  • SubscribePattern (string) --

                    A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName" , "assign" or "subscribePattern" .

                  • Classification (string) --

                    An optional classification.

                  • Delimiter (string) --

                    Specifies the delimiter character.

                  • StartingOffsets (string) --

                    The starting position in the Kafka topic to read data from. The possible values are "earliest" or "latest" . The default value is "latest" .

                  • EndingOffsets (string) --

                    The end point when a batch query is ended. Possible values are either "latest" or a JSON string that specifies an ending offset for each TopicPartition .

                  • PollTimeoutMs (integer) --

                    The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512 .

                  • NumRetries (integer) --

                    The number of times to retry before failing to fetch Kafka offsets. The default value is 3 .

                  • RetryIntervalMs (integer) --

                    The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10 .

                  • MaxOffsetsPerTrigger (integer) --

                    The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.

                  • MinPartitions (integer) --

                    The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.

                • DataPreviewOptions (dict) --

                  Specifies options related to data preview for viewing a sample of your data.

                  • PollingTime (integer) --

                    The polling time in milliseconds.

                  • RecordPollingLimit (integer) --

                    The limit to the number of records polled.

              • DropNullFields (dict) --

                Specifies a transform that removes columns from the dataset if all values in the column are 'null'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The data inputs identified by their node names.

                  • (string) --
                • NullCheckBoxList (dict) --

                  A structure that represents whether certain values are recognized as null values for removal.

                  • IsEmpty (boolean) --

                    Specifies that an empty string is considered as a null value.

                  • IsNullString (boolean) --

                    Specifies that a value spelling out the word 'null' is considered as a null value.

                  • IsNegOne (boolean) --

                    Specifies that an integer value of -1 is considered as a null value.

                • NullTextList (list) --

                  A structure that specifies a list of NullValueField structures that represent a custom null value such as zero or other value being used as a null placeholder unique to the dataset.

                  The DropNullFields transform removes custom null values only if both the value of the null placeholder and the datatype match the data.

                  • (dict) --

                    Represents a custom null value such as a zeros or other value being used as a null placeholder unique to the dataset.

                    • Value (string) --

                      The value of the null placeholder.

                    • Datatype (dict) --

                      The datatype of the value.

                      • Id (string) --

                        The datatype of the value.

                      • Label (string) --

                        A label assigned to the datatype.

              • Merge (dict) --

                Specifies a transform that merges a DynamicFrame with a staging DynamicFrame based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The data inputs identified by their node names.

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

                  The source DynamicFrame that will be merged with a staging DynamicFrame .

                • PrimaryKeys (list) --

                  The list of primary key fields to match records from the source and staging dynamic frames.

                  • (list) --
                    • (string) --
              • Union (dict) --

                Specifies a transform that combines the rows from two or more datasets into a single result.

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The node ID inputs to the transform.

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

                  Indicates the type of Union transform.

                  Specify ALL to join all rows from data sources to the resulting DynamicFrame. The resulting union does not remove duplicate rows.

                  Specify DISTINCT to remove duplicate rows in the resulting DynamicFrame.

              • PIIDetection (dict) --

                Specifies a transform that identifies, removes or masks PII data.

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The node ID inputs to the transform.

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

                  Indicates the type of PIIDetection transform.

                • EntityTypesToDetect (list) --

                  Indicates the types of entities the PIIDetection transform will identify as PII data.

                  PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE

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

                  Indicates the output column name that will contain any entity type detected in that row.

                • SampleFraction (float) --

                  Indicates the fraction of the data to sample when scanning for PII entities.

                • ThresholdFraction (float) --

                  Indicates the fraction of the data that must be met in order for a column to be identified as PII data.

                • MaskValue (string) --

                  Indicates the value that will replace the detected entity.

              • Aggregate (dict) --

                Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  Specifies the fields and rows to use as inputs for the aggregate transform.

                  • (string) --
                • Groups (list) --

                  Specifies the fields to group by.

                  • (list) --
                    • (string) --
                • Aggs (list) --

                  Specifies the aggregate functions to be performed on specified fields.

                  • (dict) --

                    Specifies the set of parameters needed to perform aggregation in the aggregate transform.

                    • Column (list) --

                      Specifies the column on the data set on which the aggregation function will be applied.

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

                      Specifies the aggregation function to apply.

                      Possible aggregation functions include: avg countDistinct, count, first, last, kurtosis, max, min, skewness, stddev_samp, stddev_pop, sum, sumDistinct, var_samp, var_pop

              • DropDuplicates (dict) --

                Specifies a transform that removes rows of repeating data from a data set.

                • Name (string) --

                  The name of the transform node.

                • Inputs (list) --

                  The data inputs identified by their node names.

                  • (string) --
                • Columns (list) --

                  The name of the columns to be merged or removed if repeating.

                  • (list) --
                    • (string) --
              • GovernedCatalogTarget (dict) --

                Specifies a data target that writes to a goverened catalog.

                • Name (string) --

                  The name of the data target.

                • Inputs (list) --

                  The nodes that are inputs to the data target.

                  • (string) --
                • PartitionKeys (list) --

                  Specifies native partitioning using a sequence of keys.

                  • (list) --
                    • (string) --
                • Table (string) --

                  The name of the table in the database to write to.

                • Database (string) --

                  The name of the database to write to.

                • SchemaChangePolicy (dict) --

                  A policy that specifies update behavior for the governed catalog.

                  • EnableUpdateCatalog (boolean) --

                    Whether to use the specified update behavior when the crawler finds a changed schema.

                  • UpdateBehavior (string) --

                    The update behavior when the crawler finds a changed schema.

              • GovernedCatalogSource (dict) --

                Specifies a data source in a goverened Data Catalog.

                • Name (string) --

                  The name of the data store.

                • Database (string) --

                  The database to read from.

                • Table (string) --

                  The database table to read from.

                • PartitionPredicate (string) --

                  Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to "" – empty by default.

                • AdditionalOptions (dict) --

                  Specifies additional connection options.

                  • BoundedSize (integer) --

                    Sets the upper limit for the target size of the dataset in bytes that will be processed.

                  • BoundedFiles (integer) --

                    Sets the upper limit for the target number of files that will be processed.

              • MicrosoftSQLServerCatalogSource (dict) --

                Specifies a Microsoft SQL server data source in the Glue Data Catalog.

                • Name (string) --

                  The name of the data source.

                • Database (string) --

                  The name of the database to read from.

                • Table (string) --

                  The name of the table in the database to read from.

              • MySQLCatalogSource (dict) --

                Specifies a MySQL data source in the Glue Data Catalog.

                • Name (string) --

                  The name of the data source.

                • Database (string) --

                  The name of the database to read from.

                • Table (string) --

                  The name of the table in the database to read from.

              • OracleSQLCatalogSource (dict) --

                Specifies an Oracle data source in the Glue Data Catalog.

                • Name (string) --

                  The name of the data source.

                • Database (string) --

                  The name of the database to read from.

                • Table (string) --

                  The name of the table in the database to read from.

              • PostgreSQLCatalogSource (dict) --

                Specifies a PostgresSQL data source in the Glue Data Catalog.

                • Name (string) --

                  The name of the data source.

                • Database (string) --

                  The name of the database to read from.

                • Table (string) --

                  The name of the table in the database to read from.

              • MicrosoftSQLServerCatalogTarget (dict) --

                Specifies a target that uses Microsoft SQL.

                • Name (string) --

                  The name of the data target.

                • Inputs (list) --

                  The nodes that are inputs to the data target.

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

                  The name of the database to write to.

                • Table (string) --

                  The name of the table in the database to write to.

              • MySQLCatalogTarget (dict) --

                Specifies a target that uses MySQL.

                • Name (string) --

                  The name of the data target.

                • Inputs (list) --

                  The nodes that are inputs to the data target.

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

                  The name of the database to write to.

                • Table (string) --

                  The name of the table in the database to write to.

              • OracleSQLCatalogTarget (dict) --

                Specifies a target that uses Oracle SQL.

                • Name (string) --

                  The name of the data target.

                • Inputs (list) --

                  The nodes that are inputs to the data target.

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

                  The name of the database to write to.

                • Table (string) --

                  The name of the table in the database to write to.

              • PostgreSQLCatalogTarget (dict) --

                Specifies a target that uses Postgres SQL.

                • Name (string) --

                  The name of the data target.

                • Inputs (list) --

                  The nodes that are inputs to the data target.

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

                  The name of the database to write to.

                • Table (string) --

                  The name of the table in the database to write to.

        • ExecutionClass (string) --

          Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

          The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

          Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX . The flexible execution class is available for Spark jobs.

    • JobsNotFound (list) --

      A list of names of jobs not found.

      • (string) --

Exceptions

  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InvalidInputException
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 Amazon Web Services 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',
                        'Parameters': {
                            'string': 'string'
                        }
                    },
                ],
                'Location': 'string',
                'AdditionalLocations': [
                    'string',
                ],
                'InputFormat': 'string',
                'OutputFormat': 'string',
                'Compressed': True|False,
                'NumberOfBuckets': 123,
                'SerdeInfo': {
                    'Name': 'string',
                    'SerializationLibrary': 'string',
                    'Parameters': {
                        'string': 'string'
                    }
                },
                'BucketColumns': [
                    'string',
                ],
                'SortColumns': [
                    {
                        'Column': 'string',
                        'SortOrder': 123
                    },
                ],
                'Parameters': {
                    'string': 'string'
                },
                'SkewedInfo': {
                    'SkewedColumnNames': [
                        'string',
                    ],
                    'SkewedColumnValues': [
                        'string',
                    ],
                    'SkewedColumnValueLocationMaps': {
                        'string': 'string'
                    }
                },
                'StoredAsSubDirectories': True|False,
                'SchemaReference': {
                    'SchemaId': {
                        'SchemaArn': 'string',
                        'SchemaName': 'string',
                        'RegistryName': 'string'
                    },
                    'SchemaVersionId': 'string',
                    'SchemaVersionNumber': 123
                }
            },
            'Parameters': {
                'string': 'string'
            },
            'LastAnalyzedTime': datetime(2015, 1, 1),
            'CatalogId': 'string'
        },
    ],
    'UnprocessedKeys': [
        {
            'Values': [
                'string',
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • Partitions (list) --

      A list of the requested partitions.

      • (dict) --

        Represents a slice of table data.

        • Values (list) --

          The values of the partition.

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

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

        • TableName (string) --

          The name of the database table in which to create the partition.

        • CreationTime (datetime) --

          The time at which the partition was created.

        • LastAccessTime (datetime) --

          The last time at which the partition was accessed.

        • StorageDescriptor (dict) --

          Provides information about the physical location where the partition is stored.

          • Columns (list) --

            A list of the Columns in the table.

            • (dict) --

              A column in a Table .

              • Name (string) --

                The name of the Column .

              • Type (string) --

                The data type of the Column .

              • Comment (string) --

                A free-form text comment.

              • Parameters (dict) --

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

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

          • AdditionalLocations (list) --

            A list of locations that point to the path where a Delta table is located.

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

            The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.

          • OutputFormat (string) --

            The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.

          • Compressed (boolean) --

            True if the data in the table is compressed, or False if not.

          • NumberOfBuckets (integer) --

            Must be specified if the table contains any dimension columns.

          • SerdeInfo (dict) --

            The serialization/deserialization (SerDe) information.

            • Name (string) --

              Name of the SerDe.

            • SerializationLibrary (string) --

              Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .

            • Parameters (dict) --

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

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

            The user-supplied properties in key-value form.

            • (string) --
              • (string) --
          • SkewedInfo (dict) --

            The information about values that appear frequently in a column (skewed values).

            • SkewedColumnNames (list) --

              A list of names of columns that contain skewed values.

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

          • SchemaReference (dict) --

            An object that references a schema stored in the Glue Schema Registry.

            When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

            • SchemaId (dict) --

              A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.

              • SchemaArn (string) --

                The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.

              • SchemaName (string) --

                The name of the schema. One of SchemaArn or SchemaName has to be provided.

              • RegistryName (string) --

                The name of the schema registry that contains the schema.

            • SchemaVersionId (string) --

              The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.

            • SchemaVersionNumber (integer) --

              The version number of the schema.

        • Parameters (dict) --

          These key-value pairs define partition parameters.

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

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

        • CatalogId (string) --

          The ID of the Data Catalog in which the partition resides.

    • UnprocessedKeys (list) --

      A list of the partition values in the request for which partitions were not returned.

      • (dict) --

        Contains a list of values defining partitions.

        • Values (list) --

          The list of values.

          • (string) --

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.GlueEncryptionException
  • Glue.Client.exceptions.InvalidStateException
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'|'EVENT',
            'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
            'Description': 'string',
            'Schedule': 'string',
            'Actions': [
                {
                    'JobName': 'string',
                    'Arguments': {
                        'string': 'string'
                    },
                    'Timeout': 123,
                    'SecurityConfiguration': 'string',
                    'NotificationProperty': {
                        'NotifyDelayAfter': 123
                    },
                    'CrawlerName': 'string'
                },
            ],
            'Predicate': {
                'Logical': 'AND'|'ANY',
                'Conditions': [
                    {
                        'LogicalOperator': 'EQUALS',
                        'JobName': 'string',
                        'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT'|'ERROR'|'WAITING',
                        'CrawlerName': 'string',
                        'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'|'ERROR'
                    },
                ]
            },
            'EventBatchingCondition': {
                'BatchSize': 123,
                'BatchWindow': 123
            }
        },
    ],
    '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 run.

            • Arguments (dict) --

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

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

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

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

              • (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 only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .

              • CrawlerName (string) --

                The name of the crawler to which this condition applies.

              • CrawlState (string) --

                The state of the crawler to which this condition applies.

        • EventBatchingCondition (dict) --

          Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.

          • BatchSize (integer) --

            Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.

          • BatchWindow (integer) --

            Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.

    • TriggersNotFound (list) --

      A list of names of triggers not found.

      • (string) --

Exceptions

  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InvalidInputException
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',
                'PreviousRunId': 'string',
                'WorkflowRunProperties': {
                    'string': 'string'
                },
                'StartedOn': datetime(2015, 1, 1),
                'CompletedOn': datetime(2015, 1, 1),
                'Status': 'RUNNING'|'COMPLETED'|'STOPPING'|'STOPPED'|'ERROR',
                'ErrorMessage': 'string',
                'Statistics': {
                    'TotalActions': 123,
                    'TimeoutActions': 123,
                    'FailedActions': 123,
                    'StoppedActions': 123,
                    'SucceededActions': 123,
                    'RunningActions': 123,
                    'ErroredActions': 123,
                    'WaitingActions': 123
                },
                'Graph': {
                    'Nodes': [
                        {
                            'Type': 'CRAWLER'|'JOB'|'TRIGGER',
                            'Name': 'string',
                            'UniqueId': 'string',
                            'TriggerDetails': {
                                'Trigger': {
                                    'Name': 'string',
                                    'WorkflowName': 'string',
                                    'Id': 'string',
                                    'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND'|'EVENT',
                                    'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
                                    'Description': 'string',
                                    'Schedule': 'string',
                                    'Actions': [
                                        {
                                            'JobName': 'string',
                                            'Arguments': {
                                                'string': 'string'
                                            },
                                            'Timeout': 123,
                                            'SecurityConfiguration': 'string',
                                            'NotificationProperty': {
                                                'NotifyDelayAfter': 123
                                            },
                                            'CrawlerName': 'string'
                                        },
                                    ],
                                    'Predicate': {
                                        'Logical': 'AND'|'ANY',
                                        'Conditions': [
                                            {
                                                'LogicalOperator': 'EQUALS',
                                                'JobName': 'string',
                                                'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT'|'ERROR'|'WAITING',
                                                'CrawlerName': 'string',
                                                'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'|'ERROR'
                                            },
                                        ]
                                    },
                                    'EventBatchingCondition': {
                                        'BatchSize': 123,
                                        'BatchWindow': 123
                                    }
                                }
                            },
                            'JobDetails': {
                                'JobRuns': [
                                    {
                                        'Id': 'string',
                                        'Attempt': 123,
                                        'PreviousRunId': 'string',
                                        'TriggerName': 'string',
                                        'JobName': 'string',
                                        'StartedOn': datetime(2015, 1, 1),
                                        'LastModifiedOn': datetime(2015, 1, 1),
                                        'CompletedOn': datetime(2015, 1, 1),
                                        'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT'|'ERROR'|'WAITING',
                                        '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'|'G.025X',
                                        'NumberOfWorkers': 123,
                                        'SecurityConfiguration': 'string',
                                        'LogGroupName': 'string',
                                        'NotificationProperty': {
                                            'NotifyDelayAfter': 123
                                        },
                                        'GlueVersion': 'string',
                                        'DPUSeconds': 123.0,
                                        'ExecutionClass': 'FLEX'|'STANDARD'
                                    },
                                ]
                            },
                            'CrawlerDetails': {
                                'Crawls': [
                                    {
                                        'State': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'|'ERROR',
                                        'StartedOn': datetime(2015, 1, 1),
                                        'CompletedOn': datetime(2015, 1, 1),
                                        'ErrorMessage': 'string',
                                        'LogGroup': 'string',
                                        'LogStream': 'string'
                                    },
                                ]
                            }
                        },
                    ],
                    'Edges': [
                        {
                            'SourceId': 'string',
                            'DestinationId': 'string'
                        },
                    ]
                },
                'StartingEventBatchCondition': {
                    'BatchSize': 123,
                    'BatchWindow': 123
                }
            },
            'Graph': {
                'Nodes': [
                    {
                        'Type': 'CRAWLER'|'JOB'|'TRIGGER',
                        'Name': 'string',
                        'UniqueId': 'string',
                        'TriggerDetails': {
                            'Trigger': {
                                'Name': 'string',
                                'WorkflowName': 'string',
                                'Id': 'string',
                                'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND'|'EVENT',
                                'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
                                'Description': 'string',
                                'Schedule': 'string',
                                'Actions': [
                                    {
                                        'JobName': 'string',
                                        'Arguments': {
                                            'string': 'string'
                                        },
                                        'Timeout': 123,
                                        'SecurityConfiguration': 'string',
                                        'NotificationProperty': {
                                            'NotifyDelayAfter': 123
                                        },
                                        'CrawlerName': 'string'
                                    },
                                ],
                                'Predicate': {
                                    'Logical': 'AND'|'ANY',
                                    'Conditions': [
                                        {
                                            'LogicalOperator': 'EQUALS',
                                            'JobName': 'string',
                                            'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT'|'ERROR'|'WAITING',
                                            'CrawlerName': 'string',
                                            'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'|'ERROR'
                                        },
                                    ]
                                },
                                'EventBatchingCondition': {
                                    'BatchSize': 123,
                                    'BatchWindow': 123
                                }
                            }
                        },
                        'JobDetails': {
                            'JobRuns': [
                                {
                                    'Id': 'string',
                                    'Attempt': 123,
                                    'PreviousRunId': 'string',
                                    'TriggerName': 'string',
                                    'JobName': 'string',
                                    'StartedOn': datetime(2015, 1, 1),
                                    'LastModifiedOn': datetime(2015, 1, 1),
                                    'CompletedOn': datetime(2015, 1, 1),
                                    'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT'|'ERROR'|'WAITING',
                                    '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'|'G.025X',
                                    'NumberOfWorkers': 123,
                                    'SecurityConfiguration': 'string',
                                    'LogGroupName': 'string',
                                    'NotificationProperty': {
                                        'NotifyDelayAfter': 123
                                    },
                                    'GlueVersion': 'string',
                                    'DPUSeconds': 123.0,
                                    'ExecutionClass': 'FLEX'|'STANDARD'
                                },
                            ]
                        },
                        'CrawlerDetails': {
                            'Crawls': [
                                {
                                    'State': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'|'ERROR',
                                    'StartedOn': datetime(2015, 1, 1),
                                    'CompletedOn': datetime(2015, 1, 1),
                                    'ErrorMessage': 'string',
                                    'LogGroup': 'string',
                                    'LogStream': 'string'
                                },
                            ]
                        }
                    },
                ],
                'Edges': [
                    {
                        'SourceId': 'string',
                        'DestinationId': 'string'
                    },
                ]
            },
            'MaxConcurrentRuns': 123,
            'BlueprintDetails': {
                'BlueprintName': 'string',
                'RunId': 'string'
            }
        },
    ],
    'MissingWorkflows': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • Workflows (list) --

      A list of workflow resource metadata.

      • (dict) --

        A workflow is a collection of multiple dependent Glue jobs and crawlers that are run to complete a complex ETL task. A workflow manages the execution and monitoring of all its jobs and crawlers.

        • Name (string) --

          The name of the workflow.

        • Description (string) --

          A description of the workflow.

        • DefaultRunProperties (dict) --

          A collection of properties to be used as part of each execution of the workflow. The run properties are made available to each job in the workflow. A job can modify the properties for the next jobs in the flow.

          • (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 that was run.

          • WorkflowRunId (string) --

            The ID of this workflow run.

          • PreviousRunId (string) --

            The ID of the previous workflow run.

          • WorkflowRunProperties (dict) --

            The workflow run properties which were set during the run.

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

          • ErrorMessage (string) --

            This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo ."

          • Statistics (dict) --

            The statistics of the run.

            • TotalActions (integer) --

              Total number of Actions in the workflow run.

            • TimeoutActions (integer) --

              Total number of Actions that timed out.

            • FailedActions (integer) --

              Total number of Actions that have failed.

            • StoppedActions (integer) --

              Total number of Actions that have stopped.

            • SucceededActions (integer) --

              Total number of Actions that have succeeded.

            • RunningActions (integer) --

              Total number Actions in running state.

            • ErroredActions (integer) --

              Indicates the count of job runs in the ERROR state in the workflow run.

            • WaitingActions (integer) --

              Indicates the count of job runs in WAITING state in the workflow run.

          • Graph (dict) --

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

            • Nodes (list) --

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

              • (dict) --

                A node represents an Glue component (trigger, crawler, or job) on a workflow graph.

                • Type (string) --

                  The type of Glue component represented by the node.

                • Name (string) --

                  The name of the Glue component represented by the node.

                • UniqueId (string) --

                  The unique Id assigned to the node within the workflow.

                • TriggerDetails (dict) --

                  Details of the Trigger when the node represents a Trigger.

                  • Trigger (dict) --

                    The information of the trigger represented by the trigger node.

                    • Name (string) --

                      The name of the trigger.

                    • WorkflowName (string) --

                      The name of the workflow associated with the trigger.

                    • Id (string) --

                      Reserved for future use.

                    • Type (string) --

                      The type of trigger that this is.

                    • State (string) --

                      The current state of the trigger.

                    • Description (string) --

                      A description of this trigger.

                    • Schedule (string) --

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

                    • Actions (list) --

                      The actions initiated by this trigger.

                      • (dict) --

                        Defines an action to be initiated by a trigger.

                        • JobName (string) --

                          The name of a job to be run.

                        • Arguments (dict) --

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

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

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

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

                          • (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 only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .

                          • CrawlerName (string) --

                            The name of the crawler to which this condition applies.

                          • CrawlState (string) --

                            The state of the crawler to which this condition applies.

                    • EventBatchingCondition (dict) --

                      Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.

                      • BatchSize (integer) --

                        Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.

                      • BatchWindow (integer) --

                        Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.

                • JobDetails (dict) --

                  Details of the Job when the node represents a Job.

                  • JobRuns (list) --

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

                    • (dict) --

                      Contains information about a job run.

                      • Id (string) --

                        The ID of this job run.

                      • Attempt (integer) --

                        The number of the attempt to run this job.

                      • PreviousRunId (string) --

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

                      • TriggerName (string) --

                        The name of the trigger that started this job run.

                      • JobName (string) --

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

                      • StartedOn (datetime) --

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

                      • LastModifiedOn (datetime) --

                        The last time that this job run was modified.

                      • CompletedOn (datetime) --

                        The date and time that this job run completed.

                      • JobRunState (string) --

                        The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses .

                      • Arguments (dict) --

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

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

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

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

                        • (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 Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .

                      • ExecutionTime (integer) --

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

                      • Timeout (integer) --

                        The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.

                        Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).

                      • MaxCapacity (float) --

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

                        Do not set Max Capacity if using WorkerType and NumberOfWorkers .

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

                        • 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 a minimum of 2 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, G.2X, or G.025X.

                        • 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.
                        • For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
                      • NumberOfWorkers (integer) --

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

                      • SecurityConfiguration (string) --

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

                      • LogGroupName (string) --

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

                      • NotificationProperty (dict) --

                        Specifies configuration properties of a job run notification.

                        • NotifyDelayAfter (integer) --

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

                      • GlueVersion (string) --

                        Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

                        For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

                        Jobs that are created without specifying a Glue version default to Glue 0.9.

                      • DPUSeconds (float) --

                        This field populates only for Auto Scaling job runs, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 for G.1X , 2 for G.2X , or 0.25 for G.025X workers). This value may be different than the executionEngineRuntime * MaxCapacity as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than the MaxCapacity . Therefore, it is possible that the value of DPUSeconds is less than executionEngineRuntime * MaxCapacity .

                      • ExecutionClass (string) --

                        Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

                        The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

                        Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX . The flexible execution class is available for Spark jobs.

                • 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 Glue components that 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.

          • StartingEventBatchCondition (dict) --

            The batch condition that started the workflow run.

            • BatchSize (integer) --

              Number of events in the batch.

            • BatchWindow (integer) --

              Duration of the batch window in seconds.

        • Graph (dict) --

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

          • Nodes (list) --

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

            • (dict) --

              A node represents an Glue component (trigger, crawler, or job) on a workflow graph.

              • Type (string) --

                The type of Glue component represented by the node.

              • Name (string) --

                The name of the Glue component represented by the node.

              • UniqueId (string) --

                The unique Id assigned to the node within the workflow.

              • TriggerDetails (dict) --

                Details of the Trigger when the node represents a Trigger.

                • Trigger (dict) --

                  The information of the trigger represented by the trigger node.

                  • Name (string) --

                    The name of the trigger.

                  • WorkflowName (string) --

                    The name of the workflow associated with the trigger.

                  • Id (string) --

                    Reserved for future use.

                  • Type (string) --

                    The type of trigger that this is.

                  • State (string) --

                    The current state of the trigger.

                  • Description (string) --

                    A description of this trigger.

                  • Schedule (string) --

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

                  • Actions (list) --

                    The actions initiated by this trigger.

                    • (dict) --

                      Defines an action to be initiated by a trigger.

                      • JobName (string) --

                        The name of a job to be run.

                      • Arguments (dict) --

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

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

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

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

                        • (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 only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .

                        • CrawlerName (string) --

                          The name of the crawler to which this condition applies.

                        • CrawlState (string) --

                          The state of the crawler to which this condition applies.

                  • EventBatchingCondition (dict) --

                    Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.

                    • BatchSize (integer) --

                      Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.

                    • BatchWindow (integer) --

                      Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.

              • JobDetails (dict) --

                Details of the Job when the node represents a Job.

                • JobRuns (list) --

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

                  • (dict) --

                    Contains information about a job run.

                    • Id (string) --

                      The ID of this job run.

                    • Attempt (integer) --

                      The number of the attempt to run this job.

                    • PreviousRunId (string) --

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

                    • TriggerName (string) --

                      The name of the trigger that started this job run.

                    • JobName (string) --

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

                    • StartedOn (datetime) --

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

                    • LastModifiedOn (datetime) --

                      The last time that this job run was modified.

                    • CompletedOn (datetime) --

                      The date and time that this job run completed.

                    • JobRunState (string) --

                      The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses .

                    • Arguments (dict) --

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

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

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

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

                      • (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 Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .

                    • ExecutionTime (integer) --

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

                    • Timeout (integer) --

                      The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.

                      Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).

                    • MaxCapacity (float) --

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

                      Do not set Max Capacity if using WorkerType and NumberOfWorkers .

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

                      • 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 a minimum of 2 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, G.2X, or G.025X.

                      • 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.
                      • For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
                    • NumberOfWorkers (integer) --

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

                    • SecurityConfiguration (string) --

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

                    • LogGroupName (string) --

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

                    • NotificationProperty (dict) --

                      Specifies configuration properties of a job run notification.

                      • NotifyDelayAfter (integer) --

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

                    • GlueVersion (string) --

                      Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

                      For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

                      Jobs that are created without specifying a Glue version default to Glue 0.9.

                    • DPUSeconds (float) --

                      This field populates only for Auto Scaling job runs, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 for G.1X , 2 for G.2X , or 0.25 for G.025X workers). This value may be different than the executionEngineRuntime * MaxCapacity as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than the MaxCapacity . Therefore, it is possible that the value of DPUSeconds is less than executionEngineRuntime * MaxCapacity .

                    • ExecutionClass (string) --

                      Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

                      The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

                      Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX . The flexible execution class is available for Spark jobs.

              • 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 Glue components that 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.

        • MaxConcurrentRuns (integer) --

          You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.

        • BlueprintDetails (dict) --

          This structure indicates the details of the blueprint that this particular workflow is created from.

          • BlueprintName (string) --

            The name of the blueprint.

          • RunId (string) --

            The run ID for this blueprint.

    • MissingWorkflows (list) --

      A list of names of workflows not found.

      • (string) --

Exceptions

  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InvalidInputException
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.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
batch_update_partition(**kwargs)

Updates one or more partitions in a batch operation.

See also: AWS API Documentation

Request Syntax

response = client.batch_update_partition(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    Entries=[
        {
            'PartitionValueList': [
                'string',
            ],
            'PartitionInput': {
                'Values': [
                    'string',
                ],
                'LastAccessTime': datetime(2015, 1, 1),
                'StorageDescriptor': {
                    'Columns': [
                        {
                            'Name': 'string',
                            'Type': 'string',
                            'Comment': 'string',
                            'Parameters': {
                                'string': 'string'
                            }
                        },
                    ],
                    'Location': 'string',
                    'AdditionalLocations': [
                        'string',
                    ],
                    'InputFormat': 'string',
                    'OutputFormat': 'string',
                    'Compressed': True|False,
                    'NumberOfBuckets': 123,
                    'SerdeInfo': {
                        'Name': 'string',
                        'SerializationLibrary': 'string',
                        'Parameters': {
                            'string': 'string'
                        }
                    },
                    'BucketColumns': [
                        'string',
                    ],
                    'SortColumns': [
                        {
                            'Column': 'string',
                            'SortOrder': 123
                        },
                    ],
                    'Parameters': {
                        'string': 'string'
                    },
                    'SkewedInfo': {
                        'SkewedColumnNames': [
                            'string',
                        ],
                        'SkewedColumnValues': [
                            'string',
                        ],
                        'SkewedColumnValueLocationMaps': {
                            'string': 'string'
                        }
                    },
                    'StoredAsSubDirectories': True|False,
                    'SchemaReference': {
                        'SchemaId': {
                            'SchemaArn': 'string',
                            'SchemaName': 'string',
                            'RegistryName': 'string'
                        },
                        'SchemaVersionId': 'string',
                        'SchemaVersionNumber': 123
                    }
                },
                'Parameters': {
                    'string': 'string'
                },
                'LastAnalyzedTime': datetime(2015, 1, 1)
            }
        },
    ]
)
Parameters
  • CatalogId (string) -- The ID of the catalog in which the partition is to be updated. Currently, this should be the Amazon Web Services account ID.
  • DatabaseName (string) --

    [REQUIRED]

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

  • TableName (string) --

    [REQUIRED]

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

  • Entries (list) --

    [REQUIRED]

    A list of up to 100 BatchUpdatePartitionRequestEntry objects to update.

    • (dict) --

      A structure that contains the values and structure used to update a partition.

      • PartitionValueList (list) -- [REQUIRED]

        A list of values defining the partitions.

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

        The structure used to update a 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.

          The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.

          • (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 data type of the Column .

              • Comment (string) --

                A free-form text comment.

              • Parameters (dict) --

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

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

          • AdditionalLocations (list) --

            A list of locations that point to the path where a Delta table is located.

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

            The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.

          • OutputFormat (string) --

            The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.

          • Compressed (boolean) --
            True if the data in the table is compressed, or False if not.
          • NumberOfBuckets (integer) --

            Must be specified if the table contains any dimension columns.

          • SerdeInfo (dict) --

            The serialization/deserialization (SerDe) information.

            • Name (string) --

              Name of the SerDe.

            • SerializationLibrary (string) --

              Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .

            • Parameters (dict) --

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

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

            The user-supplied properties in key-value form.

            • (string) --
              • (string) --
          • SkewedInfo (dict) --

            The information about values that appear frequently in a column (skewed values).

            • SkewedColumnNames (list) --

              A list of names of columns that contain skewed values.

              • (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.
          • SchemaReference (dict) --

            An object that references a schema stored in the Glue Schema Registry.

            When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

            • SchemaId (dict) --

              A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.

              • SchemaArn (string) --

                The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.

              • SchemaName (string) --

                The name of the schema. One of SchemaArn or SchemaName has to be provided.

              • RegistryName (string) --

                The name of the schema registry that contains the schema.

            • SchemaVersionId (string) --

              The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.

            • SchemaVersionNumber (integer) --

              The version number of the schema.

        • Parameters (dict) --

          These key-value pairs define partition parameters.

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

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

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • Errors (list) --

      The errors encountered when trying to update the requested partitions. A list of BatchUpdatePartitionFailureEntry objects.

      • (dict) --

        Contains information about a batch update partition error.

        • PartitionValueList (list) --

          A list of values defining the partitions.

          • (string) --
        • ErrorDetail (dict) --

          The details about the batch update partition error.

          • ErrorCode (string) --

            The code associated with this error.

          • ErrorMessage (string) --

            A message describing the error.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.GlueEncryptionException
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.
cancel_ml_task_run(**kwargs)

Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can cancel a machine learning task run at any time by calling CancelMLTaskRun with a task run's parent transform's TransformID and the task run's TaskRunId .

See also: AWS API Documentation

Request Syntax

response = client.cancel_ml_task_run(
    TransformId='string',
    TaskRunId='string'
)
Parameters
  • TransformId (string) --

    [REQUIRED]

    The unique identifier of the machine learning transform.

  • TaskRunId (string) --

    [REQUIRED]

    A unique identifier for the task run.

Return type

dict

Returns

Response Syntax

{
    'TransformId': 'string',
    'TaskRunId': 'string',
    'Status': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT'
}

Response Structure

  • (dict) --

    • TransformId (string) --

      The unique identifier of the machine learning transform.

    • TaskRunId (string) --

      The unique identifier for the task run.

    • Status (string) --

      The status for this run.

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InternalServiceException
cancel_statement(**kwargs)

Cancels the statement.

See also: AWS API Documentation

Request Syntax

response = client.cancel_statement(
    SessionId='string',
    Id=123,
    RequestOrigin='string'
)
Parameters
  • SessionId (string) --

    [REQUIRED]

    The Session ID of the statement to be cancelled.

  • Id (integer) --

    [REQUIRED]

    The ID of the statement to be cancelled.

  • RequestOrigin (string) -- The origin of the request to cancel the statement.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Glue.Client.exceptions.AccessDeniedException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.IllegalSessionStateException
check_schema_version_validity(**kwargs)

Validates the supplied schema. This call has no side effects, it simply validates using the supplied schema using DataFormat as the format. Since it does not take a schema set name, no compatibility checks are performed.

See also: AWS API Documentation

Request Syntax

response = client.check_schema_version_validity(
    DataFormat='AVRO'|'JSON'|'PROTOBUF',
    SchemaDefinition='string'
)
Parameters
  • DataFormat (string) --

    [REQUIRED]

    The data format of the schema definition. Currently AVRO , JSON and PROTOBUF are supported.

  • SchemaDefinition (string) --

    [REQUIRED]

    The definition of the schema that has to be validated.

Return type

dict

Returns

Response Syntax

{
    'Valid': True|False,
    'Error': 'string'
}

Response Structure

  • (dict) --

    • Valid (boolean) --

      Return true, if the schema is valid and false otherwise.

    • Error (string) --

      A validation failure error message.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.AccessDeniedException
  • Glue.Client.exceptions.InternalServiceException
close()

Closes underlying endpoint connections.

create_blueprint(**kwargs)

Registers a blueprint with Glue.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The name of the blueprint.

  • Description (string) -- A description of the blueprint.
  • BlueprintLocation (string) --

    [REQUIRED]

    Specifies a path in Amazon S3 where the blueprint is published.

  • Tags (dict) --

    The tags to be applied to this blueprint.

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

dict

Returns

Response Syntax

{
    'Name': 'string'
}

Response Structure

  • (dict) --

    • Name (string) --

      Returns the name of the blueprint that was registered.

Exceptions

  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
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. 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) --

Exceptions

  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.OperationTimeoutException
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'|'MONGODB'|'KAFKA'|'NETWORK'|'MARKETPLACE'|'CUSTOM',
        'MatchCriteria': [
            'string',
        ],
        'ConnectionProperties': {
            'string': 'string'
        },
        'PhysicalConnectionRequirements': {
            'SubnetId': 'string',
            'SecurityGroupIdList': [
                'string',
            ],
            'AvailabilityZone': 'string'
        }
    },
    Tags={
        'string': 'string'
    }
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog in which to create the connection. If none is provided, the Amazon Web Services 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, these types are supported:

      • JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).
      • KAFKA - Designates a connection to an Apache Kafka streaming platform.
      • MONGODB - Designates a connection to a MongoDB document database.
      • NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).
      • MARKETPLACE - Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.
      • CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.

      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.

  • Tags (dict) --

    The tags you assign to the connection.

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

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
  • Glue.Client.exceptions.GlueEncryptionException
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',
                ],
                'ConnectionName': 'string',
                'SampleSize': 123,
                'EventQueueArn': 'string',
                'DlqEventQueueArn': 'string'
            },
        ],
        'JdbcTargets': [
            {
                'ConnectionName': 'string',
                'Path': 'string',
                'Exclusions': [
                    'string',
                ]
            },
        ],
        'MongoDBTargets': [
            {
                'ConnectionName': 'string',
                'Path': 'string',
                'ScanAll': True|False
            },
        ],
        'DynamoDBTargets': [
            {
                'Path': 'string',
                'scanAll': True|False,
                'scanRate': 123.0
            },
        ],
        'CatalogTargets': [
            {
                'DatabaseName': 'string',
                'Tables': [
                    'string',
                ],
                'ConnectionName': 'string'
            },
        ],
        'DeltaTargets': [
            {
                'DeltaTables': [
                    'string',
                ],
                'ConnectionName': 'string',
                'WriteManifest': True|False
            },
        ]
    },
    Schedule='string',
    Classifiers=[
        'string',
    ],
    TablePrefix='string',
    SchemaChangePolicy={
        'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
        'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
    },
    RecrawlPolicy={
        'RecrawlBehavior': 'CRAWL_EVERYTHING'|'CRAWL_NEW_FOLDERS_ONLY'|'CRAWL_EVENT_MODE'
    },
    LineageConfiguration={
        'CrawlerLineageSettings': 'ENABLE'|'DISABLE'
    },
    LakeFormationConfiguration={
        'UseLakeFormationCredentials': True|False,
        'AccountId': 'string'
    },
    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 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) --
        • ConnectionName (string) --

          The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).

        • SampleSize (integer) --

          Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.

        • EventQueueArn (string) --

          A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs .

        • DlqEventQueueArn (string) --

          A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue .

    • JdbcTargets (list) --

      Specifies JDBC targets.

      • (dict) --

        Specifies a JDBC data store to crawl.

        • ConnectionName (string) --

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

        • Path (string) --

          The path of the JDBC target.

        • Exclusions (list) --

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

          • (string) --
    • MongoDBTargets (list) --

      Specifies Amazon DocumentDB or MongoDB targets.

      • (dict) --

        Specifies an Amazon DocumentDB or MongoDB data store to crawl.

        • ConnectionName (string) --

          The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.

        • Path (string) --

          The path of the Amazon DocumentDB or MongoDB target (database/collection).

        • ScanAll (boolean) --

          Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.

          A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .

    • DynamoDBTargets (list) --

      Specifies Amazon DynamoDB targets.

      • (dict) --

        Specifies an Amazon DynamoDB table to crawl.

        • Path (string) --

          The name of the DynamoDB table to crawl.

        • scanAll (boolean) --

          Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.

          A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .

        • scanRate (float) --

          The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.

          The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).

    • CatalogTargets (list) --

      Specifies Glue Data Catalog targets.

      • (dict) --

        Specifies an Glue Data Catalog target.

        • DatabaseName (string) -- [REQUIRED]

          The name of the database to be synchronized.

        • Tables (list) -- [REQUIRED]

          A list of the tables to be synchronized.

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

          The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type.

    • DeltaTargets (list) --

      Specifies Delta data store targets.

      • (dict) --

        Specifies a Delta data store to crawl one or more Delta tables.

        • DeltaTables (list) --

          A list of the Amazon S3 paths to the Delta tables.

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

          The name of the connection to use to connect to the Delta table target.

        • WriteManifest (boolean) --

          Specifies whether to write the manifest files to the Delta table path.

  • 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 * * ? *) .
  • 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.

  • RecrawlPolicy (dict) --

    A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.

    • RecrawlBehavior (string) --

      Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.

      A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.

      A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.

      A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.

  • LineageConfiguration (dict) --

    Specifies data lineage configuration settings for the crawler.

    • CrawlerLineageSettings (string) --

      Specifies whether data lineage is enabled for the crawler. Valid values are:

      • ENABLE: enables data lineage for the crawler
      • DISABLE: disables data lineage for the crawler
  • LakeFormationConfiguration (dict) --

    Specifies Lake Formation configuration settings for the crawler.

    • UseLakeFormationCredentials (boolean) --

      Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.

    • AccountId (string) --

      Required for cross account crawls. For same account crawls as the target data, this can be left as null.

  • 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.
  • Tags (dict) --

    The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

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

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
create_custom_entity_type(**kwargs)

Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.

Each custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked.

See also: AWS API Documentation

Request Syntax

response = client.create_custom_entity_type(
    Name='string',
    RegexString='string',
    ContextWords=[
        'string',
    ]
)
Parameters
  • Name (string) --

    [REQUIRED]

    A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.

  • RegexString (string) --

    [REQUIRED]

    A regular expression string that is used for detecting sensitive data in a custom pattern.

  • ContextWords (list) --

    A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.

    If no context words are passed only a regular expression is checked.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'Name': 'string'
}

Response Structure

  • (dict) --

    • Name (string) --

      The name of the custom pattern you created.

Exceptions

  • Glue.Client.exceptions.AccessDeniedException
  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.IdempotentParameterMismatchException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
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'
        },
        'CreateTableDefaultPermissions': [
            {
                'Principal': {
                    'DataLakePrincipalIdentifier': 'string'
                },
                'Permissions': [
                    'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
                ]
            },
        ],
        'TargetDatabase': {
            'CatalogId': 'string',
            'DatabaseName': 'string'
        }
    },
    Tags={
        'string': 'string'
    }
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog in which to create the database. If none is provided, the Amazon Web Services account ID is used by default.
  • DatabaseInput (dict) --

    [REQUIRED]

    The metadata for the database.

    • Name (string) -- [REQUIRED]

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

    • Description (string) --

      A description of the database.

    • LocationUri (string) --

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

    • Parameters (dict) --

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

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

      • (string) --
        • (string) --
    • CreateTableDefaultPermissions (list) --

      Creates a set of default permissions on the table for principals.

      • (dict) --

        Permissions granted to a principal.

        • Principal (dict) --

          The principal who is granted permissions.

          • DataLakePrincipalIdentifier (string) --

            An identifier for the Lake Formation principal.

        • Permissions (list) --

          The permissions that are granted to the principal.

          • (string) --
    • TargetDatabase (dict) --

      A DatabaseIdentifier structure that describes a target database for resource linking.

      • CatalogId (string) --

        The ID of the Data Catalog in which the database resides.

      • DatabaseName (string) --

        The name of the catalog database.

  • Tags (dict) --

    The tags you assign to the database.

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

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.GlueEncryptionException
  • Glue.Client.exceptions.ConcurrentModificationException
create_dev_endpoint(**kwargs)

Creates a new development endpoint.

See also: AWS API Documentation

Request Syntax

response = client.create_dev_endpoint(
    EndpointName='string',
    RoleArn='string',
    SecurityGroupIds=[
        'string',
    ],
    SubnetId='string',
    PublicKey='string',
    PublicKeys=[
        'string',
    ],
    NumberOfNodes=123,
    WorkerType='Standard'|'G.1X'|'G.2X'|'G.025X',
    GlueVersion='string',
    NumberOfWorkers=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 because the recommended attribute to use is public keys.
  • PublicKeys (list) --

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

    Note

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

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

    The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.

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

    Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.

  • GlueVersion (string) --

    Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

    For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

    Development endpoints that are created without specifying a Glue version default to Glue 0.9.

    You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

  • NumberOfWorkers (integer) --

    The number of workers of a defined workerType that are allocated to the development endpoint.

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

  • ExtraPythonLibsS3Path (string) --

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

    Note

    You can only use pure Python libraries with a DevEndpoint . Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.

  • ExtraJarsS3Path (string) -- The path to one or more Java .jar files 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 Glue, see Amazon Web Services Tags in 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,
    'WorkerType': 'Standard'|'G.1X'|'G.2X'|'G.025X',
    'GlueVersion': 'string',
    'NumberOfWorkers': 123,
    'AvailabilityZone': 'string',
    'VpcId': 'string',
    'ExtraPythonLibsS3Path': 'string',
    'ExtraJarsS3Path': 'string',
    'FailureReason': 'string',
    'SecurityConfiguration': 'string',
    'CreatedTimestamp': datetime(2015, 1, 1),
    'Arguments': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • EndpointName (string) --

      The name assigned to the new DevEndpoint .

    • Status (string) --

      The current status of the new DevEndpoint .

    • SecurityGroupIds (list) --

      The security groups assigned to the new DevEndpoint .

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

      The subnet ID assigned to the new DevEndpoint .

    • RoleArn (string) --

      The Amazon Resource Name (ARN) of the role assigned to the new DevEndpoint .

    • YarnEndpointAddress (string) --

      The address of the YARN endpoint used by this DevEndpoint .

    • ZeppelinRemoteSparkInterpreterPort (integer) --

      The Apache Zeppelin port for the remote Apache Spark interpreter.

    • NumberOfNodes (integer) --

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

    • WorkerType (string) --

      The type of predefined worker that is allocated to the development endpoint. May be a value of Standard, G.1X, or G.2X.

    • GlueVersion (string) --

      Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

      For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

    • NumberOfWorkers (integer) --

      The number of workers of a defined workerType that are allocated to the development endpoint.

    • AvailabilityZone (string) --

      The AWS Availability Zone where this DevEndpoint is located.

    • VpcId (string) --

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

    • ExtraPythonLibsS3Path (string) --

      The paths to one or more Python libraries in an S3 bucket that will be loaded in your DevEndpoint .

    • ExtraJarsS3Path (string) --

      Path to one or more Java .jar files in an S3 bucket that will be loaded in your DevEndpoint .

    • FailureReason (string) --

      The reason for a current failure in this DevEndpoint .

    • SecurityConfiguration (string) --

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

    • CreatedTimestamp (datetime) --

      The point in time at which this DevEndpoint was created.

    • Arguments (dict) --

      The map of arguments used to configure this DevEndpoint .

      Valid arguments are:

      • "--enable-glue-datacatalog": ""

      You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

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

Exceptions

  • Glue.Client.exceptions.AccessDeniedException
  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.IdempotentParameterMismatchException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.ValidationException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
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'
    },
    NonOverridableArguments={
        'string': 'string'
    },
    Connections={
        'Connections': [
            'string',
        ]
    },
    MaxRetries=123,
    AllocatedCapacity=123,
    Timeout=123,
    MaxCapacity=123.0,
    SecurityConfiguration='string',
    Tags={
        'string': 'string'
    },
    NotificationProperty={
        'NotifyDelayAfter': 123
    },
    GlueVersion='string',
    NumberOfWorkers=123,
    WorkerType='Standard'|'G.1X'|'G.2X'|'G.025X',
    CodeGenConfigurationNodes={
        'string': {
            'AthenaConnectorSource': {
                'Name': 'string',
                'ConnectionName': 'string',
                'ConnectorName': 'string',
                'ConnectionType': 'string',
                'ConnectionTable': 'string',
                'SchemaName': 'string',
                'OutputSchemas': [
                    {
                        'Columns': [
                            {
                                'Name': 'string',
                                'Type': 'string'
                            },
                        ]
                    },
                ]
            },
            'JDBCConnectorSource': {
                'Name': 'string',
                'ConnectionName': 'string',
                'ConnectorName': 'string',
                'ConnectionType': 'string',
                'AdditionalOptions': {
                    'FilterPredicate': 'string',
                    'PartitionColumn': 'string',
                    'LowerBound': 123,
                    'UpperBound': 123,
                    'NumPartitions': 123,
                    'JobBookmarkKeys': [
                        'string',
                    ],
                    'JobBookmarkKeysSortOrder': 'string',
                    'DataTypeMapping': {
                        'string': 'DATE'|'STRING'|'TIMESTAMP'|'INT'|'FLOAT'|'LONG'|'BIGDECIMAL'|'BYTE'|'SHORT'|'DOUBLE'
                    }
                },
                'ConnectionTable': 'string',
                'Query': 'string',
                'OutputSchemas': [
                    {
                        'Columns': [
                            {
                                'Name': 'string',
                                'Type': 'string'
                            },
                        ]
                    },
                ]
            },
            'SparkConnectorSource': {
                'Name': 'string',
                'ConnectionName': 'string',
                'ConnectorName': 'string',
                'ConnectionType': 'string',
                'AdditionalOptions': {
                    'string': 'string'
                },
                'OutputSchemas': [
                    {
                        'Columns': [
                            {
                                'Name': 'string',
                                'Type': 'string'
                            },
                        ]
                    },
                ]
            },
            'CatalogSource': {
                'Name': 'string',
                'Database': 'string',
                'Table': 'string'
            },
            'RedshiftSource': {
                'Name': 'string',
                'Database': 'string',
                'Table': 'string',
                'RedshiftTmpDir': 'string',
                'TmpDirIAMRole': 'string'
            },
            'S3CatalogSource': {
                'Name': 'string',
                'Database': 'string',
                'Table': 'string',
                'PartitionPredicate': 'string',
                'AdditionalOptions': {
                    'BoundedSize': 123,
                    'BoundedFiles': 123
                }
            },
            'S3CsvSource': {
                'Name': 'string',
                'Paths': [
                    'string',
                ],
                'CompressionType': 'gzip'|'bzip2',
                'Exclusions': [
                    'string',
                ],
                'GroupSize': 'string',
                'GroupFiles': 'string',
                'Recurse': True|False,
                'MaxBand': 123,
                'MaxFilesInBand': 123,
                'AdditionalOptions': {
                    'BoundedSize': 123,
                    'BoundedFiles': 123,
                    'EnableSamplePath': True|False,
                    'SamplePath': 'string'
                },
                'Separator': 'comma'|'ctrla'|'pipe'|'semicolon'|'tab',
                'Escaper': 'string',
                'QuoteChar': 'quote'|'quillemet'|'single_quote'|'disabled',
                'Multiline': True|False,
                'WithHeader': True|False,
                'WriteHeader': True|False,
                'SkipFirst': True|False,
                'OptimizePerformance': True|False,
                'OutputSchemas': [
                    {
                        'Columns': [
                            {
                                'Name': 'string',
                                'Type': 'string'
                            },
                        ]
                    },
                ]
            },
            'S3JsonSource': {
                'Name': 'string',
                'Paths': [
                    'string',
                ],
                'CompressionType': 'gzip'|'bzip2',
                'Exclusions': [
                    'string',
                ],
                'GroupSize': 'string',
                'GroupFiles': 'string',
                'Recurse': True|False,
                'MaxBand': 123,
                'MaxFilesInBand': 123,
                'AdditionalOptions': {
                    'BoundedSize': 123,
                    'BoundedFiles': 123,
                    'EnableSamplePath': True|False,
                    'SamplePath': 'string'
                },
                'JsonPath': 'string',
                'Multiline': True|False,
                'OutputSchemas': [
                    {
                        'Columns': [
                            {
                                'Name': 'string',
                                'Type': 'string'
                            },
                        ]
                    },
                ]
            },
            'S3ParquetSource': {
                'Name': 'string',
                'Paths': [
                    'string',
                ],
                'CompressionType': 'snappy'|'lzo'|'gzip'|'uncompressed'|'none',
                'Exclusions': [
                    'string',
                ],
                'GroupSize': 'string',
                'GroupFiles': 'string',
                'Recurse': True|False,
                'MaxBand': 123,
                'MaxFilesInBand': 123,
                'AdditionalOptions': {
                    'BoundedSize': 123,
                    'BoundedFiles': 123,
                    'EnableSamplePath': True|False,
                    'SamplePath': 'string'
                },
                'OutputSchemas': [
                    {
                        'Columns': [
                            {
                                'Name': 'string',
                                'Type': 'string'
                            },
                        ]
                    },
                ]
            },
            'RelationalCatalogSource': {
                'Name': 'string',
                'Database': 'string',
                'Table': 'string'
            },
            'DynamoDBCatalogSource': {
                'Name': 'string',
                'Database': 'string',
                'Table': 'string'
            },
            'JDBCConnectorTarget': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'ConnectionName': 'string',
                'ConnectionTable': 'string',
                'ConnectorName': 'string',
                'ConnectionType': 'string',
                'AdditionalOptions': {
                    'string': 'string'
                },
                'OutputSchemas': [
                    {
                        'Columns': [
                            {
                                'Name': 'string',
                                'Type': 'string'
                            },
                        ]
                    },
                ]
            },
            'SparkConnectorTarget': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'ConnectionName': 'string',
                'ConnectorName': 'string',
                'ConnectionType': 'string',
                'AdditionalOptions': {
                    'string': 'string'
                },
                'OutputSchemas': [
                    {
                        'Columns': [
                            {
                                'Name': 'string',
                                'Type': 'string'
                            },
                        ]
                    },
                ]
            },
            'CatalogTarget': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'Database': 'string',
                'Table': 'string'
            },
            'RedshiftTarget': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'Database': 'string',
                'Table': 'string',
                'RedshiftTmpDir': 'string',
                'TmpDirIAMRole': 'string',
                'UpsertRedshiftOptions': {
                    'TableLocation': 'string',
                    'ConnectionName': 'string',
                    'UpsertKeys': [
                        'string',
                    ]
                }
            },
            'S3CatalogTarget': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'PartitionKeys': [
                    [
                        'string',
                    ],
                ],
                'Table': 'string',
                'Database': 'string',
                'SchemaChangePolicy': {
                    'EnableUpdateCatalog': True|False,
                    'UpdateBehavior': 'UPDATE_IN_DATABASE'|'LOG'
                }
            },
            'S3GlueParquetTarget': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'PartitionKeys': [
                    [
                        'string',
                    ],
                ],
                'Path': 'string',
                'Compression': 'snappy'|'lzo'|'gzip'|'uncompressed'|'none',
                'SchemaChangePolicy': {
                    'EnableUpdateCatalog': True|False,
                    'UpdateBehavior': 'UPDATE_IN_DATABASE'|'LOG',
                    'Table': 'string',
                    'Database': 'string'
                }
            },
            'S3DirectTarget': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'PartitionKeys': [
                    [
                        'string',
                    ],
                ],
                'Path': 'string',
                'Compression': 'string',
                'Format': 'json'|'csv'|'avro'|'orc'|'parquet',
                'SchemaChangePolicy': {
                    'EnableUpdateCatalog': True|False,
                    'UpdateBehavior': 'UPDATE_IN_DATABASE'|'LOG',
                    'Table': 'string',
                    'Database': 'string'
                }
            },
            'ApplyMapping': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'Mapping': [
                    {
                        'ToKey': 'string',
                        'FromPath': [
                            'string',
                        ],
                        'FromType': 'string',
                        'ToType': 'string',
                        'Dropped': True|False,
                        'Children': {'... recursive ...'}
                    },
                ]
            },
            'SelectFields': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'Paths': [
                    [
                        'string',
                    ],
                ]
            },
            'DropFields': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'Paths': [
                    [
                        'string',
                    ],
                ]
            },
            'RenameField': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'SourcePath': [
                    'string',
                ],
                'TargetPath': [
                    'string',
                ]
            },
            'Spigot': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'Path': 'string',
                'Topk': 123,
                'Prob': 123.0
            },
            'Join': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'JoinType': 'equijoin'|'left'|'right'|'outer'|'leftsemi'|'leftanti',
                'Columns': [
                    {
                        'From': 'string',
                        'Keys': [
                            [
                                'string',
                            ],
                        ]
                    },
                ]
            },
            'SplitFields': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'Paths': [
                    [
                        'string',
                    ],
                ]
            },
            'SelectFromCollection': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'Index': 123
            },
            'FillMissingValues': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'ImputedPath': 'string',
                'FilledPath': 'string'
            },
            'Filter': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'LogicalOperator': 'AND'|'OR',
                'Filters': [
                    {
                        'Operation': 'EQ'|'LT'|'GT'|'LTE'|'GTE'|'REGEX'|'ISNULL',
                        'Negated': True|False,
                        'Values': [
                            {
                                'Type': 'COLUMNEXTRACTED'|'CONSTANT',
                                'Value': [
                                    'string',
                                ]
                            },
                        ]
                    },
                ]
            },
            'CustomCode': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'Code': 'string',
                'ClassName': 'string',
                'OutputSchemas': [
                    {
                        'Columns': [
                            {
                                'Name': 'string',
                                'Type': 'string'
                            },
                        ]
                    },
                ]
            },
            'SparkSQL': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'SqlQuery': 'string',
                'SqlAliases': [
                    {
                        'From': 'string',
                        'Alias': 'string'
                    },
                ],
                'OutputSchemas': [
                    {
                        'Columns': [
                            {
                                'Name': 'string',
                                'Type': 'string'
                            },
                        ]
                    },
                ]
            },
            'DirectKinesisSource': {
                'Name': 'string',
                'WindowSize': 123,
                'DetectSchema': True|False,
                'StreamingOptions': {
                    'EndpointUrl': 'string',
                    'StreamName': 'string',
                    'Classification': 'string',
                    'Delimiter': 'string',
                    'StartingPosition': 'latest'|'trim_horizon'|'earliest',
                    'MaxFetchTimeInMs': 123,
                    'MaxFetchRecordsPerShard': 123,
                    'MaxRecordPerRead': 123,
                    'AddIdleTimeBetweenReads': True|False,
                    'IdleTimeBetweenReadsInMs': 123,
                    'DescribeShardInterval': 123,
                    'NumRetries': 123,
                    'RetryIntervalMs': 123,
                    'MaxRetryIntervalMs': 123,
                    'AvoidEmptyBatches': True|False,
                    'StreamArn': 'string',
                    'RoleArn': 'string',
                    'RoleSessionName': 'string'
                },
                'DataPreviewOptions': {
                    'PollingTime': 123,
                    'RecordPollingLimit': 123
                }
            },
            'DirectKafkaSource': {
                'Name': 'string',
                'StreamingOptions': {
                    'BootstrapServers': 'string',
                    'SecurityProtocol': 'string',
                    'ConnectionName': 'string',
                    'TopicName': 'string',
                    'Assign': 'string',
                    'SubscribePattern': 'string',
                    'Classification': 'string',
                    'Delimiter': 'string',
                    'StartingOffsets': 'string',
                    'EndingOffsets': 'string',
                    'PollTimeoutMs': 123,
                    'NumRetries': 123,
                    'RetryIntervalMs': 123,
                    'MaxOffsetsPerTrigger': 123,
                    'MinPartitions': 123
                },
                'WindowSize': 123,
                'DetectSchema': True|False,
                'DataPreviewOptions': {
                    'PollingTime': 123,
                    'RecordPollingLimit': 123
                }
            },
            'CatalogKinesisSource': {
                'Name': 'string',
                'WindowSize': 123,
                'DetectSchema': True|False,
                'Table': 'string',
                'Database': 'string',
                'StreamingOptions': {
                    'EndpointUrl': 'string',
                    'StreamName': 'string',
                    'Classification': 'string',
                    'Delimiter': 'string',
                    'StartingPosition': 'latest'|'trim_horizon'|'earliest',
                    'MaxFetchTimeInMs': 123,
                    'MaxFetchRecordsPerShard': 123,
                    'MaxRecordPerRead': 123,
                    'AddIdleTimeBetweenReads': True|False,
                    'IdleTimeBetweenReadsInMs': 123,
                    'DescribeShardInterval': 123,
                    'NumRetries': 123,
                    'RetryIntervalMs': 123,
                    'MaxRetryIntervalMs': 123,
                    'AvoidEmptyBatches': True|False,
                    'StreamArn': 'string',
                    'RoleArn': 'string',
                    'RoleSessionName': 'string'
                },
                'DataPreviewOptions': {
                    'PollingTime': 123,
                    'RecordPollingLimit': 123
                }
            },
            'CatalogKafkaSource': {
                'Name': 'string',
                'WindowSize': 123,
                'DetectSchema': True|False,
                'Table': 'string',
                'Database': 'string',
                'StreamingOptions': {
                    'BootstrapServers': 'string',
                    'SecurityProtocol': 'string',
                    'ConnectionName': 'string',
                    'TopicName': 'string',
                    'Assign': 'string',
                    'SubscribePattern': 'string',
                    'Classification': 'string',
                    'Delimiter': 'string',
                    'StartingOffsets': 'string',
                    'EndingOffsets': 'string',
                    'PollTimeoutMs': 123,
                    'NumRetries': 123,
                    'RetryIntervalMs': 123,
                    'MaxOffsetsPerTrigger': 123,
                    'MinPartitions': 123
                },
                'DataPreviewOptions': {
                    'PollingTime': 123,
                    'RecordPollingLimit': 123
                }
            },
            'DropNullFields': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'NullCheckBoxList': {
                    'IsEmpty': True|False,
                    'IsNullString': True|False,
                    'IsNegOne': True|False
                },
                'NullTextList': [
                    {
                        'Value': 'string',
                        'Datatype': {
                            'Id': 'string',
                            'Label': 'string'
                        }
                    },
                ]
            },
            'Merge': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'Source': 'string',
                'PrimaryKeys': [
                    [
                        'string',
                    ],
                ]
            },
            'Union': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'UnionType': 'ALL'|'DISTINCT'
            },
            'PIIDetection': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'PiiType': 'RowAudit'|'RowMasking'|'ColumnAudit'|'ColumnMasking',
                'EntityTypesToDetect': [
                    'string',
                ],
                'OutputColumnName': 'string',
                'SampleFraction': 123.0,
                'ThresholdFraction': 123.0,
                'MaskValue': 'string'
            },
            'Aggregate': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'Groups': [
                    [
                        'string',
                    ],
                ],
                'Aggs': [
                    {
                        'Column': [
                            'string',
                        ],
                        'AggFunc': 'avg'|'countDistinct'|'count'|'first'|'last'|'kurtosis'|'max'|'min'|'skewness'|'stddev_samp'|'stddev_pop'|'sum'|'sumDistinct'|'var_samp'|'var_pop'
                    },
                ]
            },
            'DropDuplicates': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'Columns': [
                    [
                        'string',
                    ],
                ]
            },
            'GovernedCatalogTarget': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'PartitionKeys': [
                    [
                        'string',
                    ],
                ],
                'Table': 'string',
                'Database': 'string',
                'SchemaChangePolicy': {
                    'EnableUpdateCatalog': True|False,
                    'UpdateBehavior': 'UPDATE_IN_DATABASE'|'LOG'
                }
            },
            'GovernedCatalogSource': {
                'Name': 'string',
                'Database': 'string',
                'Table': 'string',
                'PartitionPredicate': 'string',
                'AdditionalOptions': {
                    'BoundedSize': 123,
                    'BoundedFiles': 123
                }
            },
            'MicrosoftSQLServerCatalogSource': {
                'Name': 'string',
                'Database': 'string',
                'Table': 'string'
            },
            'MySQLCatalogSource': {
                'Name': 'string',
                'Database': 'string',
                'Table': 'string'
            },
            'OracleSQLCatalogSource': {
                'Name': 'string',
                'Database': 'string',
                'Table': 'string'
            },
            'PostgreSQLCatalogSource': {
                'Name': 'string',
                'Database': 'string',
                'Table': 'string'
            },
            'MicrosoftSQLServerCatalogTarget': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'Database': 'string',
                'Table': 'string'
            },
            'MySQLCatalogTarget': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'Database': 'string',
                'Table': 'string'
            },
            'OracleSQLCatalogTarget': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'Database': 'string',
                'Table': 'string'
            },
            'PostgreSQLCatalogTarget': {
                'Name': 'string',
                'Inputs': [
                    'string',
                ],
                'Database': 'string',
                'Table': 'string'
            }
        }
    },
    ExecutionClass='FLEX'|'STANDARD'
)
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 runs this job.

    • Name (string) --

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

    • ScriptLocation (string) --

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

    • PythonVersion (string) --

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

  • DefaultArguments (dict) --

    The default arguments for this job.

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

    Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.

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

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

    • (string) --
      • (string) --
  • NonOverridableArguments (dict) --

    Non-overridable arguments for this job, specified as name-value pairs.

    • (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 Glue data processing units (DPUs) to allocate to this Job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .

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

    For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page .

    Do not set Max Capacity if using WorkerType and NumberOfWorkers .

    The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job 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") or Apache Spark streaming ETL job (JobCommand.Name ="gluestreaming"), you can allocate a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

    For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity . Instead, you should specify a Worker type and the Number of workers .

  • 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 Glue, see Amazon Web Services Tags in 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.

  • GlueVersion (string) --

    Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

    For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

    Jobs that are created without specifying a Glue version default to Glue 0.9.

  • NumberOfWorkers (integer) -- The number of workers of a defined workerType that are allocated when a job runs.
  • WorkerType (string) --

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

    • 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.
    • For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
  • CodeGenConfigurationNodes (dict) --

    The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.

    • (string) --
      • (dict) --
        CodeGenConfigurationNode enumerates all valid Node types. One and only one of its member variables can be populated.
        • AthenaConnectorSource (dict) --

          Specifies a connector to an Amazon Athena data source.

          • Name (string) -- [REQUIRED]

            The name of the data source.

          • ConnectionName (string) -- [REQUIRED]

            The name of the connection that is associated with the connector.

          • ConnectorName (string) -- [REQUIRED]

            The name of a connector that assists with accessing the data store in Glue Studio.

          • ConnectionType (string) -- [REQUIRED]

            The type of connection, such as marketplace.athena or custom.athena, designating a connection to an Amazon Athena data store.

          • ConnectionTable (string) --

            The name of the table in the data source.

          • SchemaName (string) -- [REQUIRED]

            The name of the Cloudwatch log group to read from. For example, /aws-glue/jobs/output .

          • OutputSchemas (list) --

            Specifies the data schema for the custom Athena source.

            • (dict) --

              Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

              • Columns (list) --

                Specifies the column definitions that make up a Glue schema.

                • (dict) --

                  Specifies a single column in a Glue schema definition.

                  • Name (string) -- [REQUIRED]

                    The name of the column in the Glue Studio schema.

                  • Type (string) --

                    The hive type for this column in the Glue Studio schema.

        • JDBCConnectorSource (dict) --

          Specifies a connector to a JDBC data source.

          • Name (string) -- [REQUIRED]

            The name of the data source.

          • ConnectionName (string) -- [REQUIRED]

            The name of the connection that is associated with the connector.

          • ConnectorName (string) -- [REQUIRED]

            The name of a connector that assists with accessing the data store in Glue Studio.

          • ConnectionType (string) -- [REQUIRED]

            The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data store.

          • AdditionalOptions (dict) --

            Additional connection options for the connector.

            • FilterPredicate (string) --

              Extra condition clause to filter data from source. For example:

              BillingCity='Mountain View'

              When using a query instead of a table name, you should validate that the query works with the specified filterPredicate .

            • PartitionColumn (string) --

              The name of an integer column that is used for partitioning. This option works only when it's included with lowerBound , upperBound , and numPartitions . This option works the same way as in the Spark SQL JDBC reader.

            • LowerBound (integer) --

              The minimum value of partitionColumn that is used to decide partition stride.

            • UpperBound (integer) --

              The maximum value of partitionColumn that is used to decide partition stride.

            • NumPartitions (integer) --

              The number of partitions. This value, along with lowerBound (inclusive) and upperBound (exclusive), form partition strides for generated WHERE clause expressions that are used to split the partitionColumn .

            • JobBookmarkKeys (list) --

              The name of the job bookmark keys on which to sort.

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

              Specifies an ascending or descending sort order.

            • DataTypeMapping (dict) --

              Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option "dataTypeMapping":{"FLOAT":"STRING"} maps data fields of JDBC type FLOAT into the Java String type by calling the ResultSet.getString() method of the driver, and uses it to build the Glue record. The ResultSet object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand how the driver performs the conversions.

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

            The name of the table in the data source.

          • Query (string) --

            The table or SQL query to get the data from. You can specify either ConnectionTable or query , but not both.

          • OutputSchemas (list) --

            Specifies the data schema for the custom JDBC source.

            • (dict) --

              Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

              • Columns (list) --

                Specifies the column definitions that make up a Glue schema.

                • (dict) --

                  Specifies a single column in a Glue schema definition.

                  • Name (string) -- [REQUIRED]

                    The name of the column in the Glue Studio schema.

                  • Type (string) --

                    The hive type for this column in the Glue Studio schema.

        • SparkConnectorSource (dict) --

          Specifies a connector to an Apache Spark data source.

          • Name (string) -- [REQUIRED]

            The name of the data source.

          • ConnectionName (string) -- [REQUIRED]

            The name of the connection that is associated with the connector.

          • ConnectorName (string) -- [REQUIRED]

            The name of a connector that assists with accessing the data store in Glue Studio.

          • ConnectionType (string) -- [REQUIRED]

            The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.

          • AdditionalOptions (dict) --

            Additional connection options for the connector.

            • (string) --
              • (string) --
          • OutputSchemas (list) --

            Specifies data schema for the custom spark source.

            • (dict) --

              Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

              • Columns (list) --

                Specifies the column definitions that make up a Glue schema.

                • (dict) --

                  Specifies a single column in a Glue schema definition.

                  • Name (string) -- [REQUIRED]

                    The name of the column in the Glue Studio schema.

                  • Type (string) --

                    The hive type for this column in the Glue Studio schema.

        • CatalogSource (dict) --

          Specifies a data store in the Glue Data Catalog.

          • Name (string) -- [REQUIRED]

            The name of the data store.

          • Database (string) -- [REQUIRED]

            The name of the database to read from.

          • Table (string) -- [REQUIRED]

            The name of the table in the database to read from.

        • RedshiftSource (dict) --

          Specifies an Amazon Redshift data store.

          • Name (string) -- [REQUIRED]

            The name of the Amazon Redshift data store.

          • Database (string) -- [REQUIRED]

            The database to read from.

          • Table (string) -- [REQUIRED]

            The database table to read from.

          • RedshiftTmpDir (string) --

            The Amazon S3 path where temporary data can be staged when copying out of the database.

          • TmpDirIAMRole (string) --

            The IAM role with permissions.

        • S3CatalogSource (dict) --

          Specifies an Amazon S3 data store in the Glue Data Catalog.

          • Name (string) -- [REQUIRED]

            The name of the data store.

          • Database (string) -- [REQUIRED]

            The database to read from.

          • Table (string) -- [REQUIRED]

            The database table to read from.

          • PartitionPredicate (string) --

            Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to "" – empty by default.

          • AdditionalOptions (dict) --

            Specifies additional connection options.

            • BoundedSize (integer) --

              Sets the upper limit for the target size of the dataset in bytes that will be processed.

            • BoundedFiles (integer) --

              Sets the upper limit for the target number of files that will be processed.

        • S3CsvSource (dict) --

          Specifies a command-separated value (CSV) data store stored in Amazon S3.

          • Name (string) -- [REQUIRED]

            The name of the data store.

          • Paths (list) -- [REQUIRED]

            A list of the Amazon S3 paths to read from.

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

            Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip" ).

          • Exclusions (list) --

            A string containing a JSON list of Unix-style glob patterns to exclude. For example, "["**.pdf"]" excludes all PDF files.

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

            The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles" must be set to "inPartition" for this to take effect.

          • GroupFiles (string) --

            Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none" .

          • Recurse (boolean) --

            If set to true, recursively reads files in all subdirectories under the specified paths.

          • MaxBand (integer) --

            This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.

          • MaxFilesInBand (integer) --

            This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.

          • AdditionalOptions (dict) --

            Specifies additional connection options.

            • BoundedSize (integer) --

              Sets the upper limit for the target size of the dataset in bytes that will be processed.

            • BoundedFiles (integer) --

              Sets the upper limit for the target number of files that will be processed.

            • EnableSamplePath (boolean) --

              Sets option to enable a sample path.

            • SamplePath (string) --

              If enabled, specifies the sample path.

          • Separator (string) -- [REQUIRED]

            Specifies the delimiter character. The default is a comma: ",", but any other character can be specified.

          • Escaper (string) --

            Specifies a character to use for escaping. This option is used only when reading CSV files. The default value is none . If enabled, the character which immediately follows is used as-is, except for a small set of well-known escapes (\n , \r , \t , and \0 ).

          • QuoteChar (string) -- [REQUIRED]

            Specifies the character to use for quoting. The default is a double quote: '"' . Set this to -1 to turn off quoting entirely.

          • Multiline (boolean) --

            A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False , which allows for more aggressive file-splitting during parsing.

          • WithHeader (boolean) --

            A Boolean value that specifies whether to treat the first line as a header. The default value is False .

          • WriteHeader (boolean) --

            A Boolean value that specifies whether to write the header to output. The default value is True .

          • SkipFirst (boolean) --

            A Boolean value that specifies whether to skip the first data line. The default value is False .

          • OptimizePerformance (boolean) --

            A Boolean value that specifies whether to use the advanced SIMD CSV reader along with Apache Arrow based columnar memory formats. Only available in Glue version 3.0.

          • OutputSchemas (list) --

            Specifies the data schema for the S3 CSV source.

            • (dict) --

              Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

              • Columns (list) --

                Specifies the column definitions that make up a Glue schema.

                • (dict) --

                  Specifies a single column in a Glue schema definition.

                  • Name (string) -- [REQUIRED]

                    The name of the column in the Glue Studio schema.

                  • Type (string) --

                    The hive type for this column in the Glue Studio schema.

        • S3JsonSource (dict) --

          Specifies a JSON data store stored in Amazon S3.

          • Name (string) -- [REQUIRED]

            The name of the data store.

          • Paths (list) -- [REQUIRED]

            A list of the Amazon S3 paths to read from.

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

            Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip" ).

          • Exclusions (list) --

            A string containing a JSON list of Unix-style glob patterns to exclude. For example, "["**.pdf"]" excludes all PDF files.

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

            The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles" must be set to "inPartition" for this to take effect.

          • GroupFiles (string) --

            Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none" .

          • Recurse (boolean) --

            If set to true, recursively reads files in all subdirectories under the specified paths.

          • MaxBand (integer) --

            This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.

          • MaxFilesInBand (integer) --

            This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.

          • AdditionalOptions (dict) --

            Specifies additional connection options.

            • BoundedSize (integer) --

              Sets the upper limit for the target size of the dataset in bytes that will be processed.

            • BoundedFiles (integer) --

              Sets the upper limit for the target number of files that will be processed.

            • EnableSamplePath (boolean) --

              Sets option to enable a sample path.

            • SamplePath (string) --

              If enabled, specifies the sample path.

          • JsonPath (string) --

            A JsonPath string defining the JSON data.

          • Multiline (boolean) --

            A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False , which allows for more aggressive file-splitting during parsing.

          • OutputSchemas (list) --

            Specifies the data schema for the S3 JSON source.

            • (dict) --

              Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

              • Columns (list) --

                Specifies the column definitions that make up a Glue schema.

                • (dict) --

                  Specifies a single column in a Glue schema definition.

                  • Name (string) -- [REQUIRED]

                    The name of the column in the Glue Studio schema.

                  • Type (string) --

                    The hive type for this column in the Glue Studio schema.

        • S3ParquetSource (dict) --

          Specifies an Apache Parquet data store stored in Amazon S3.

          • Name (string) -- [REQUIRED]

            The name of the data store.

          • Paths (list) -- [REQUIRED]

            A list of the Amazon S3 paths to read from.

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

            Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip" ).

          • Exclusions (list) --

            A string containing a JSON list of Unix-style glob patterns to exclude. For example, "["**.pdf"]" excludes all PDF files.

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

            The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles" must be set to "inPartition" for this to take effect.

          • GroupFiles (string) --

            Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none" .

          • Recurse (boolean) --

            If set to true, recursively reads files in all subdirectories under the specified paths.

          • MaxBand (integer) --

            This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.

          • MaxFilesInBand (integer) --

            This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.

          • AdditionalOptions (dict) --

            Specifies additional connection options.

            • BoundedSize (integer) --

              Sets the upper limit for the target size of the dataset in bytes that will be processed.

            • BoundedFiles (integer) --

              Sets the upper limit for the target number of files that will be processed.

            • EnableSamplePath (boolean) --

              Sets option to enable a sample path.

            • SamplePath (string) --

              If enabled, specifies the sample path.

          • OutputSchemas (list) --

            Specifies the data schema for the S3 Parquet source.

            • (dict) --

              Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

              • Columns (list) --

                Specifies the column definitions that make up a Glue schema.

                • (dict) --

                  Specifies a single column in a Glue schema definition.

                  • Name (string) -- [REQUIRED]

                    The name of the column in the Glue Studio schema.

                  • Type (string) --

                    The hive type for this column in the Glue Studio schema.

        • RelationalCatalogSource (dict) --

          Specifies a Relational database data source in the Glue Data Catalog.

          • Name (string) -- [REQUIRED]

            The name of the data source.

          • Database (string) -- [REQUIRED]

            The name of the database to read from.

          • Table (string) -- [REQUIRED]

            The name of the table in the database to read from.

        • DynamoDBCatalogSource (dict) --

          Specifies a DynamoDB data source in the Glue Data Catalog.

          • Name (string) -- [REQUIRED]

            The name of the data source.

          • Database (string) -- [REQUIRED]

            The name of the database to read from.

          • Table (string) -- [REQUIRED]

            The name of the table in the database to read from.

        • JDBCConnectorTarget (dict) --

          Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.

          • Name (string) -- [REQUIRED]

            The name of the data target.

          • Inputs (list) -- [REQUIRED]

            The nodes that are inputs to the data target.

            • (string) --
          • ConnectionName (string) -- [REQUIRED]

            The name of the connection that is associated with the connector.

          • ConnectionTable (string) -- [REQUIRED]

            The name of the table in the data target.

          • ConnectorName (string) -- [REQUIRED]

            The name of a connector that will be used.

          • ConnectionType (string) -- [REQUIRED]

            The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data target.

          • AdditionalOptions (dict) --

            Additional connection options for the connector.

            • (string) --
              • (string) --
          • OutputSchemas (list) --

            Specifies the data schema for the JDBC target.

            • (dict) --

              Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

              • Columns (list) --

                Specifies the column definitions that make up a Glue schema.

                • (dict) --

                  Specifies a single column in a Glue schema definition.

                  • Name (string) -- [REQUIRED]

                    The name of the column in the Glue Studio schema.

                  • Type (string) --

                    The hive type for this column in the Glue Studio schema.

        • SparkConnectorTarget (dict) --

          Specifies a target that uses an Apache Spark connector.

          • Name (string) -- [REQUIRED]

            The name of the data target.

          • Inputs (list) -- [REQUIRED]

            The nodes that are inputs to the data target.

            • (string) --
          • ConnectionName (string) -- [REQUIRED]

            The name of a connection for an Apache Spark connector.

          • ConnectorName (string) -- [REQUIRED]

            The name of an Apache Spark connector.

          • ConnectionType (string) -- [REQUIRED]

            The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.

          • AdditionalOptions (dict) --

            Additional connection options for the connector.

            • (string) --
              • (string) --
          • OutputSchemas (list) --

            Specifies the data schema for the custom spark target.

            • (dict) --

              Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

              • Columns (list) --

                Specifies the column definitions that make up a Glue schema.

                • (dict) --

                  Specifies a single column in a Glue schema definition.

                  • Name (string) -- [REQUIRED]

                    The name of the column in the Glue Studio schema.

                  • Type (string) --

                    The hive type for this column in the Glue Studio schema.

        • CatalogTarget (dict) --

          Specifies a target that uses a Glue Data Catalog table.

          • Name (string) -- [REQUIRED]

            The name of your data target.

          • Inputs (list) -- [REQUIRED]

            The nodes that are inputs to the data target.

            • (string) --
          • Database (string) -- [REQUIRED]

            The database that contains the table you want to use as the target. This database must already exist in the Data Catalog.

          • Table (string) -- [REQUIRED]

            The table that defines the schema of your output data. This table must already exist in the Data Catalog.

        • RedshiftTarget (dict) --

          Specifies a target that uses Amazon Redshift.

          • Name (string) -- [REQUIRED]

            The name of the data target.

          • Inputs (list) -- [REQUIRED]

            The nodes that are inputs to the data target.

            • (string) --
          • Database (string) -- [REQUIRED]

            The name of the database to write to.

          • Table (string) -- [REQUIRED]

            The name of the table in the database to write to.

          • RedshiftTmpDir (string) --

            The Amazon S3 path where temporary data can be staged when copying out of the database.

          • TmpDirIAMRole (string) --

            The IAM role with permissions.

          • UpsertRedshiftOptions (dict) --

            The set of options to configure an upsert operation when writing to a Redshift target.

            • TableLocation (string) --

              The physical location of the Redshift table.

            • ConnectionName (string) --

              The name of the connection to use to write to Redshift.

            • UpsertKeys (list) --

              The keys used to determine whether to perform an update or insert.

              • (string) --
        • S3CatalogTarget (dict) --

          Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.

          • Name (string) -- [REQUIRED]

            The name of the data target.

          • Inputs (list) -- [REQUIRED]

            The nodes that are inputs to the data target.

            • (string) --
          • PartitionKeys (list) --

            Specifies native partitioning using a sequence of keys.

            • (list) --
              • (string) --
          • Table (string) -- [REQUIRED]

            The name of the table in the database to write to.

          • Database (string) -- [REQUIRED]

            The name of the database to write to.

          • SchemaChangePolicy (dict) --

            A policy that specifies update behavior for the crawler.

            • EnableUpdateCatalog (boolean) --

              Whether to use the specified update behavior when the crawler finds a changed schema.

            • UpdateBehavior (string) --

              The update behavior when the crawler finds a changed schema.

        • S3GlueParquetTarget (dict) --

          Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.

          • Name (string) -- [REQUIRED]

            The name of the data target.

          • Inputs (list) -- [REQUIRED]

            The nodes that are inputs to the data target.

            • (string) --
          • PartitionKeys (list) --

            Specifies native partitioning using a sequence of keys.

            • (list) --
              • (string) --
          • Path (string) -- [REQUIRED]

            A single Amazon S3 path to write to.

          • Compression (string) --

            Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip" ).

          • SchemaChangePolicy (dict) --

            A policy that specifies update behavior for the crawler.

            • EnableUpdateCatalog (boolean) --

              Whether to use the specified update behavior when the crawler finds a changed schema.

            • UpdateBehavior (string) --

              The update behavior when the crawler finds a changed schema.

            • Table (string) --

              Specifies the table in the database that the schema change policy applies to.

            • Database (string) --

              Specifies the database that the schema change policy applies to.

        • S3DirectTarget (dict) --

          Specifies a data target that writes to Amazon S3.

          • Name (string) -- [REQUIRED]

            The name of the data target.

          • Inputs (list) -- [REQUIRED]

            The nodes that are inputs to the data target.

            • (string) --
          • PartitionKeys (list) --

            Specifies native partitioning using a sequence of keys.

            • (list) --
              • (string) --
          • Path (string) -- [REQUIRED]

            A single Amazon S3 path to write to.

          • Compression (string) --

            Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip" ).

          • Format (string) -- [REQUIRED]

            Specifies the data output format for the target.

          • SchemaChangePolicy (dict) --

            A policy that specifies update behavior for the crawler.

            • EnableUpdateCatalog (boolean) --

              Whether to use the specified update behavior when the crawler finds a changed schema.

            • UpdateBehavior (string) --

              The update behavior when the crawler finds a changed schema.

            • Table (string) --

              Specifies the table in the database that the schema change policy applies to.

            • Database (string) --

              Specifies the database that the schema change policy applies to.

        • ApplyMapping (dict) --

          Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The data inputs identified by their node names.

            • (string) --
          • Mapping (list) -- [REQUIRED]

            Specifies the mapping of data property keys in the data source to data property keys in the data target.

            • (dict) --

              Specifies the mapping of data property keys.

              • ToKey (string) --

                After the apply mapping, what the name of the column should be. Can be the same as FromPath .

              • FromPath (list) --

                The table or column to be modified.

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

                The type of the data to be modified.

              • ToType (string) --

                The data type that the data is to be modified to.

              • Dropped (boolean) --

                If true, then the column is removed.

              • Children (list) --

                Only applicable to nested data structures. If you want to change the parent structure, but also one of its children, you can fill out this data strucutre. It is also Mapping , but its FromPath will be the parent's FromPath plus the FromPath from this structure.

                For the children part, suppose you have the structure:

                { "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }

                You can specify a Mapping that looks like:

                { "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }
        • SelectFields (dict) --

          Specifies a transform that chooses the data property keys that you want to keep.

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The data inputs identified by their node names.

            • (string) --
          • Paths (list) -- [REQUIRED]

            A JSON path to a variable in the data structure.

            • (list) --
              • (string) --
        • DropFields (dict) --

          Specifies a transform that chooses the data property keys that you want to drop.

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The data inputs identified by their node names.

            • (string) --
          • Paths (list) -- [REQUIRED]

            A JSON path to a variable in the data structure.

            • (list) --
              • (string) --
        • RenameField (dict) --

          Specifies a transform that renames a single data property key.

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The data inputs identified by their node names.

            • (string) --
          • SourcePath (list) -- [REQUIRED]

            A JSON path to a variable in the data structure for the source data.

            • (string) --
          • TargetPath (list) -- [REQUIRED]

            A JSON path to a variable in the data structure for the target data.

            • (string) --
        • Spigot (dict) --

          Specifies a transform that writes samples of the data to an Amazon S3 bucket.

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The data inputs identified by their node names.

            • (string) --
          • Path (string) -- [REQUIRED]

            A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.

          • Topk (integer) --

            Specifies a number of records to write starting from the beginning of the dataset.

          • Prob (float) --

            The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.

        • Join (dict) --

          Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The data inputs identified by their node names.

            • (string) --
          • JoinType (string) -- [REQUIRED]

            Specifies the type of join to be performed on the datasets.

          • Columns (list) -- [REQUIRED]

            A list of the two columns to be joined.

            • (dict) --

              Specifies a column to be joined.

              • From (string) -- [REQUIRED]

                The column to be joined.

              • Keys (list) -- [REQUIRED]

                The key of the column to be joined.

                • (list) --
                  • (string) --
        • SplitFields (dict) --

          Specifies a transform that splits data property keys into two DynamicFrames . The output is a collection of DynamicFrames : one with selected data property keys, and one with the remaining data property keys.

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The data inputs identified by their node names.

            • (string) --
          • Paths (list) -- [REQUIRED]

            A JSON path to a variable in the data structure.

            • (list) --
              • (string) --
        • SelectFromCollection (dict) --

          Specifies a transform that chooses one DynamicFrame from a collection of DynamicFrames . The output is the selected DynamicFrame

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The data inputs identified by their node names.

            • (string) --
          • Index (integer) -- [REQUIRED]

            The index for the DynamicFrame to be selected.

        • FillMissingValues (dict) --

          Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The data inputs identified by their node names.

            • (string) --
          • ImputedPath (string) -- [REQUIRED]

            A JSON path to a variable in the data structure for the dataset that is imputed.

          • FilledPath (string) --

            A JSON path to a variable in the data structure for the dataset that is filled.

        • Filter (dict) --

          Specifies a transform that splits a dataset into two, based on a filter condition.

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The data inputs identified by their node names.

            • (string) --
          • LogicalOperator (string) -- [REQUIRED]

            The operator used to filter rows by comparing the key value to a specified value.

          • Filters (list) -- [REQUIRED]

            Specifies a filter expression.

            • (dict) --

              Specifies a filter expression.

              • Operation (string) -- [REQUIRED]

                The type of operation to perform in the expression.

              • Negated (boolean) --

                Whether the expression is to be negated.

              • Values (list) -- [REQUIRED]

                A list of filter values.

                • (dict) --

                  Represents a single entry in the list of values for a FilterExpression .

                  • Type (string) -- [REQUIRED]

                    The type of filter value.

                  • Value (list) -- [REQUIRED]

                    The value to be associated.

                    • (string) --
        • CustomCode (dict) --

          Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The data inputs identified by their node names.

            • (string) --
          • Code (string) -- [REQUIRED]

            The custom code that is used to perform the data transformation.

          • ClassName (string) -- [REQUIRED]

            The name defined for the custom code node class.

          • OutputSchemas (list) --

            Specifies the data schema for the custom code transform.

            • (dict) --

              Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

              • Columns (list) --

                Specifies the column definitions that make up a Glue schema.

                • (dict) --

                  Specifies a single column in a Glue schema definition.

                  • Name (string) -- [REQUIRED]

                    The name of the column in the Glue Studio schema.

                  • Type (string) --

                    The hive type for this column in the Glue Studio schema.

        • SparkSQL (dict) --

          Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single DynamicFrame .

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The data inputs identified by their node names. You can associate a table name with each input node to use in the SQL query. The name you choose must meet the Spark SQL naming restrictions.

            • (string) --
          • SqlQuery (string) -- [REQUIRED]

            A SQL query that must use Spark SQL syntax and return a single data set.

          • SqlAliases (list) -- [REQUIRED]

            A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For example, you have a datasource named "MyDataSource". If you specify From as MyDataSource, and Alias as SqlName, then in your SQL you can do:

            select * from SqlName

            and that gets data from MyDataSource.

            • (dict) --

              Represents a single entry in the list of values for SqlAliases .

              • From (string) -- [REQUIRED]

                A table, or a column in a table.

              • Alias (string) -- [REQUIRED]

                A temporary name given to a table, or a column in a table.

          • OutputSchemas (list) --

            Specifies the data schema for the SparkSQL transform.

            • (dict) --

              Specifies a user-defined schema when a schema cannot be determined by AWS Glue.

              • Columns (list) --

                Specifies the column definitions that make up a Glue schema.

                • (dict) --

                  Specifies a single column in a Glue schema definition.

                  • Name (string) -- [REQUIRED]

                    The name of the column in the Glue Studio schema.

                  • Type (string) --

                    The hive type for this column in the Glue Studio schema.

        • DirectKinesisSource (dict) --

          Specifies a direct Amazon Kinesis data source.

          • Name (string) -- [REQUIRED]

            The name of the data source.

          • WindowSize (integer) --

            The amount of time to spend processing each micro batch.

          • DetectSchema (boolean) --

            Whether to automatically determine the schema from the incoming data.

          • StreamingOptions (dict) --

            Additional options for the Kinesis streaming data source.

            • EndpointUrl (string) --

              The URL of the Kinesis endpoint.

            • StreamName (string) --

              The name of the Kinesis data stream.

            • Classification (string) --

              An optional classification.

            • Delimiter (string) --

              Specifies the delimiter character.

            • StartingPosition (string) --

              The starting position in the Kinesis data stream to read data from. The possible values are "latest" , "trim_horizon" , or "earliest" . The default value is "latest" .

            • MaxFetchTimeInMs (integer) --

              The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000 .

            • MaxFetchRecordsPerShard (integer) --

              The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000 .

            • MaxRecordPerRead (integer) --

              The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000 .

            • AddIdleTimeBetweenReads (boolean) --

              Adds a time delay between two consecutive getRecords operations. The default value is "False" . This option is only configurable for Glue version 2.0 and above.

            • IdleTimeBetweenReadsInMs (integer) --

              The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000 . This option is only configurable for Glue version 2.0 and above.

            • DescribeShardInterval (integer) --

              The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s .

            • NumRetries (integer) --

              The maximum number of retries for Kinesis Data Streams API requests. The default value is 3 .

            • RetryIntervalMs (integer) --

              The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000 .

            • MaxRetryIntervalMs (integer) --

              The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000 .

            • AvoidEmptyBatches (boolean) --

              Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False" .

            • StreamArn (string) --

              The Amazon Resource Name (ARN) of the Kinesis data stream.

            • RoleArn (string) --

              The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSSessionName" .

            • RoleSessionName (string) --

              An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSRoleARN" .

          • DataPreviewOptions (dict) --

            Additional options for data preview.

            • PollingTime (integer) --

              The polling time in milliseconds.

            • RecordPollingLimit (integer) --

              The limit to the number of records polled.

        • DirectKafkaSource (dict) --

          Specifies an Apache Kafka data store.

          • Name (string) -- [REQUIRED]

            The name of the data store.

          • StreamingOptions (dict) --

            Specifies the streaming options.

            • BootstrapServers (string) --

              A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094 . This option must be specified in the API call or defined in the table metadata in the Data Catalog.

            • SecurityProtocol (string) --

              The protocol used to communicate with brokers. The possible values are "SSL" or "PLAINTEXT" .

            • ConnectionName (string) --

              The name of the connection.

            • TopicName (string) --

              The topic name as specified in Apache Kafka. You must specify at least one of "topicName" , "assign" or "subscribePattern" .

            • Assign (string) --

              The specific TopicPartitions to consume. You must specify at least one of "topicName" , "assign" or "subscribePattern" .

            • SubscribePattern (string) --

              A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName" , "assign" or "subscribePattern" .

            • Classification (string) --

              An optional classification.

            • Delimiter (string) --

              Specifies the delimiter character.

            • StartingOffsets (string) --

              The starting position in the Kafka topic to read data from. The possible values are "earliest" or "latest" . The default value is "latest" .

            • EndingOffsets (string) --

              The end point when a batch query is ended. Possible values are either "latest" or a JSON string that specifies an ending offset for each TopicPartition .

            • PollTimeoutMs (integer) --

              The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512 .

            • NumRetries (integer) --

              The number of times to retry before failing to fetch Kafka offsets. The default value is 3 .

            • RetryIntervalMs (integer) --

              The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10 .

            • MaxOffsetsPerTrigger (integer) --

              The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.

            • MinPartitions (integer) --

              The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.

          • WindowSize (integer) --

            The amount of time to spend processing each micro batch.

          • DetectSchema (boolean) --

            Whether to automatically determine the schema from the incoming data.

          • DataPreviewOptions (dict) --

            Specifies options related to data preview for viewing a sample of your data.

            • PollingTime (integer) --

              The polling time in milliseconds.

            • RecordPollingLimit (integer) --

              The limit to the number of records polled.

        • CatalogKinesisSource (dict) --

          Specifies a Kinesis data source in the Glue Data Catalog.

          • Name (string) -- [REQUIRED]

            The name of the data source.

          • WindowSize (integer) --

            The amount of time to spend processing each micro batch.

          • DetectSchema (boolean) --

            Whether to automatically determine the schema from the incoming data.

          • Table (string) -- [REQUIRED]

            The name of the table in the database to read from.

          • Database (string) -- [REQUIRED]

            The name of the database to read from.

          • StreamingOptions (dict) --

            Additional options for the Kinesis streaming data source.

            • EndpointUrl (string) --

              The URL of the Kinesis endpoint.

            • StreamName (string) --

              The name of the Kinesis data stream.

            • Classification (string) --

              An optional classification.

            • Delimiter (string) --

              Specifies the delimiter character.

            • StartingPosition (string) --

              The starting position in the Kinesis data stream to read data from. The possible values are "latest" , "trim_horizon" , or "earliest" . The default value is "latest" .

            • MaxFetchTimeInMs (integer) --

              The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000 .

            • MaxFetchRecordsPerShard (integer) --

              The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000 .

            • MaxRecordPerRead (integer) --

              The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000 .

            • AddIdleTimeBetweenReads (boolean) --

              Adds a time delay between two consecutive getRecords operations. The default value is "False" . This option is only configurable for Glue version 2.0 and above.

            • IdleTimeBetweenReadsInMs (integer) --

              The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000 . This option is only configurable for Glue version 2.0 and above.

            • DescribeShardInterval (integer) --

              The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s .

            • NumRetries (integer) --

              The maximum number of retries for Kinesis Data Streams API requests. The default value is 3 .

            • RetryIntervalMs (integer) --

              The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000 .

            • MaxRetryIntervalMs (integer) --

              The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000 .

            • AvoidEmptyBatches (boolean) --

              Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False" .

            • StreamArn (string) --

              The Amazon Resource Name (ARN) of the Kinesis data stream.

            • RoleArn (string) --

              The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSSessionName" .

            • RoleSessionName (string) --

              An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSRoleARN" .

          • DataPreviewOptions (dict) --

            Additional options for data preview.

            • PollingTime (integer) --

              The polling time in milliseconds.

            • RecordPollingLimit (integer) --

              The limit to the number of records polled.

        • CatalogKafkaSource (dict) --

          Specifies an Apache Kafka data store in the Data Catalog.

          • Name (string) -- [REQUIRED]

            The name of the data store.

          • WindowSize (integer) --

            The amount of time to spend processing each micro batch.

          • DetectSchema (boolean) --

            Whether to automatically determine the schema from the incoming data.

          • Table (string) -- [REQUIRED]

            The name of the table in the database to read from.

          • Database (string) -- [REQUIRED]

            The name of the database to read from.

          • StreamingOptions (dict) --

            Specifies the streaming options.

            • BootstrapServers (string) --

              A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094 . This option must be specified in the API call or defined in the table metadata in the Data Catalog.

            • SecurityProtocol (string) --

              The protocol used to communicate with brokers. The possible values are "SSL" or "PLAINTEXT" .

            • ConnectionName (string) --

              The name of the connection.

            • TopicName (string) --

              The topic name as specified in Apache Kafka. You must specify at least one of "topicName" , "assign" or "subscribePattern" .

            • Assign (string) --

              The specific TopicPartitions to consume. You must specify at least one of "topicName" , "assign" or "subscribePattern" .

            • SubscribePattern (string) --

              A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName" , "assign" or "subscribePattern" .

            • Classification (string) --

              An optional classification.

            • Delimiter (string) --

              Specifies the delimiter character.

            • StartingOffsets (string) --

              The starting position in the Kafka topic to read data from. The possible values are "earliest" or "latest" . The default value is "latest" .

            • EndingOffsets (string) --

              The end point when a batch query is ended. Possible values are either "latest" or a JSON string that specifies an ending offset for each TopicPartition .

            • PollTimeoutMs (integer) --

              The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512 .

            • NumRetries (integer) --

              The number of times to retry before failing to fetch Kafka offsets. The default value is 3 .

            • RetryIntervalMs (integer) --

              The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10 .

            • MaxOffsetsPerTrigger (integer) --

              The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.

            • MinPartitions (integer) --

              The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.

          • DataPreviewOptions (dict) --

            Specifies options related to data preview for viewing a sample of your data.

            • PollingTime (integer) --

              The polling time in milliseconds.

            • RecordPollingLimit (integer) --

              The limit to the number of records polled.

        • DropNullFields (dict) --

          Specifies a transform that removes columns from the dataset if all values in the column are 'null'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The data inputs identified by their node names.

            • (string) --
          • NullCheckBoxList (dict) --

            A structure that represents whether certain values are recognized as null values for removal.

            • IsEmpty (boolean) --

              Specifies that an empty string is considered as a null value.

            • IsNullString (boolean) --

              Specifies that a value spelling out the word 'null' is considered as a null value.

            • IsNegOne (boolean) --

              Specifies that an integer value of -1 is considered as a null value.

          • NullTextList (list) --

            A structure that specifies a list of NullValueField structures that represent a custom null value such as zero or other value being used as a null placeholder unique to the dataset.

            The DropNullFields transform removes custom null values only if both the value of the null placeholder and the datatype match the data.

            • (dict) --

              Represents a custom null value such as a zeros or other value being used as a null placeholder unique to the dataset.

              • Value (string) -- [REQUIRED]

                The value of the null placeholder.

              • Datatype (dict) -- [REQUIRED]

                The datatype of the value.

                • Id (string) -- [REQUIRED]

                  The datatype of the value.

                • Label (string) -- [REQUIRED]

                  A label assigned to the datatype.

        • Merge (dict) --

          Specifies a transform that merges a DynamicFrame with a staging DynamicFrame based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The data inputs identified by their node names.

            • (string) --
          • Source (string) -- [REQUIRED]

            The source DynamicFrame that will be merged with a staging DynamicFrame .

          • PrimaryKeys (list) -- [REQUIRED]

            The list of primary key fields to match records from the source and staging dynamic frames.

            • (list) --
              • (string) --
        • Union (dict) --

          Specifies a transform that combines the rows from two or more datasets into a single result.

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The node ID inputs to the transform.

            • (string) --
          • UnionType (string) -- [REQUIRED]

            Indicates the type of Union transform.

            Specify ALL to join all rows from data sources to the resulting DynamicFrame. The resulting union does not remove duplicate rows.

            Specify DISTINCT to remove duplicate rows in the resulting DynamicFrame.

        • PIIDetection (dict) --

          Specifies a transform that identifies, removes or masks PII data.

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The node ID inputs to the transform.

            • (string) --
          • PiiType (string) -- [REQUIRED]

            Indicates the type of PIIDetection transform.

          • EntityTypesToDetect (list) -- [REQUIRED]

            Indicates the types of entities the PIIDetection transform will identify as PII data.

            PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE

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

            Indicates the output column name that will contain any entity type detected in that row.

          • SampleFraction (float) --

            Indicates the fraction of the data to sample when scanning for PII entities.

          • ThresholdFraction (float) --

            Indicates the fraction of the data that must be met in order for a column to be identified as PII data.

          • MaskValue (string) --

            Indicates the value that will replace the detected entity.

        • Aggregate (dict) --

          Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            Specifies the fields and rows to use as inputs for the aggregate transform.

            • (string) --
          • Groups (list) -- [REQUIRED]

            Specifies the fields to group by.

            • (list) --
              • (string) --
          • Aggs (list) -- [REQUIRED]

            Specifies the aggregate functions to be performed on specified fields.

            • (dict) --

              Specifies the set of parameters needed to perform aggregation in the aggregate transform.

              • Column (list) -- [REQUIRED]

                Specifies the column on the data set on which the aggregation function will be applied.

                • (string) --
              • AggFunc (string) -- [REQUIRED]

                Specifies the aggregation function to apply.

                Possible aggregation functions include: avg countDistinct, count, first, last, kurtosis, max, min, skewness, stddev_samp, stddev_pop, sum, sumDistinct, var_samp, var_pop

        • DropDuplicates (dict) --

          Specifies a transform that removes rows of repeating data from a data set.

          • Name (string) -- [REQUIRED]

            The name of the transform node.

          • Inputs (list) -- [REQUIRED]

            The data inputs identified by their node names.

            • (string) --
          • Columns (list) --

            The name of the columns to be merged or removed if repeating.

            • (list) --
              • (string) --
        • GovernedCatalogTarget (dict) --

          Specifies a data target that writes to a goverened catalog.

          • Name (string) -- [REQUIRED]

            The name of the data target.

          • Inputs (list) -- [REQUIRED]

            The nodes that are inputs to the data target.

            • (string) --
          • PartitionKeys (list) --

            Specifies native partitioning using a sequence of keys.

            • (list) --
              • (string) --
          • Table (string) -- [REQUIRED]

            The name of the table in the database to write to.

          • Database (string) -- [REQUIRED]

            The name of the database to write to.

          • SchemaChangePolicy (dict) --

            A policy that specifies update behavior for the governed catalog.

            • EnableUpdateCatalog (boolean) --

              Whether to use the specified update behavior when the crawler finds a changed schema.

            • UpdateBehavior (string) --

              The update behavior when the crawler finds a changed schema.

        • GovernedCatalogSource (dict) --

          Specifies a data source in a goverened Data Catalog.

          • Name (string) -- [REQUIRED]

            The name of the data store.

          • Database (string) -- [REQUIRED]

            The database to read from.

          • Table (string) -- [REQUIRED]

            The database table to read from.

          • PartitionPredicate (string) --

            Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to "" – empty by default.

          • AdditionalOptions (dict) --

            Specifies additional connection options.

            • BoundedSize (integer) --

              Sets the upper limit for the target size of the dataset in bytes that will be processed.

            • BoundedFiles (integer) --

              Sets the upper limit for the target number of files that will be processed.

        • MicrosoftSQLServerCatalogSource (dict) --

          Specifies a Microsoft SQL server data source in the Glue Data Catalog.

          • Name (string) -- [REQUIRED]

            The name of the data source.

          • Database (string) -- [REQUIRED]

            The name of the database to read from.

          • Table (string) -- [REQUIRED]

            The name of the table in the database to read from.

        • MySQLCatalogSource (dict) --

          Specifies a MySQL data source in the Glue Data Catalog.

          • Name (string) -- [REQUIRED]

            The name of the data source.

          • Database (string) -- [REQUIRED]

            The name of the database to read from.

          • Table (string) -- [REQUIRED]

            The name of the table in the database to read from.

        • OracleSQLCatalogSource (dict) --

          Specifies an Oracle data source in the Glue Data Catalog.

          • Name (string) -- [REQUIRED]

            The name of the data source.

          • Database (string) -- [REQUIRED]

            The name of the database to read from.

          • Table (string) -- [REQUIRED]

            The name of the table in the database to read from.

        • PostgreSQLCatalogSource (dict) --

          Specifies a PostgresSQL data source in the Glue Data Catalog.

          • Name (string) -- [REQUIRED]

            The name of the data source.

          • Database (string) -- [REQUIRED]

            The name of the database to read from.

          • Table (string) -- [REQUIRED]

            The name of the table in the database to read from.

        • MicrosoftSQLServerCatalogTarget (dict) --

          Specifies a target that uses Microsoft SQL.

          • Name (string) -- [REQUIRED]

            The name of the data target.

          • Inputs (list) -- [REQUIRED]

            The nodes that are inputs to the data target.

            • (string) --
          • Database (string) -- [REQUIRED]

            The name of the database to write to.

          • Table (string) -- [REQUIRED]

            The name of the table in the database to write to.

        • MySQLCatalogTarget (dict) --

          Specifies a target that uses MySQL.

          • Name (string) -- [REQUIRED]

            The name of the data target.

          • Inputs (list) -- [REQUIRED]

            The nodes that are inputs to the data target.

            • (string) --
          • Database (string) -- [REQUIRED]

            The name of the database to write to.

          • Table (string) -- [REQUIRED]

            The name of the table in the database to write to.

        • OracleSQLCatalogTarget (dict) --

          Specifies a target that uses Oracle SQL.

          • Name (string) -- [REQUIRED]

            The name of the data target.

          • Inputs (list) -- [REQUIRED]

            The nodes that are inputs to the data target.

            • (string) --
          • Database (string) -- [REQUIRED]

            The name of the database to write to.

          • Table (string) -- [REQUIRED]

            The name of the table in the database to write to.

        • PostgreSQLCatalogTarget (dict) --

          Specifies a target that uses Postgres SQL.

          • Name (string) -- [REQUIRED]

            The name of the data target.

          • Inputs (list) -- [REQUIRED]

            The nodes that are inputs to the data target.

            • (string) --
          • Database (string) -- [REQUIRED]

            The name of the database to write to.

          • Table (string) -- [REQUIRED]

            The name of the table in the database to write to.

  • ExecutionClass (string) --

    Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

    The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

    Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX . The flexible execution class is available for Spark jobs.

Return type

dict

Returns

Response Syntax

{
    'Name': 'string'
}

Response Structure

  • (dict) --

    • Name (string) --

      The unique name that was provided for this job definition.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.IdempotentParameterMismatchException
  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
  • Glue.Client.exceptions.ConcurrentModificationException
create_ml_transform(**kwargs)

Creates an Glue machine learning transform. This operation creates the transform and all the necessary parameters to train it.

Call this operation as the first step in the process of using a machine learning transform (such as the FindMatches transform) for deduplicating data. You can provide an optional Description , in addition to the parameters that you want to use for your algorithm.

You must also specify certain parameters for the tasks that Glue runs on your behalf as part of learning from your data and creating a high-quality machine learning transform. These parameters include Role , and optionally, AllocatedCapacity , Timeout , and MaxRetries . For more information, see Jobs .

See also: AWS API Documentation

Request Syntax

response = client.create_ml_transform(
    Name='string',
    Description='string',
    InputRecordTables=[
        {
            'DatabaseName': 'string',
            'TableName': 'string',
            'CatalogId': 'string',
            'ConnectionName': 'string'
        },
    ],
    Parameters={
        'TransformType': 'FIND_MATCHES',
        'FindMatchesParameters': {
            'PrimaryKeyColumnName': 'string',
            'PrecisionRecallTradeoff': 123.0,
            'AccuracyCostTradeoff': 123.0,
            'EnforceProvidedLabels': True|False
        }
    },
    Role='string',
    GlueVersion='string',
    MaxCapacity=123.0,
    WorkerType='Standard'|'G.1X'|'G.2X'|'G.025X',
    NumberOfWorkers=123,
    Timeout=123,
    MaxRetries=123,
    Tags={
        'string': 'string'
    },
    TransformEncryption={
        'MlUserDataEncryption': {
            'MlUserDataEncryptionMode': 'DISABLED'|'SSE-KMS',
            'KmsKeyId': 'string'
        },
        'TaskRunSecurityConfigurationName': 'string'
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

    The unique name that you give the transform when you create it.

  • Description (string) -- A description of the machine learning transform that is being defined. The default is an empty string.
  • InputRecordTables (list) --

    [REQUIRED]

    A list of Glue table definitions used by the transform.

    • (dict) --

      The database and table in the Glue Data Catalog that is used for input or output data.

      • DatabaseName (string) -- [REQUIRED]

        A database name in the Glue Data Catalog.

      • TableName (string) -- [REQUIRED]

        A table name in the Glue Data Catalog.

      • CatalogId (string) --

        A unique identifier for the Glue Data Catalog.

      • ConnectionName (string) --

        The name of the connection to the Glue Data Catalog.

  • Parameters (dict) --

    [REQUIRED]

    The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.

    • TransformType (string) -- [REQUIRED]

      The type of machine learning transform.

      For information about the types of machine learning transforms, see Creating Machine Learning Transforms .

    • FindMatchesParameters (dict) --

      The parameters for the find matches algorithm.

      • PrimaryKeyColumnName (string) --

        The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.

      • PrecisionRecallTradeoff (float) --

        The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.

        The precision metric indicates how often your model is correct when it predicts a match.

        The recall metric indicates that for an actual match, how often your model predicts the match.

      • AccuracyCostTradeoff (float) --

        The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate FindMatches transform, sometimes with unacceptable accuracy.

        Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.

        Cost measures how many compute resources, and thus money, are consumed to run the transform.

      • EnforceProvidedLabels (boolean) --

        The value to switch on or off to force the output to match the provided labels from users. If the value is True , the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False , the find matches transform does not ensure all the labels provided are respected, and the results rely on the trained model.

        Note that setting this value to true may increase the conflation execution time.

  • Role (string) --

    [REQUIRED]

    The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.

    • This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue .
    • This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
  • GlueVersion (string) -- This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
  • MaxCapacity (float) --

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

    MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType .
    • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
    • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
    • If WorkerType is set, then NumberOfWorkers is required (and vice versa).
    • MaxCapacity and NumberOfWorkers must both be at least 1.

    When the WorkerType field is set to a value other than Standard , the MaxCapacity field is set automatically and becomes read-only.

    When the WorkerType field is set to a value other than Standard , the MaxCapacity field is set automatically and becomes read-only.

  • WorkerType (string) --

    The type of predefined worker that is allocated when this task 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.
    MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType .
    • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
    • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
    • If WorkerType is set, then NumberOfWorkers is required (and vice versa).
    • MaxCapacity and NumberOfWorkers must both be at least 1.
  • NumberOfWorkers (integer) --

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

    If WorkerType is set, then NumberOfWorkers is required (and vice versa).

  • Timeout (integer) -- The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
  • MaxRetries (integer) -- The maximum number of times to retry a task for this transform after a task run fails.
  • Tags (dict) --

    The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

    • (string) --
      • (string) --
  • TransformEncryption (dict) --

    The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.

    • MlUserDataEncryption (dict) --

      An MLUserDataEncryption object containing the encryption mode and customer-provided KMS key ID.

      • MlUserDataEncryptionMode (string) -- [REQUIRED]

        The encryption mode applied to user data. Valid values are:

        • DISABLED: encryption is disabled
        • SSEKMS: use of server-side encryption with Key Management Service (SSE-KMS) for user data stored in Amazon S3.
      • KmsKeyId (string) --

        The ID for the customer-provided KMS key.

    • TaskRunSecurityConfigurationName (string) --

      The name of the security configuration.

Return type

dict

Returns

Response Syntax

{
    'TransformId': 'string'
}

Response Structure

  • (dict) --

    • TransformId (string) --

      A unique identifier that is generated for the transform.

Exceptions

  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.AccessDeniedException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
  • Glue.Client.exceptions.IdempotentParameterMismatchException
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',
                    'Parameters': {
                        'string': 'string'
                    }
                },
            ],
            'Location': 'string',
            'AdditionalLocations': [
                'string',
            ],
            'InputFormat': 'string',
            'OutputFormat': 'string',
            'Compressed': True|False,
            'NumberOfBuckets': 123,
            'SerdeInfo': {
                'Name': 'string',
                'SerializationLibrary': 'string',
                'Parameters': {
                    'string': 'string'
                }
            },
            'BucketColumns': [
                'string',
            ],
            'SortColumns': [
                {
                    'Column': 'string',
                    'SortOrder': 123
                },
            ],
            'Parameters': {
                'string': 'string'
            },
            'SkewedInfo': {
                'SkewedColumnNames': [
                    'string',
                ],
                'SkewedColumnValues': [
                    'string',
                ],
                'SkewedColumnValueLocationMaps': {
                    'string': 'string'
                }
            },
            'StoredAsSubDirectories': True|False,
            'SchemaReference': {
                'SchemaId': {
                    'SchemaArn': 'string',
                    'SchemaName': 'string',
                    'RegistryName': 'string'
                },
                'SchemaVersionId': 'string',
                'SchemaVersionNumber': 123
            }
        },
        'Parameters': {
            'string': 'string'
        },
        'LastAnalyzedTime': datetime(2015, 1, 1)
    }
)
Parameters
  • CatalogId (string) -- The Amazon Web Services account ID of the catalog in which the partition is to be created.
  • 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.

      The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.

      • (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 data type of the Column .

          • Comment (string) --

            A free-form text comment.

          • Parameters (dict) --

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

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

      • AdditionalLocations (list) --

        A list of locations that point to the path where a Delta table is located.

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

        The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.

      • OutputFormat (string) --

        The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.

      • Compressed (boolean) --
        True if the data in the table is compressed, or False if not.
      • NumberOfBuckets (integer) --

        Must be specified if the table contains any dimension columns.

      • SerdeInfo (dict) --

        The serialization/deserialization (SerDe) information.

        • Name (string) --

          Name of the SerDe.

        • SerializationLibrary (string) --

          Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .

        • Parameters (dict) --

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

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

        The user-supplied properties in key-value form.

        • (string) --
          • (string) --
      • SkewedInfo (dict) --

        The information about values that appear frequently in a column (skewed values).

        • SkewedColumnNames (list) --

          A list of names of columns that contain skewed values.

          • (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.
      • SchemaReference (dict) --

        An object that references a schema stored in the Glue Schema Registry.

        When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

        • SchemaId (dict) --

          A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.

          • SchemaArn (string) --

            The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.

          • SchemaName (string) --

            The name of the schema. One of SchemaArn or SchemaName has to be provided.

          • RegistryName (string) --

            The name of the schema registry that contains the schema.

        • SchemaVersionId (string) --

          The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.

        • SchemaVersionNumber (integer) --

          The version number of the schema.

    • Parameters (dict) --

      These key-value pairs define partition parameters.

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

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.GlueEncryptionException
create_partition_index(**kwargs)

Creates a specified partition index in an existing table.

See also: AWS API Documentation

Request Syntax

response = client.create_partition_index(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    PartitionIndex={
        'Keys': [
            'string',
        ],
        'IndexName': 'string'
    }
)
Parameters
  • CatalogId (string) -- The catalog ID where the table resides.
  • DatabaseName (string) --

    [REQUIRED]

    Specifies the name of a database in which you want to create a partition index.

  • TableName (string) --

    [REQUIRED]

    Specifies the name of a table in which you want to create a partition index.

  • PartitionIndex (dict) --

    [REQUIRED]

    Specifies a PartitionIndex structure to create a partition index in an existing table.

    • Keys (list) -- [REQUIRED]

      The keys for the partition index.

      • (string) --
    • IndexName (string) -- [REQUIRED]

      The name of the partition index.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.GlueEncryptionException
create_registry(**kwargs)

Creates a new registry which may be used to hold a collection of schemas.

See also: AWS API Documentation

Request Syntax

response = client.create_registry(
    RegistryName='string',
    Description='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • RegistryName (string) --

    [REQUIRED]

    Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.

  • Description (string) -- A description of the registry. If description is not provided, there will not be any default value for this.
  • Tags (dict) --

    Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API.

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

dict

Returns

Response Syntax

{
    'RegistryArn': 'string',
    'RegistryName': 'string',
    'Description': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • RegistryArn (string) --

      The Amazon Resource Name (ARN) of the newly created registry.

    • RegistryName (string) --

      The name of the registry.

    • Description (string) --

      A description of the registry.

    • Tags (dict) --

      The tags for the registry.

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

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.AccessDeniedException
  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
  • Glue.Client.exceptions.ConcurrentModificationException
  • Glue.Client.exceptions.InternalServiceException
create_schema(**kwargs)

Creates a new schema set and registers the schema definition. Returns an error if the schema set already exists without actually registering the version.

When the schema set is created, a version checkpoint will be set to the first version. Compatibility mode "DISABLED" restricts any additional schema versions from being added after the first schema version. For all other compatibility modes, validation of compatibility settings will be applied only from the second version onwards when the RegisterSchemaVersion API is used.

When this API is called without a RegistryId , this will create an entry for a "default-registry" in the registry database tables, if it is not already present.

See also: AWS API Documentation

Request Syntax

response = client.create_schema(
    RegistryId={
        'RegistryName': 'string',
        'RegistryArn': 'string'
    },
    SchemaName='string',
    DataFormat='AVRO'|'JSON'|'PROTOBUF',
    Compatibility='NONE'|'DISABLED'|'BACKWARD'|'BACKWARD_ALL'|'FORWARD'|'FORWARD_ALL'|'FULL'|'FULL_ALL',
    Description='string',
    Tags={
        'string': 'string'
    },
    SchemaDefinition='string'
)
Parameters
  • RegistryId (dict) --

    This is a wrapper shape to contain the registry identity fields. If this is not provided, the default registry will be used. The ARN format for the same will be: arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id .

    • RegistryName (string) --

      Name of the registry. Used only for lookup. One of RegistryArn or RegistryName has to be provided.

    • RegistryArn (string) --

      Arn of the registry to be updated. One of RegistryArn or RegistryName has to be provided.

  • SchemaName (string) --

    [REQUIRED]

    Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.

  • DataFormat (string) --

    [REQUIRED]

    The data format of the schema definition. Currently AVRO , JSON and PROTOBUF are supported.

  • Compatibility (string) --

    The compatibility mode of the schema. The possible values are:

    • NONE : No compatibility mode applies. You can use this choice in development scenarios or if you do not know the compatibility mode that you want to apply to schemas. Any new version added will be accepted without undergoing a compatibility check.
    • DISABLED : This compatibility choice prevents versioning for a particular schema. You can use this choice to prevent future versioning of a schema.
    • BACKWARD : This compatibility choice is recommended as it allows data receivers to read both the current and one previous schema version. This means that for instance, a new schema version cannot drop data fields or change the type of these fields, so they can't be read by readers using the previous version.
    • BACKWARD_ALL : This compatibility choice allows data receivers to read both the current and all previous schema versions. You can use this choice when you need to delete fields or add optional fields, and check compatibility against all previous schema versions.
    • FORWARD : This compatibility choice allows data receivers to read both the current and one next schema version, but not necessarily later versions. You can use this choice when you need to add fields or delete optional fields, but only check compatibility against the last schema version.
    • FORWARD_ALL : This compatibility choice allows data receivers to read written by producers of any new registered schema. You can use this choice when you need to add fields or delete optional fields, and check compatibility against all previous schema versions.
    • FULL : This compatibility choice allows data receivers to read data written by producers using the previous or next version of the schema, but not necessarily earlier or later versions. You can use this choice when you need to add or remove optional fields, but only check compatibility against the last schema version.
    • FULL_ALL : This compatibility choice allows data receivers to read data written by producers using all previous schema versions. You can use this choice when you need to add or remove optional fields, and check compatibility against all previous schema versions.
  • Description (string) -- An optional description of the schema. If description is not provided, there will not be any automatic default value for this.
  • Tags (dict) --

    Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API. If specified, follows the Amazon Web Services tags-on-create pattern.

    • (string) --
      • (string) --
  • SchemaDefinition (string) -- The schema definition using the DataFormat setting for SchemaName .
Return type

dict

Returns

Response Syntax

{
    'RegistryName': 'string',
    'RegistryArn': 'string',
    'SchemaName': 'string',
    'SchemaArn': 'string',
    'Description': 'string',
    'DataFormat': 'AVRO'|'JSON'|'PROTOBUF',
    'Compatibility': 'NONE'|'DISABLED'|'BACKWARD'|'BACKWARD_ALL'|'FORWARD'|'FORWARD_ALL'|'FULL'|'FULL_ALL',
    'SchemaCheckpoint': 123,
    'LatestSchemaVersion': 123,
    'NextSchemaVersion': 123,
    'SchemaStatus': 'AVAILABLE'|'PENDING'|'DELETING',
    'Tags': {
        'string': 'string'
    },
    'SchemaVersionId': 'string',
    'SchemaVersionStatus': 'AVAILABLE'|'PENDING'|'FAILURE'|'DELETING'
}

Response Structure

  • (dict) --

    • RegistryName (string) --

      The name of the registry.

    • RegistryArn (string) --

      The Amazon Resource Name (ARN) of the registry.

    • SchemaName (string) --

      The name of the schema.

    • SchemaArn (string) --

      The Amazon Resource Name (ARN) of the schema.

    • Description (string) --

      A description of the schema if specified when created.

    • DataFormat (string) --

      The data format of the schema definition. Currently AVRO , JSON and PROTOBUF are supported.

    • Compatibility (string) --

      The schema compatibility mode.

    • SchemaCheckpoint (integer) --

      The version number of the checkpoint (the last time the compatibility mode was changed).

    • LatestSchemaVersion (integer) --

      The latest version of the schema associated with the returned schema definition.

    • NextSchemaVersion (integer) --

      The next version of the schema associated with the returned schema definition.

    • SchemaStatus (string) --

      The status of the schema.

    • Tags (dict) --

      The tags for the schema.

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

      The unique identifier of the first schema version.

    • SchemaVersionStatus (string) --

      The status of the first schema version created.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.AccessDeniedException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
  • Glue.Client.exceptions.ConcurrentModificationException
  • Glue.Client.exceptions.InternalServiceException
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.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
create_security_configuration(**kwargs)

Creates a new security configuration. A security configuration is a set of security properties that can be used by Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints .

See also: AWS API Documentation

Request Syntax

response = client.create_security_configuration(
    Name='string',
    EncryptionConfiguration={
        'S3Encryption': [
            {
                'S3EncryptionMode': 'DISABLED'|'SSE-KMS'|'SSE-S3',
                'KmsKeyArn': 'string'
            },
        ],
        'CloudWatchEncryption': {
            'CloudWatchEncryptionMode': 'DISABLED'|'SSE-KMS',
            'KmsKeyArn': 'string'
        },
        'JobBookmarksEncryption': {
            'JobBookmarksEncryptionMode': 'DISABLED'|'CSE-KMS',
            'KmsKeyArn': 'string'
        }
    }
)
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 Amazon Simple Storage Service (Amazon S3) data.

      • (dict) --

        Specifies how Amazon Simple Storage Service (Amazon S3) data should be encrypted.

        • S3EncryptionMode (string) --

          The encryption mode to use for Amazon S3 data.

        • KmsKeyArn (string) --

          The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

    • CloudWatchEncryption (dict) --

      The encryption configuration for Amazon CloudWatch.

      • CloudWatchEncryptionMode (string) --

        The encryption mode to use for CloudWatch data.

      • KmsKeyArn (string) --

        The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

    • JobBookmarksEncryption (dict) --

      The encryption configuration for job bookmarks.

      • JobBookmarksEncryptionMode (string) --

        The encryption mode to use for job bookmarks data.

      • KmsKeyArn (string) --

        The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

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.

Exceptions

  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
create_session(**kwargs)

Creates a new session.

See also: AWS API Documentation

Request Syntax

response = client.create_session(
    Id='string',
    Description='string',
    Role='string',
    Command={
        'Name': 'string',
        'PythonVersion': 'string'
    },
    Timeout=123,
    IdleTimeout=123,
    DefaultArguments={
        'string': 'string'
    },
    Connections={
        'Connections': [
            'string',
        ]
    },
    MaxCapacity=123.0,
    NumberOfWorkers=123,
    WorkerType='Standard'|'G.1X'|'G.2X'|'G.025X',
    SecurityConfiguration='string',
    GlueVersion='string',
    Tags={
        'string': 'string'
    },
    RequestOrigin='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of the session request.

  • Description (string) -- The description of the session.
  • Role (string) --

    [REQUIRED]

    The IAM Role ARN

  • Command (dict) --

    [REQUIRED]

    The SessionCommand that runs the job.

    • Name (string) --

      Specifies the name of the SessionCommand. Can be 'glueetl' or 'gluestreaming'.

    • PythonVersion (string) --

      Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.

  • Timeout (integer) -- The number of seconds before request times out.
  • IdleTimeout (integer) -- The number of seconds when idle before request times out.
  • DefaultArguments (dict) --

    A map array of key-value pairs. Max is 75 pairs.

    • (string) --
      • (string) --
  • Connections (dict) --

    The number of connections to use for the session.

    • Connections (list) --

      A list of connections used by the job.

      • (string) --
  • MaxCapacity (float) -- The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
  • NumberOfWorkers (integer) -- The number of workers of a defined WorkerType to use for the session.
  • WorkerType (string) --

    The type of predefined worker that is allocated to use for the session. Accepts a value of Standard, G.1X, G.2X, or G.025X.

    • 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.
    • For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
  • SecurityConfiguration (string) -- The name of the SecurityConfiguration structure to be used with the session
  • GlueVersion (string) -- The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
  • Tags (dict) --

    The map of key value pairs (tags) belonging to the session.

    • (string) --
      • (string) --
  • RequestOrigin (string) -- The origin of the request.
Return type

dict

Returns

Response Syntax

{
    'Session': {
        'Id': 'string',
        'CreatedOn': datetime(2015, 1, 1),
        'Status': 'PROVISIONING'|'READY'|'FAILED'|'TIMEOUT'|'STOPPING'|'STOPPED',
        'ErrorMessage': 'string',
        'Description': 'string',
        'Role': 'string',
        'Command': {
            'Name': 'string',
            'PythonVersion': 'string'
        },
        'DefaultArguments': {
            'string': 'string'
        },
        'Connections': {
            'Connections': [
                'string',
            ]
        },
        'Progress': 123.0,
        'MaxCapacity': 123.0,
        'SecurityConfiguration': 'string',
        'GlueVersion': 'string'
    }
}

Response Structure

  • (dict) --

    • Session (dict) --

      Returns the session object in the response.

      • Id (string) --

        The ID of the session.

      • CreatedOn (datetime) --

        The time and date when the session was created.

      • Status (string) --

        The session status.

      • ErrorMessage (string) --

        The error message displayed during the session.

      • Description (string) --

        The description of the session.

      • Role (string) --

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

      • Command (dict) --

        The command object.See SessionCommand.

        • Name (string) --

          Specifies the name of the SessionCommand. Can be 'glueetl' or 'gluestreaming'.

        • PythonVersion (string) --

          Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.

      • DefaultArguments (dict) --

        A map array of key-value pairs. Max is 75 pairs.

        • (string) --
          • (string) --
      • Connections (dict) --

        The number of connections used for the session.

        • Connections (list) --

          A list of connections used by the job.

          • (string) --
      • Progress (float) --

        The code execution progress of the session.

      • MaxCapacity (float) --

        The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.

      • SecurityConfiguration (string) --

        The name of the SecurityConfiguration structure to be used with the session.

      • GlueVersion (string) --

        The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.

Exceptions

  • Glue.Client.exceptions.AccessDeniedException
  • Glue.Client.exceptions.IdempotentParameterMismatchException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.ValidationException
  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
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',
                    'Parameters': {
                        'string': 'string'
                    }
                },
            ],
            'Location': 'string',
            'AdditionalLocations': [
                'string',
            ],
            'InputFormat': 'string',
            'OutputFormat': 'string',
            'Compressed': True|False,
            'NumberOfBuckets': 123,
            'SerdeInfo': {
                'Name': 'string',
                'SerializationLibrary': 'string',
                'Parameters': {
                    'string': 'string'
                }
            },
            'BucketColumns': [
                'string',
            ],
            'SortColumns': [
                {
                    'Column': 'string',
                    'SortOrder': 123
                },
            ],
            'Parameters': {
                'string': 'string'
            },
            'SkewedInfo': {
                'SkewedColumnNames': [
                    'string',
                ],
                'SkewedColumnValues': [
                    'string',
                ],
                'SkewedColumnValueLocationMaps': {
                    'string': 'string'
                }
            },
            'StoredAsSubDirectories': True|False,
            'SchemaReference': {
                'SchemaId': {
                    'SchemaArn': 'string',
                    'SchemaName': 'string',
                    'RegistryName': 'string'
                },
                'SchemaVersionId': 'string',
                'SchemaVersionNumber': 123
            }
        },
        'PartitionKeys': [
            {
                'Name': 'string',
                'Type': 'string',
                'Comment': 'string',
                'Parameters': {
                    'string': 'string'
                }
            },
        ],
        'ViewOriginalText': 'string',
        'ViewExpandedText': 'string',
        'TableType': 'string',
        'Parameters': {
            'string': 'string'
        },
        'TargetTable': {
            'CatalogId': 'string',
            'DatabaseName': 'string',
            'Name': 'string'
        }
    },
    PartitionIndexes=[
        {
            'Keys': [
                'string',
            ],
            'IndexName': 'string'
        },
    ],
    TransactionId='string'
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog in which to create the Table . If none is supplied, the Amazon Web Services 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]

      The table name. For Hive compatibility, this is folded to lowercase when it is stored.

    • Description (string) --

      A description of the table.

    • Owner (string) --

      The table owner.

    • LastAccessTime (datetime) --

      The last time that the table was accessed.

    • LastAnalyzedTime (datetime) --

      The last time that column statistics were computed for this table.

    • Retention (integer) --

      The retention time for this table.

    • StorageDescriptor (dict) --

      A storage descriptor containing information about the physical storage of this table.

      • Columns (list) --

        A list of the Columns in the table.

        • (dict) --

          A column in a Table .

          • Name (string) -- [REQUIRED]

            The name of the Column .

          • Type (string) --

            The data type of the Column .

          • Comment (string) --

            A free-form text comment.

          • Parameters (dict) --

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

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

      • AdditionalLocations (list) --

        A list of locations that point to the path where a Delta table is located.

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

        The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.

      • OutputFormat (string) --

        The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.

      • Compressed (boolean) --
        True if the data in the table is compressed, or False if not.
      • NumberOfBuckets (integer) --

        Must be specified if the table contains any dimension columns.

      • SerdeInfo (dict) --

        The serialization/deserialization (SerDe) information.

        • Name (string) --

          Name of the SerDe.

        • SerializationLibrary (string) --

          Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .

        • Parameters (dict) --

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

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

        The user-supplied properties in key-value form.

        • (string) --
          • (string) --
      • SkewedInfo (dict) --

        The information about values that appear frequently in a column (skewed values).

        • SkewedColumnNames (list) --

          A list of names of columns that contain skewed values.

          • (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.
      • SchemaReference (dict) --

        An object that references a schema stored in the Glue Schema Registry.

        When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

        • SchemaId (dict) --

          A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.

          • SchemaArn (string) --

            The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.

          • SchemaName (string) --

            The name of the schema. One of SchemaArn or SchemaName has to be provided.

          • RegistryName (string) --

            The name of the schema registry that contains the schema.

        • SchemaVersionId (string) --

          The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.

        • SchemaVersionNumber (integer) --

          The version number of the schema.

    • PartitionKeys (list) --

      A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

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

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

        A column in a Table .

        • Name (string) -- [REQUIRED]

          The name of the Column .

        • Type (string) --

          The data type of the Column .

        • Comment (string) --

          A free-form text comment.

        • Parameters (dict) --

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

          • (string) --
            • (string) --
    • 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) --
    • TargetTable (dict) --

      A TableIdentifier structure that describes a target table for resource linking.

      • CatalogId (string) --

        The ID of the Data Catalog in which the table resides.

      • DatabaseName (string) --

        The name of the catalog database that contains the target table.

      • Name (string) --

        The name of the target table.

  • PartitionIndexes (list) --

    A list of partition indexes, PartitionIndex structures, to create in the table.

    • (dict) --

      A structure for a partition index.

      • Keys (list) -- [REQUIRED]

        The keys for the partition index.

        • (string) --
      • IndexName (string) -- [REQUIRED]

        The name of the partition index.

  • TransactionId (string) -- The ID of the transaction.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.GlueEncryptionException
  • Glue.Client.exceptions.ConcurrentModificationException
  • Glue.Client.exceptions.ResourceNotReadyException
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'|'EVENT',
    Schedule='string',
    Predicate={
        'Logical': 'AND'|'ANY',
        'Conditions': [
            {
                'LogicalOperator': 'EQUALS',
                'JobName': 'string',
                'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT'|'ERROR'|'WAITING',
                'CrawlerName': 'string',
                'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'|'ERROR'
            },
        ]
    },
    Actions=[
        {
            'JobName': 'string',
            'Arguments': {
                'string': 'string'
            },
            'Timeout': 123,
            'SecurityConfiguration': 'string',
            'NotificationProperty': {
                'NotifyDelayAfter': 123
            },
            'CrawlerName': 'string'
        },
    ],
    Description='string',
    StartOnCreation=True|False,
    Tags={
        'string': 'string'
    },
    EventBatchingCondition={
        'BatchSize': 123,
        'BatchWindow': 123
    }
)
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 only job states that a trigger can listen for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED .

        • CrawlerName (string) --

          The name of the crawler to which this condition applies.

        • CrawlState (string) --

          The state of the crawler to which this condition applies.

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

      • Arguments (dict) --

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

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

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

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

        • (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 Glue, see Amazon Web Services Tags in Glue in the developer guide.

    • (string) --
      • (string) --
  • EventBatchingCondition (dict) --

    Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.

    • BatchSize (integer) -- [REQUIRED]

      Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.

    • BatchWindow (integer) --

      Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.

Return type

dict

Returns

Response Syntax

{
    'Name': 'string'
}

Response Structure

  • (dict) --

    • Name (string) --

      The name of the trigger.

Exceptions

  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.IdempotentParameterMismatchException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
  • Glue.Client.exceptions.ConcurrentModificationException
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 provided, the Amazon Web Services 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) --

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

Exceptions

  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
  • Glue.Client.exceptions.GlueEncryptionException
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'
    },
    MaxConcurrentRuns=123
)
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) --
  • MaxConcurrentRuns (integer) -- You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
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.

Exceptions

  • Glue.Client.exceptions.AlreadyExistsException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.ResourceNumberLimitExceededException
  • Glue.Client.exceptions.ConcurrentModificationException
delete_blueprint(**kwargs)

Deletes an existing blueprint.

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

The name of the blueprint to delete.

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

Response Structure

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

      Returns the name of the blueprint that was deleted.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InternalServiceException
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) --

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.OperationTimeoutException
delete_column_statistics_for_partition(**kwargs)

Delete the partition column statistics of a column.

The Identity and Access Management (IAM) permission required for this operation is DeletePartition .

See also: AWS API Documentation

Request Syntax

response = client.delete_column_statistics_for_partition(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    PartitionValues=[
        'string',
    ],
    ColumnName='string'
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services 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.

  • PartitionValues (list) --

    [REQUIRED]

    A list of partition values identifying the partition.

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

    [REQUIRED]

    Name of the column.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.GlueEncryptionException
delete_column_statistics_for_table(**kwargs)

Retrieves table statistics of columns.

The Identity and Access Management (IAM) permission required for this operation is DeleteTable .

See also: AWS API Documentation

Request Syntax

response = client.delete_column_statistics_for_table(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    ColumnName='string'
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services 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.

  • ColumnName (string) --

    [REQUIRED]

    The name of the column.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.GlueEncryptionException
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 Amazon Web Services 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) --

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.OperationTimeoutException
delete_crawler(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

The name of the crawler to remove.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.CrawlerRunningException
  • Glue.Client.exceptions.SchedulerTransitioningException
  • Glue.Client.exceptions.OperationTimeoutException
delete_custom_entity_type(**kwargs)

Deletes a custom pattern by specifying its name.

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

The name of the custom pattern that you want to delete.

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

Response Structure

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

      The name of the custom pattern you deleted.

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.AccessDeniedException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.OperationTimeoutException
delete_database(**kwargs)

Removes a specified database from a Data Catalog.

Note

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

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

See also: AWS API Documentation

Request Syntax

response = client.delete_database(
    CatalogId='string',
    Name='string'
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services 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) --

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.ConcurrentModificationException
delete_dev_endpoint(**kwargs)

Deletes a specified development endpoint.

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

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InvalidInputException
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.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
delete_ml_transform(**kwargs)

Deletes an Glue machine learning transform. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. If you no longer need a transform, you can delete it by calling DeleteMLTransforms . However, any Glue jobs that still reference the deleted transform will no longer succeed.

See also: AWS API Documentation

Request Syntax

response = client.delete_ml_transform(
    TransformId='string'
)
Parameters
TransformId (string) --

[REQUIRED]

The unique identifier of the transform to delete.

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

Response Structure

  • (dict) --
    • TransformId (string) --

      The unique identifier of the transform that was deleted.

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InternalServiceException
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 provided, the Amazon Web Services 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 that contains the partition to be deleted.

  • PartitionValues (list) --

    [REQUIRED]

    The values that define the partition.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
delete_partition_index(**kwargs)

Deletes a specified partition index from an existing table.

See also: AWS API Documentation

Request Syntax

response = client.delete_partition_index(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    IndexName='string'
)
Parameters
  • CatalogId (string) -- The catalog ID where the table resides.
  • DatabaseName (string) --

    [REQUIRED]

    Specifies the name of a database from which you want to delete a partition index.

  • TableName (string) --

    [REQUIRED]

    Specifies the name of a table from which you want to delete a partition index.

  • IndexName (string) --

    [REQUIRED]

    The name of the partition index to be deleted.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.ConflictException
  • Glue.Client.exceptions.GlueEncryptionException
delete_registry(**kwargs)

Delete the entire registry including schema and all of its versions. To get the status of the delete operation, you can call the GetRegistry API after the asynchronous call. Deleting a registry will deactivate all online operations for the registry such as the UpdateRegistry , CreateSchema , UpdateSchema , and RegisterSchemaVersion APIs.

See also: AWS API Documentation

Request Syntax

response = client.delete_registry(
    RegistryId={
        'RegistryName': 'string',
        'RegistryArn': 'string'
    }
)
Parameters
RegistryId (dict) --

[REQUIRED]

This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).

  • RegistryName (string) --

    Name of the registry. Used only for lookup. One of RegistryArn or RegistryName has to be provided.

  • RegistryArn (string) --

    Arn of the registry to be updated. One of RegistryArn or RegistryName has to be provided.

Return type
dict
Returns
Response Syntax
{
    'RegistryName': 'string',
    'RegistryArn': 'string',
    'Status': 'AVAILABLE'|'DELETING'
}

Response Structure

  • (dict) --
    • RegistryName (string) --

      The name of the registry being deleted.

    • RegistryArn (string) --

      The Amazon Resource Name (ARN) of the registry being deleted.

    • Status (string) --

      The status of the registry. A successful operation will return the Deleting status.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.AccessDeniedException
  • Glue.Client.exceptions.ConcurrentModificationException
delete_resource_policy(**kwargs)

Deletes a specified policy.

See also: AWS API Documentation

Request Syntax

response = client.delete_resource_policy(
    PolicyHashCondition='string',
    ResourceArn='string'
)
Parameters
  • PolicyHashCondition (string) -- The hash value returned when this policy was set.
  • ResourceArn (string) -- The ARN of the Glue resource for the resource policy to be deleted.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.ConditionCheckFailureException
delete_schema(**kwargs)

Deletes the entire schema set, including the schema set and all of its versions. To get the status of the delete operation, you can call GetSchema API after the asynchronous call. Deleting a registry will deactivate all online operations for the schema, such as the GetSchemaByDefinition , and RegisterSchemaVersion APIs.

See also: AWS API Documentation

Request Syntax

response = client.delete_schema(
    SchemaId={
        'SchemaArn': 'string',
        'SchemaName': 'string',
        'RegistryName': 'string'
    }
)
Parameters
SchemaId (dict) --

[REQUIRED]

This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).

  • SchemaArn (string) --

    The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.

  • SchemaName (string) --

    The name of the schema. One of SchemaArn or SchemaName has to be provided.

  • RegistryName (string) --

    The name of the schema registry that contains the schema.

Return type
dict
Returns
Response Syntax
{
    'SchemaArn': 'string',
    'SchemaName': 'string',
    'Status': 'AVAILABLE'|'PENDING'|'DELETING'
}

Response Structure

  • (dict) --
    • SchemaArn (string) --

      The Amazon Resource Name (ARN) of the schema being deleted.

    • SchemaName (string) --

      The name of the schema being deleted.

    • Status (string) --

      The status of the schema.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.AccessDeniedException
  • Glue.Client.exceptions.ConcurrentModificationException
delete_schema_versions(**kwargs)

Remove versions from the specified schema. A version number or range may be supplied. If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned. Calling the GetSchemaVersions API after this call will list the status of the deleted versions.

When the range of version numbers contain check pointed version, the API will return a 409 conflict and will not proceed with the deletion. You have to remove the checkpoint first using the DeleteSchemaCheckpoint API before using this API.

You cannot use the DeleteSchemaVersions API to delete the first schema version in the schema set. The first schema version can only be deleted by the DeleteSchema API. This operation will also delete the attached SchemaVersionMetadata under the schema versions. Hard deletes will be enforced on the database.

If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned.

See also: AWS API Documentation

Request Syntax

response = client.delete_schema_versions(
    SchemaId={
        'SchemaArn': 'string',
        'SchemaName': 'string',
        'RegistryName': 'string'
    },
    Versions='string'
)
Parameters
  • SchemaId (dict) --

    [REQUIRED]

    This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).

    • SchemaArn (string) --

      The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.

    • SchemaName (string) --

      The name of the schema. One of SchemaArn or SchemaName has to be provided.

    • RegistryName (string) --

      The name of the schema registry that contains the schema.

  • Versions (string) --

    [REQUIRED]

    A version range may be supplied which may be of the format:

    • a single version number, 5
    • a range, 5-8 : deletes versions 5, 6, 7, 8
Return type

dict

Returns

Response Syntax

{
    'SchemaVersionErrors': [
        {
            'VersionNumber': 123,
            'ErrorDetails': {
                'ErrorCode': 'string',
                'ErrorMessage': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • SchemaVersionErrors (list) --

      A list of SchemaVersionErrorItem objects, each containing an error and schema version.

      • (dict) --

        An object that contains the error details for an operation on a schema version.

        • VersionNumber (integer) --

          The version number of the schema.

        • ErrorDetails (dict) --

          The details of the error for the schema version.

          • ErrorCode (string) --

            The error code for an error.

          • ErrorMessage (string) --

            The error message for an error.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.AccessDeniedException
  • Glue.Client.exceptions.ConcurrentModificationException
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) --

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
delete_session(**kwargs)

Deletes the session.

See also: AWS API Documentation

Request Syntax

response = client.delete_session(
    Id='string',
    RequestOrigin='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of the session to be deleted.

  • RequestOrigin (string) -- The name of the origin of the delete session request.
Return type

dict

Returns

Response Syntax

{
    'Id': 'string'
}

Response Structure

  • (dict) --

    • Id (string) --

      Returns the ID of the deleted session.

Exceptions

  • Glue.Client.exceptions.AccessDeniedException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.IllegalSessionStateException
  • Glue.Client.exceptions.ConcurrentModificationException
delete_table(**kwargs)

Removes a table definition from the Data Catalog.

Note

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

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

See also: AWS API Documentation

Request Syntax

response = client.delete_table(
    CatalogId='string',
    DatabaseName='string',
    Name='string',
    TransactionId='string'
)
Parameters
  • CatalogId (string) -- The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services 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.

  • TransactionId (string) -- The transaction ID at which to delete the table contents.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.ConcurrentModificationException
  • Glue.Client.exceptions.ResourceNotReadyException
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 provided, the Amazon Web Services 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) --

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
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.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.ConcurrentModificationException
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 Amazon Web Services 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) --

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
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.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.ConcurrentModificationException
get_blueprint(**kwargs)

Retrieves the details of a blueprint.

See also: AWS API Documentation

Request Syntax

response = client.get_blueprint(
    Name='string',
    IncludeBlueprint=True|False,
    IncludeParameterSpec=True|False
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the blueprint.

  • IncludeBlueprint (boolean) -- Specifies whether or not to include the blueprint in the response.
  • IncludeParameterSpec (boolean) -- Specifies whether or not to include the parameter specification.
Return type

dict

Returns

Response Syntax

{
    'Blueprint': {
        'Name': 'string',
        'Description': 'string',
        'CreatedOn': datetime(2015, 1, 1),
        'LastModifiedOn': datetime(2015, 1, 1),
        'ParameterSpec': 'string',
        'BlueprintLocation': 'string',
        'BlueprintServiceLocation': 'string',
        'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'FAILED',
        'ErrorMessage': 'string',
        'LastActiveDefinition': {
            'Description': 'string'