Skip to content

CreateProfileJobRequest

Source code in docs_src/capo_databrew/types/create_profile_job_request.py
class CreateProfileJobRequest(TypedDict, closed=True):
    dataset_name: "capo_databrew.types.dataset_name.DatasetName"
    """<p>The name of the dataset that this job is to act 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> - <code>SSE-KMS</code> - Server-side encryption with KMS-managed keys.</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 to be created. 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 use 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>"""
    output_location: "capo_databrew.types.s3_location.S3Location"
    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>"""
    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>"""
    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. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.</p>"""

configuration instance-attribute

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.

dataset_name instance-attribute

dataset_name: DatasetName

The name of the dataset that this job is to act 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 - SSE-KMS - Server-side encryption with KMS-managed keys.

  • 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. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

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 use 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 to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

output_location instance-attribute

output_location: S3Location

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.

validation_configurations instance-attribute

validation_configurations: NotRequired[ValidationConfigurationList]

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