Skip to content

DescribeJobResponse

Source code in docs_src/capo_databrew/types/describe_job_response.py
class DescribeJobResponse(TypedDict, closed=True):
    create_date: NotRequired["capo_databrew.types.date.Date"]
    """<p>The date and time that the job was created.</p>"""
    created_by: NotRequired["capo_databrew.types.created_by.CreatedBy"]
    """<p>The identifier (user name) of the user associated with the creation of the job.</p>"""
    dataset_name: NotRequired["capo_databrew.types.dataset_name.DatasetName"]
    """<p>The dataset that the job acts upon.</p>"""
    encryption_key_arn: NotRequired[
        "capo_databrew.types.encryption_key_arn.EncryptionKeyArn"
    ]
    """<p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.</p>"""
    encryption_mode: NotRequired["capo_databrew.types.encryption_mode.EncryptionMode"]
    """<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - Server-side encryption with keys managed by KMS.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"""
    name: "capo_databrew.types.job_name.JobName"
    """<p>The name of the job.</p>"""
    type: NotRequired["capo_databrew.types.job_type.JobType"]
    """<p>The job type, which must be one of the following:</p> <ul> <li> <p> <code>PROFILE</code> - The job analyzes the dataset to determine its size, data types, data distribution, and more.</p> </li> <li> <p> <code>RECIPE</code> - The job applies one or more transformations to a dataset.</p> </li> </ul>"""
    last_modified_by: NotRequired["capo_databrew.types.last_modified_by.LastModifiedBy"]
    """<p>The identifier (user name) of the user who last modified the job.</p>"""
    last_modified_date: NotRequired["capo_databrew.types.date.Date"]
    """<p>The date and time that the job was last modified.</p>"""
    log_subscription: NotRequired[
        "capo_databrew.types.log_subscription.LogSubscription"
    ]
    """<p>Indicates whether Amazon CloudWatch logging is enabled for this job.</p>"""
    max_capacity: "capo_databrew.types.max_capacity.MaxCapacity"
    """<p>The maximum number of compute nodes that DataBrew can consume when the job processes data.</p>"""
    max_retries: "capo_databrew.types.max_retries.MaxRetries"
    """<p>The maximum number of times to retry the job after a job run fails.</p>"""
    outputs: NotRequired["capo_databrew.types.output_list.OutputList"]
    """<p>One or more artifacts that represent the output from running the job.</p>"""
    data_catalog_outputs: NotRequired[
        "capo_databrew.types.data_catalog_output_list.DataCatalogOutputList"
    ]
    """<p>One or more artifacts that represent the Glue Data Catalog output from running the job.</p>"""
    database_outputs: NotRequired[
        "capo_databrew.types.database_output_list.DatabaseOutputList"
    ]
    """<p>Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.</p>"""
    project_name: NotRequired["capo_databrew.types.project_name.ProjectName"]
    """<p>The DataBrew project associated with this job.</p>"""
    profile_configuration: NotRequired[
        "capo_databrew.types.profile_configuration.ProfileConfiguration"
    ]
    """<p>Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.</p>"""
    validation_configurations: NotRequired[
        "capo_databrew.types.validation_configuration_list.ValidationConfigurationList"
    ]
    """<p>List of validation configurations that are applied to the profile job.</p>"""
    recipe_reference: NotRequired[
        "capo_databrew.types.recipe_reference.RecipeReference"
    ]
    resource_arn: NotRequired["capo_databrew.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the job.</p>"""
    role_arn: NotRequired["capo_databrew.types.arn.Arn"]
    """<p>The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.</p>"""
    tags: NotRequired["capo_databrew.types.tag_map.TagMap"]
    """<p>Metadata tags associated with this job.</p>"""
    timeout: "capo_databrew.types.timeout.Timeout"
    """<p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>"""
    job_sample: NotRequired["capo_databrew.types.job_sample.JobSample"]
    """<p>Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.</p>"""

create_date instance-attribute

create_date: NotRequired[Date]

The date and time that the job was created.

created_by instance-attribute

created_by: NotRequired[CreatedBy]

The identifier (user name) of the user associated with the creation of the job.

data_catalog_outputs instance-attribute

data_catalog_outputs: NotRequired[DataCatalogOutputList]

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

database_outputs instance-attribute

database_outputs: NotRequired[DatabaseOutputList]

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

dataset_name instance-attribute

dataset_name: NotRequired[DatasetName]

The dataset that the job acts upon.

encryption_key_arn instance-attribute

encryption_key_arn: NotRequired[EncryptionKeyArn]

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

encryption_mode instance-attribute

encryption_mode: NotRequired[EncryptionMode]

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.

job_sample instance-attribute

job_sample: NotRequired[JobSample]

Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.

last_modified_by instance-attribute

last_modified_by: NotRequired[LastModifiedBy]

The identifier (user name) of the user who last modified the job.

last_modified_date instance-attribute

last_modified_date: NotRequired[Date]

The date and time that the job was last modified.

log_subscription instance-attribute

log_subscription: NotRequired[LogSubscription]

Indicates whether Amazon CloudWatch logging is enabled for this job.

max_capacity instance-attribute

max_capacity: MaxCapacity

The maximum number of compute nodes that DataBrew can consume when the job processes data.

max_retries instance-attribute

max_retries: MaxRetries

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

name instance-attribute

name: JobName

The name of the job.

outputs instance-attribute

outputs: NotRequired[OutputList]

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

profile_configuration instance-attribute

profile_configuration: NotRequired[ProfileConfiguration]

Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

project_name instance-attribute

project_name: NotRequired[ProjectName]

The DataBrew project associated with this job.

recipe_reference instance-attribute

recipe_reference: NotRequired[RecipeReference]

resource_arn instance-attribute

resource_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the job.

role_arn instance-attribute

role_arn: NotRequired[Arn]

The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

tags instance-attribute

tags: NotRequired[TagMap]

Metadata tags associated with this job.

timeout instance-attribute

timeout: Timeout

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

type instance-attribute

type: NotRequired[JobType]

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

  • PROFILE - The job analyzes the dataset to determine its size, data types, data distribution, and more.

  • RECIPE - The job applies one or more transformations to a dataset.

validation_configurations instance-attribute

validation_configurations: NotRequired[ValidationConfigurationList]

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