GlueDataBrew / Client / list_jobs

list_jobs

GlueDataBrew.Client.list_jobs(**kwargs)

Lists all of the DataBrew jobs that are defined.

See also: AWS API Documentation

Request Syntax

response = client.list_jobs(
    DatasetName='string',
    MaxResults=123,
    NextToken='string',
    ProjectName='string'
)

Parameters:

• DatasetName (string) – The name of a dataset. Using this parameter indicates to return only those jobs that act on the specified dataset.

• MaxResults (integer) – The maximum number of results to return in this request.

• NextToken (string) – A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.

• ProjectName (string) – The name of a project. Using this parameter indicates to return only those jobs that are associated with the specified project.

Return type:

dict

Returns:

Response Syntax

{
    'Jobs': [
        {
            'AccountId': 'string',
            'CreatedBy': 'string',
            'CreateDate': datetime(2015, 1, 1),
            'DatasetName': 'string',
            'EncryptionKeyArn': 'string',
            'EncryptionMode': 'SSE-KMS'|'SSE-S3',
            'Name': 'string',
            'Type': 'PROFILE'|'RECIPE',
            'LastModifiedBy': 'string',
            'LastModifiedDate': datetime(2015, 1, 1),
            'LogSubscription': 'ENABLE'|'DISABLE',
            'MaxCapacity': 123,
            'MaxRetries': 123,
            'Outputs': [
                {
                    'CompressionFormat': 'GZIP'|'LZ4'|'SNAPPY'|'BZIP2'|'DEFLATE'|'LZO'|'BROTLI'|'ZSTD'|'ZLIB',
                    'Format': 'CSV'|'JSON'|'PARQUET'|'GLUEPARQUET'|'AVRO'|'ORC'|'XML'|'TABLEAUHYPER',
                    'PartitionColumns': [
                        'string',
                    ],
                    'Location': {
                        'Bucket': 'string',
                        'Key': 'string',
                        'BucketOwner': 'string'
                    },
                    'Overwrite': True|False,
                    'FormatOptions': {
                        'Csv': {
                            'Delimiter': 'string'
                        }
                    },
                    'MaxOutputFiles': 123
                },
            ],
            'DataCatalogOutputs': [
                {
                    'CatalogId': 'string',
                    'DatabaseName': 'string',
                    'TableName': 'string',
                    'S3Options': {
                        'Location': {
                            'Bucket': 'string',
                            'Key': 'string',
                            'BucketOwner': 'string'
                        }
                    },
                    'DatabaseOptions': {
                        'TempDirectory': {
                            'Bucket': 'string',
                            'Key': 'string',
                            'BucketOwner': 'string'
                        },
                        'TableName': 'string'
                    },
                    'Overwrite': True|False
                },
            ],
            'DatabaseOutputs': [
                {
                    'GlueConnectionName': 'string',
                    'DatabaseOptions': {
                        'TempDirectory': {
                            'Bucket': 'string',
                            'Key': 'string',
                            'BucketOwner': 'string'
                        },
                        'TableName': 'string'
                    },
                    'DatabaseOutputMode': 'NEW_TABLE'
                },
            ],
            'ProjectName': 'string',
            'RecipeReference': {
                'Name': 'string',
                'RecipeVersion': 'string'
            },
            'ResourceArn': 'string',
            'RoleArn': 'string',
            'Timeout': 123,
            'Tags': {
                'string': 'string'
            },
            'JobSample': {
                'Mode': 'FULL_DATASET'|'CUSTOM_ROWS',
                'Size': 123
            },
            'ValidationConfigurations': [
                {
                    'RulesetArn': 'string',
                    'ValidationMode': 'CHECK_ALL'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Jobs (list) –

    A list of jobs that are defined.

    • (dict) –

      Represents all of the attributes of a DataBrew job.

      • AccountId (string) –

        The ID of the Amazon Web Services account that owns the job.

      • CreatedBy (string) –

        The Amazon Resource Name (ARN) of the user who created the job.

      • CreateDate (datetime) –

        The date and time that the job was created.

      • DatasetName (string) –

        A dataset that the job is to process.

      • EncryptionKeyArn (string) –

        The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see Encrypting data written by DataBrew jobs

      • EncryptionMode (string) –

        The encryption mode for the job, which can be one of the following:

        • SSE-KMS - Server-side encryption with keys managed by KMS.

        • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

      • Name (string) –

        The unique name of the job.

      • Type (string) –

        The job type of the job, which must be one of the following:

        • PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.

        • RECIPE - A job to apply one or more transformations to a dataset.

      • LastModifiedBy (string) –

        The Amazon Resource Name (ARN) of the user who last modified the job.

      • LastModifiedDate (datetime) –

        The modification date and time of the job.

      • LogSubscription (string) –

        The current status of Amazon CloudWatch logging for the job.

      • MaxCapacity (integer) –

        The maximum number of nodes that can be consumed when the job processes data.

      • MaxRetries (integer) –

        The maximum number of times to retry the job after a job run fails.

      • Outputs (list) –

        One or more artifacts that represent output from running the job.

        • (dict) –

          Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by recipe jobs or profile jobs.

          • CompressionFormat (string) –

            The compression algorithm used to compress the output text of the job.

          • Format (string) –

            The data format of the output of the job.

          • PartitionColumns (list) –

            The names of one or more partition columns for the output of the job.

            • (string) –

          • Location (dict) –

            The location in Amazon S3 where the job writes its output.

            • Bucket (string) –

              The Amazon S3 bucket name.

            • Key (string) –

              The unique name of the object in the bucket.

            • BucketOwner (string) –

              The Amazon Web Services account ID of the bucket owner.

          • Overwrite (boolean) –

            A value that, if true, means that any data in the location specified for output is overwritten with new output.

          • FormatOptions (dict) –

            Represents options that define how DataBrew formats job output files.

            • Csv (dict) –

              Represents a set of options that define the structure of comma-separated value (CSV) job output.

              • Delimiter (string) –

                A single character that specifies the delimiter used to create CSV job output.

          • MaxOutputFiles (integer) –

            Maximum number of files to be generated by the job and written to the output folder. For output partitioned by column(s), the MaxOutputFiles value is the maximum number of files per partition.

      • DataCatalogOutputs (list) –

        One or more artifacts that represent the Glue Data Catalog output from running the job.

        • (dict) –

          Represents options that specify how and where in the Glue Data Catalog DataBrew writes the output generated by recipe jobs.

          • CatalogId (string) –

            The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.

          • DatabaseName (string) –

            The name of a database in the Data Catalog.

          • TableName (string) –

            The name of a table in the Data Catalog.

          • S3Options (dict) –

            Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.

            • Location (dict) –

              Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job.

              • Bucket (string) –

                The Amazon S3 bucket name.

              • Key (string) –

                The unique name of the object in the bucket.

              • BucketOwner (string) –

                The Amazon Web Services account ID of the bucket owner.

          • DatabaseOptions (dict) –

            Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.

            • TempDirectory (dict) –

              Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.

              • Bucket (string) –

                The Amazon S3 bucket name.

              • Key (string) –

                The unique name of the object in the bucket.

              • BucketOwner (string) –

                The Amazon Web Services account ID of the bucket owner.

            • TableName (string) –

              A prefix for the name of a table DataBrew will create in the database.

          • Overwrite (boolean) –

            A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions.

      • DatabaseOutputs (list) –

        Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

        • (dict) –

          Represents a JDBC database output object which defines the output destination for a DataBrew recipe job to write into.

          • GlueConnectionName (string) –

            The Glue connection that stores the connection information for the target database.

          • DatabaseOptions (dict) –

            Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.

            • TempDirectory (dict) –

              Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.

              • Bucket (string) –

                The Amazon S3 bucket name.

              • Key (string) –

                The unique name of the object in the bucket.

              • BucketOwner (string) –

                The Amazon Web Services account ID of the bucket owner.

            • TableName (string) –

              A prefix for the name of a table DataBrew will create in the database.

          • DatabaseOutputMode (string) –

            The output mode to write into the database. Currently supported option: NEW_TABLE.

      • ProjectName (string) –

        The name of the project that the job is associated with.

      • RecipeReference (dict) –

        A set of steps that the job runs.

        • Name (string) –

          The name of the recipe.

        • RecipeVersion (string) –

          The identifier for the version for the recipe.

      • ResourceArn (string) –

        The unique Amazon Resource Name (ARN) for the job.

      • RoleArn (string) –

        The Amazon Resource Name (ARN) of the role to be assumed for this job.

      • Timeout (integer) –

        The job’s timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

      • Tags (dict) –

        Metadata tags that have been applied to the job.

        • (string) –

          • (string) –

      • JobSample (dict) –

        A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn’t provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.

        • Mode (string) –

          A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following:

          • FULL_DATASET - The profile job is run on the entire dataset.

          • CUSTOM_ROWS - The profile job is run on the number of rows specified in the Size parameter.

        • Size (integer) –

          The Size parameter is only required when the mode is CUSTOM_ROWS. The profile job is run on the specified number of rows. The maximum value for size is Long.MAX_VALUE.

          Long.MAX_VALUE = 9223372036854775807

      • ValidationConfigurations (list) –

        List of validation configurations that are applied to the profile job.

        • (dict) –

          Configuration for data quality validation. Used to select the Rulesets and Validation Mode to be used in the profile job. When ValidationConfiguration is null, the profile job will run without data quality validation.

          • RulesetArn (string) –

            The Amazon Resource Name (ARN) for the ruleset to be validated in the profile job. The TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of the dataset that is associated with the profile job.

          • ValidationMode (string) –

            Mode of data quality validation. Default mode is “CHECK_ALL” which verifies all rules defined in the selected ruleset.

  • NextToken (string) –

    A token that you can use in a subsequent call to retrieve the next set of results.

Exceptions

• GlueDataBrew.Client.exceptions.ValidationException