Skip to content

CreateRecipeJobRequest

Source code in docs_src/capo_databrew/types/create_recipe_job_request.py
class CreateRecipeJobRequest(TypedDict, closed=True):
    dataset_name: NotRequired["capo_databrew.types.dataset_name.DatasetName"]
    """<p>The name of the dataset that this job processes.</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>A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>"""
    log_subscription: NotRequired[
        "capo_databrew.types.log_subscription.LogSubscription"
    ]
    """<p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>"""
    max_capacity: "capo_databrew.types.max_capacity.MaxCapacity"
    """<p>The maximum number of 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 to. </p>"""
    project_name: NotRequired["capo_databrew.types.project_name.ProjectName"]
    """<p>Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.</p>"""
    recipe_reference: NotRequired[
        "capo_databrew.types.recipe_reference.RecipeReference"
    ]
    role_arn: "capo_databrew.types.arn.Arn"
    """<p>The Amazon Resource Name (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 to apply to 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>"""

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

dataset_name instance-attribute

dataset_name: NotRequired[DatasetName]

The name of the dataset that this job processes.

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.

log_subscription instance-attribute

log_subscription: NotRequired[LogSubscription]

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

max_capacity instance-attribute

max_capacity: MaxCapacity

The maximum number of 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

A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

outputs instance-attribute

outputs: NotRequired[OutputList]

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

project_name instance-attribute

project_name: NotRequired[ProjectName]

Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.

recipe_reference instance-attribute

recipe_reference: NotRequired[RecipeReference]

role_arn instance-attribute

role_arn: Arn

The Amazon Resource Name (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 to apply to 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.