Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. databrew
  5. getJob

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.databrew.getJob

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource schema for AWS::DataBrew::Job.

Using getJob

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getJob(args: GetJobArgs, opts?: InvokeOptions): Promise<GetJobResult>
function getJobOutput(args: GetJobOutputArgs, opts?: InvokeOptions): Output<GetJobResult>
Copy
def get_job(name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetJobResult
def get_job_output(name: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetJobResult]
Copy
func LookupJob(ctx *Context, args *LookupJobArgs, opts ...InvokeOption) (*LookupJobResult, error)
func LookupJobOutput(ctx *Context, args *LookupJobOutputArgs, opts ...InvokeOption) LookupJobResultOutput
Copy

> Note: This function is named LookupJob in the Go SDK.

public static class GetJob 
{
    public static Task<GetJobResult> InvokeAsync(GetJobArgs args, InvokeOptions? opts = null)
    public static Output<GetJobResult> Invoke(GetJobInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
public static Output<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:databrew:getJob
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Job name
Name This property is required. string
Job name
name This property is required. String
Job name
name This property is required. string
Job name
name This property is required. str
Job name
name This property is required. String
Job name

getJob Result

The following output properties are available:

DataCatalogOutputs List<Pulumi.AwsNative.DataBrew.Outputs.JobDataCatalogOutput>
One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
DatabaseOutputs List<Pulumi.AwsNative.DataBrew.Outputs.JobDatabaseOutput>
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
DatasetName string
Dataset name
EncryptionKeyArn string
Encryption Key Arn
EncryptionMode Pulumi.AwsNative.DataBrew.JobEncryptionMode
Encryption mode
JobSample Pulumi.AwsNative.DataBrew.Outputs.JobSample
Job Sample
LogSubscription Pulumi.AwsNative.DataBrew.JobLogSubscription
Log subscription
MaxCapacity int
Max capacity
MaxRetries int
Max retries
OutputLocation Pulumi.AwsNative.DataBrew.Outputs.JobOutputLocation
Output location
Outputs List<Pulumi.AwsNative.DataBrew.Outputs.JobOutput>
One or more artifacts that represent output from running the job.
ProfileConfiguration Pulumi.AwsNative.DataBrew.Outputs.JobProfileConfiguration
Profile Job configuration
ProjectName string
Project name
Recipe Pulumi.AwsNative.DataBrew.Outputs.JobRecipe
A series of data transformation steps that the job runs.
RoleArn string
Role arn
Tags List<Pulumi.AwsNative.Outputs.Tag>
Metadata tags that have been applied to the job.
Timeout int
Timeout
ValidationConfigurations List<Pulumi.AwsNative.DataBrew.Outputs.JobValidationConfiguration>
Data quality rules configuration
DataCatalogOutputs []JobDataCatalogOutput
One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
DatabaseOutputs []JobDatabaseOutput
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
DatasetName string
Dataset name
EncryptionKeyArn string
Encryption Key Arn
EncryptionMode JobEncryptionMode
Encryption mode
JobSample JobSample
Job Sample
LogSubscription JobLogSubscription
Log subscription
MaxCapacity int
Max capacity
MaxRetries int
Max retries
OutputLocation JobOutputLocation
Output location
Outputs []JobOutputType
One or more artifacts that represent output from running the job.
ProfileConfiguration JobProfileConfiguration
Profile Job configuration
ProjectName string
Project name
Recipe JobRecipe
A series of data transformation steps that the job runs.
RoleArn string
Role arn
Tags Tag
Metadata tags that have been applied to the job.
Timeout int
Timeout
ValidationConfigurations []JobValidationConfiguration
Data quality rules configuration
dataCatalogOutputs List<JobDataCatalogOutput>
One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
databaseOutputs List<JobDatabaseOutput>
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
datasetName String
Dataset name
encryptionKeyArn String
Encryption Key Arn
encryptionMode JobEncryptionMode
Encryption mode
jobSample JobSample
Job Sample
logSubscription JobLogSubscription
Log subscription
maxCapacity Integer
Max capacity
maxRetries Integer
Max retries
outputLocation JobOutputLocation
Output location
outputs List<JobOutput>
One or more artifacts that represent output from running the job.
profileConfiguration JobProfileConfiguration
Profile Job configuration
projectName String
Project name
recipe JobRecipe
A series of data transformation steps that the job runs.
roleArn String
Role arn
tags List<Tag>
Metadata tags that have been applied to the job.
timeout Integer
Timeout
validationConfigurations List<JobValidationConfiguration>
Data quality rules configuration
dataCatalogOutputs JobDataCatalogOutput[]
One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
databaseOutputs JobDatabaseOutput[]
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
datasetName string
Dataset name
encryptionKeyArn string
Encryption Key Arn
encryptionMode JobEncryptionMode
Encryption mode
jobSample JobSample
Job Sample
logSubscription JobLogSubscription
Log subscription
maxCapacity number
Max capacity
maxRetries number
Max retries
outputLocation JobOutputLocation
Output location
outputs JobOutput[]
One or more artifacts that represent output from running the job.
profileConfiguration JobProfileConfiguration
Profile Job configuration
projectName string
Project name
recipe JobRecipe
A series of data transformation steps that the job runs.
roleArn string
Role arn
tags Tag[]
Metadata tags that have been applied to the job.
timeout number
Timeout
validationConfigurations JobValidationConfiguration[]
Data quality rules configuration
data_catalog_outputs Sequence[JobDataCatalogOutput]
One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
database_outputs Sequence[JobDatabaseOutput]
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
dataset_name str
Dataset name
encryption_key_arn str
Encryption Key Arn
encryption_mode JobEncryptionMode
Encryption mode
job_sample JobSample
Job Sample
log_subscription JobLogSubscription
Log subscription
max_capacity int
Max capacity
max_retries int
Max retries
output_location JobOutputLocation
Output location
outputs Sequence[JobOutput]
One or more artifacts that represent output from running the job.
profile_configuration JobProfileConfiguration
Profile Job configuration
project_name str
Project name
recipe JobRecipe
A series of data transformation steps that the job runs.
role_arn str
Role arn
tags Sequence[root_Tag]
Metadata tags that have been applied to the job.
timeout int
Timeout
validation_configurations Sequence[JobValidationConfiguration]
Data quality rules configuration
dataCatalogOutputs List<Property Map>
One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
databaseOutputs List<Property Map>
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
datasetName String
Dataset name
encryptionKeyArn String
Encryption Key Arn
encryptionMode "SSE-KMS" | "SSE-S3"
Encryption mode
jobSample Property Map
Job Sample
logSubscription "ENABLE" | "DISABLE"
Log subscription
maxCapacity Number
Max capacity
maxRetries Number
Max retries
outputLocation Property Map
Output location
outputs List<Property Map>
One or more artifacts that represent output from running the job.
profileConfiguration Property Map
Profile Job configuration
projectName String
Project name
recipe Property Map
A series of data transformation steps that the job runs.
roleArn String
Role arn
tags List<Property Map>
Metadata tags that have been applied to the job.
timeout Number
Timeout
validationConfigurations List<Property Map>
Data quality rules configuration

Supporting Types

JobAllowedStatistics

Statistics This property is required. List<string>
One or more column statistics to allow for columns that contain detected entities.
Statistics This property is required. []string
One or more column statistics to allow for columns that contain detected entities.
statistics This property is required. List<String>
One or more column statistics to allow for columns that contain detected entities.
statistics This property is required. string[]
One or more column statistics to allow for columns that contain detected entities.
statistics This property is required. Sequence[str]
One or more column statistics to allow for columns that contain detected entities.
statistics This property is required. List<String>
One or more column statistics to allow for columns that contain detected entities.

JobColumnSelector

Name string
The name of a column from a dataset.
Regex string
A regular expression for selecting a column from a dataset.
Name string
The name of a column from a dataset.
Regex string
A regular expression for selecting a column from a dataset.
name String
The name of a column from a dataset.
regex String
A regular expression for selecting a column from a dataset.
name string
The name of a column from a dataset.
regex string
A regular expression for selecting a column from a dataset.
name str
The name of a column from a dataset.
regex str
A regular expression for selecting a column from a dataset.
name String
The name of a column from a dataset.
regex String
A regular expression for selecting a column from a dataset.

JobColumnStatisticsConfiguration

Statistics This property is required. Pulumi.AwsNative.DataBrew.Inputs.JobStatisticsConfiguration
Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations.
Selectors List<Pulumi.AwsNative.DataBrew.Inputs.JobColumnSelector>
List of column selectors. Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns.
Statistics This property is required. JobStatisticsConfiguration
Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations.
Selectors []JobColumnSelector
List of column selectors. Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns.
statistics This property is required. JobStatisticsConfiguration
Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations.
selectors List<JobColumnSelector>
List of column selectors. Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns.
statistics This property is required. JobStatisticsConfiguration
Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations.
selectors JobColumnSelector[]
List of column selectors. Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns.
statistics This property is required. JobStatisticsConfiguration
Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations.
selectors Sequence[JobColumnSelector]
List of column selectors. Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns.
statistics This property is required. Property Map
Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations.
selectors List<Property Map>
List of column selectors. Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns.

JobCsvOutputOptions

Delimiter string
A single character that specifies the delimiter used to create CSV job output.
Delimiter string
A single character that specifies the delimiter used to create CSV job output.
delimiter String
A single character that specifies the delimiter used to create CSV job output.
delimiter string
A single character that specifies the delimiter used to create CSV job output.
delimiter str
A single character that specifies the delimiter used to create CSV job output.
delimiter String
A single character that specifies the delimiter used to create CSV job output.

JobDataCatalogOutput

DatabaseName This property is required. string
The name of a database in the Data Catalog.
TableName This property is required. string
The name of a table in the Data Catalog.
CatalogId string
The unique identifier of the AWS account that holds the Data Catalog that stores the data.
DatabaseOptions Pulumi.AwsNative.DataBrew.Inputs.JobDatabaseTableOutputOptions
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
Overwrite bool
A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions.
S3Options Pulumi.AwsNative.DataBrew.Inputs.JobS3TableOutputOptions
Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.
DatabaseName This property is required. string
The name of a database in the Data Catalog.
TableName This property is required. string
The name of a table in the Data Catalog.
CatalogId string
The unique identifier of the AWS account that holds the Data Catalog that stores the data.
DatabaseOptions JobDatabaseTableOutputOptions
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
Overwrite bool
A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions.
S3Options JobS3TableOutputOptions
Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.
databaseName This property is required. String
The name of a database in the Data Catalog.
tableName This property is required. String
The name of a table in the Data Catalog.
catalogId String
The unique identifier of the AWS account that holds the Data Catalog that stores the data.
databaseOptions JobDatabaseTableOutputOptions
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
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.
s3Options JobS3TableOutputOptions
Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.
databaseName This property is required. string
The name of a database in the Data Catalog.
tableName This property is required. string
The name of a table in the Data Catalog.
catalogId string
The unique identifier of the AWS account that holds the Data Catalog that stores the data.
databaseOptions JobDatabaseTableOutputOptions
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
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.
s3Options JobS3TableOutputOptions
Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.
database_name This property is required. str
The name of a database in the Data Catalog.
table_name This property is required. str
The name of a table in the Data Catalog.
catalog_id str
The unique identifier of the AWS account that holds the Data Catalog that stores the data.
database_options JobDatabaseTableOutputOptions
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
overwrite bool
A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions.
s3_options JobS3TableOutputOptions
Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.
databaseName This property is required. String
The name of a database in the Data Catalog.
tableName This property is required. String
The name of a table in the Data Catalog.
catalogId String
The unique identifier of the AWS account that holds the Data Catalog that stores the data.
databaseOptions Property Map
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
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.
s3Options Property Map
Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.

JobDatabaseOutput

DatabaseOptions This property is required. Pulumi.AwsNative.DataBrew.Inputs.JobDatabaseTableOutputOptions
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
GlueConnectionName This property is required. string
Glue connection name
DatabaseOutputMode Pulumi.AwsNative.DataBrew.JobDatabaseOutputDatabaseOutputMode
Database table name
DatabaseOptions This property is required. JobDatabaseTableOutputOptions
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
GlueConnectionName This property is required. string
Glue connection name
DatabaseOutputMode JobDatabaseOutputDatabaseOutputMode
Database table name
databaseOptions This property is required. JobDatabaseTableOutputOptions
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
glueConnectionName This property is required. String
Glue connection name
databaseOutputMode JobDatabaseOutputDatabaseOutputMode
Database table name
databaseOptions This property is required. JobDatabaseTableOutputOptions
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
glueConnectionName This property is required. string
Glue connection name
databaseOutputMode JobDatabaseOutputDatabaseOutputMode
Database table name
database_options This property is required. JobDatabaseTableOutputOptions
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
glue_connection_name This property is required. str
Glue connection name
database_output_mode JobDatabaseOutputDatabaseOutputMode
Database table name
databaseOptions This property is required. Property Map
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
glueConnectionName This property is required. String
Glue connection name
databaseOutputMode "NEW_TABLE"
Database table name

JobDatabaseOutputDatabaseOutputMode

JobDatabaseTableOutputOptions

TableName This property is required. string
A prefix for the name of a table DataBrew will create in the database.
TempDirectory Pulumi.AwsNative.DataBrew.Inputs.JobS3Location
Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.
TableName This property is required. string
A prefix for the name of a table DataBrew will create in the database.
TempDirectory JobS3Location
Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.
tableName This property is required. String
A prefix for the name of a table DataBrew will create in the database.
tempDirectory JobS3Location
Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.
tableName This property is required. string
A prefix for the name of a table DataBrew will create in the database.
tempDirectory JobS3Location
Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.
table_name This property is required. str
A prefix for the name of a table DataBrew will create in the database.
temp_directory JobS3Location
Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.
tableName This property is required. String
A prefix for the name of a table DataBrew will create in the database.
tempDirectory Property Map
Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.

JobEncryptionMode

JobEntityDetectorConfiguration

EntityTypes This property is required. List<string>

Entity types to detect. Can be any of the following:

  • USA_SSN
  • EMAIL
  • USA_ITIN
  • USA_PASSPORT_NUMBER
  • PHONE_NUMBER
  • USA_DRIVING_LICENSE
  • BANK_ACCOUNT
  • CREDIT_CARD
  • IP_ADDRESS
  • MAC_ADDRESS
  • USA_DEA_NUMBER
  • USA_HCPCS_CODE
  • USA_NATIONAL_PROVIDER_IDENTIFIER
  • USA_NATIONAL_DRUG_CODE
  • USA_HEALTH_INSURANCE_CLAIM_NUMBER
  • USA_MEDICARE_BENEFICIARY_IDENTIFIER
  • USA_CPT_CODE
  • PERSON_NAME
  • DATE

The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

AllowedStatistics Pulumi.AwsNative.DataBrew.Inputs.JobAllowedStatistics
Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.
EntityTypes This property is required. []string

Entity types to detect. Can be any of the following:

  • USA_SSN
  • EMAIL
  • USA_ITIN
  • USA_PASSPORT_NUMBER
  • PHONE_NUMBER
  • USA_DRIVING_LICENSE
  • BANK_ACCOUNT
  • CREDIT_CARD
  • IP_ADDRESS
  • MAC_ADDRESS
  • USA_DEA_NUMBER
  • USA_HCPCS_CODE
  • USA_NATIONAL_PROVIDER_IDENTIFIER
  • USA_NATIONAL_DRUG_CODE
  • USA_HEALTH_INSURANCE_CLAIM_NUMBER
  • USA_MEDICARE_BENEFICIARY_IDENTIFIER
  • USA_CPT_CODE
  • PERSON_NAME
  • DATE

The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

AllowedStatistics JobAllowedStatistics
Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.
entityTypes This property is required. List<String>

Entity types to detect. Can be any of the following:

  • USA_SSN
  • EMAIL
  • USA_ITIN
  • USA_PASSPORT_NUMBER
  • PHONE_NUMBER
  • USA_DRIVING_LICENSE
  • BANK_ACCOUNT
  • CREDIT_CARD
  • IP_ADDRESS
  • MAC_ADDRESS
  • USA_DEA_NUMBER
  • USA_HCPCS_CODE
  • USA_NATIONAL_PROVIDER_IDENTIFIER
  • USA_NATIONAL_DRUG_CODE
  • USA_HEALTH_INSURANCE_CLAIM_NUMBER
  • USA_MEDICARE_BENEFICIARY_IDENTIFIER
  • USA_CPT_CODE
  • PERSON_NAME
  • DATE

The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

allowedStatistics JobAllowedStatistics
Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.
entityTypes This property is required. string[]

Entity types to detect. Can be any of the following:

  • USA_SSN
  • EMAIL
  • USA_ITIN
  • USA_PASSPORT_NUMBER
  • PHONE_NUMBER
  • USA_DRIVING_LICENSE
  • BANK_ACCOUNT
  • CREDIT_CARD
  • IP_ADDRESS
  • MAC_ADDRESS
  • USA_DEA_NUMBER
  • USA_HCPCS_CODE
  • USA_NATIONAL_PROVIDER_IDENTIFIER
  • USA_NATIONAL_DRUG_CODE
  • USA_HEALTH_INSURANCE_CLAIM_NUMBER
  • USA_MEDICARE_BENEFICIARY_IDENTIFIER
  • USA_CPT_CODE
  • PERSON_NAME
  • DATE

The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

allowedStatistics JobAllowedStatistics
Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.
entity_types This property is required. Sequence[str]

Entity types to detect. Can be any of the following:

  • USA_SSN
  • EMAIL
  • USA_ITIN
  • USA_PASSPORT_NUMBER
  • PHONE_NUMBER
  • USA_DRIVING_LICENSE
  • BANK_ACCOUNT
  • CREDIT_CARD
  • IP_ADDRESS
  • MAC_ADDRESS
  • USA_DEA_NUMBER
  • USA_HCPCS_CODE
  • USA_NATIONAL_PROVIDER_IDENTIFIER
  • USA_NATIONAL_DRUG_CODE
  • USA_HEALTH_INSURANCE_CLAIM_NUMBER
  • USA_MEDICARE_BENEFICIARY_IDENTIFIER
  • USA_CPT_CODE
  • PERSON_NAME
  • DATE

The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

allowed_statistics JobAllowedStatistics
Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.
entityTypes This property is required. List<String>

Entity types to detect. Can be any of the following:

  • USA_SSN
  • EMAIL
  • USA_ITIN
  • USA_PASSPORT_NUMBER
  • PHONE_NUMBER
  • USA_DRIVING_LICENSE
  • BANK_ACCOUNT
  • CREDIT_CARD
  • IP_ADDRESS
  • MAC_ADDRESS
  • USA_DEA_NUMBER
  • USA_HCPCS_CODE
  • USA_NATIONAL_PROVIDER_IDENTIFIER
  • USA_NATIONAL_DRUG_CODE
  • USA_HEALTH_INSURANCE_CLAIM_NUMBER
  • USA_MEDICARE_BENEFICIARY_IDENTIFIER
  • USA_CPT_CODE
  • PERSON_NAME
  • DATE

The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

allowedStatistics Property Map
Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.

JobLogSubscription

JobOutput

Location This property is required. Pulumi.AwsNative.DataBrew.Inputs.JobS3Location
The location in Amazon S3 where the job writes its output.
CompressionFormat Pulumi.AwsNative.DataBrew.JobOutputCompressionFormat
The compression algorithm used to compress the output text of the job.
Format Pulumi.AwsNative.DataBrew.JobOutputFormat
The data format of the output of the job.
FormatOptions Pulumi.AwsNative.DataBrew.Inputs.JobOutputFormatOptions
Represents options that define how DataBrew formats job output files.
MaxOutputFiles int
The maximum number of files to be generated by the job and written to the output folder.
Overwrite bool
A value that, if true, means that any data in the location specified for output is overwritten with new output.
PartitionColumns List<string>
The names of one or more partition columns for the output of the job.
Location This property is required. JobS3Location
The location in Amazon S3 where the job writes its output.
CompressionFormat JobOutputCompressionFormat
The compression algorithm used to compress the output text of the job.
Format JobOutputFormat
The data format of the output of the job.
FormatOptions JobOutputFormatOptions
Represents options that define how DataBrew formats job output files.
MaxOutputFiles int
The maximum number of files to be generated by the job and written to the output folder.
Overwrite bool
A value that, if true, means that any data in the location specified for output is overwritten with new output.
PartitionColumns []string
The names of one or more partition columns for the output of the job.
location This property is required. JobS3Location
The location in Amazon S3 where the job writes its output.
compressionFormat JobOutputCompressionFormat
The compression algorithm used to compress the output text of the job.
format JobOutputFormat
The data format of the output of the job.
formatOptions JobOutputFormatOptions
Represents options that define how DataBrew formats job output files.
maxOutputFiles Integer
The maximum number of files to be generated by the job and written to the output folder.
overwrite Boolean
A value that, if true, means that any data in the location specified for output is overwritten with new output.
partitionColumns List<String>
The names of one or more partition columns for the output of the job.
location This property is required. JobS3Location
The location in Amazon S3 where the job writes its output.
compressionFormat JobOutputCompressionFormat
The compression algorithm used to compress the output text of the job.
format JobOutputFormat
The data format of the output of the job.
formatOptions JobOutputFormatOptions
Represents options that define how DataBrew formats job output files.
maxOutputFiles number
The maximum number of files to be generated by the job and written to the output folder.
overwrite boolean
A value that, if true, means that any data in the location specified for output is overwritten with new output.
partitionColumns string[]
The names of one or more partition columns for the output of the job.
location This property is required. JobS3Location
The location in Amazon S3 where the job writes its output.
compression_format JobOutputCompressionFormat
The compression algorithm used to compress the output text of the job.
format JobOutputFormat
The data format of the output of the job.
format_options JobOutputFormatOptions
Represents options that define how DataBrew formats job output files.
max_output_files int
The maximum number of files to be generated by the job and written to the output folder.
overwrite bool
A value that, if true, means that any data in the location specified for output is overwritten with new output.
partition_columns Sequence[str]
The names of one or more partition columns for the output of the job.
location This property is required. Property Map
The location in Amazon S3 where the job writes its output.
compressionFormat "GZIP" | "LZ4" | "SNAPPY" | "BZIP2" | "DEFLATE" | "LZO" | "BROTLI" | "ZSTD" | "ZLIB"
The compression algorithm used to compress the output text of the job.
format "CSV" | "JSON" | "PARQUET" | "GLUEPARQUET" | "AVRO" | "ORC" | "XML" | "TABLEAUHYPER"
The data format of the output of the job.
formatOptions Property Map
Represents options that define how DataBrew formats job output files.
maxOutputFiles Number
The maximum number of files to be generated by the job and written to the output folder.
overwrite Boolean
A value that, if true, means that any data in the location specified for output is overwritten with new output.
partitionColumns List<String>
The names of one or more partition columns for the output of the job.

JobOutputCompressionFormat

JobOutputFormat

JobOutputFormatOptions

Csv Pulumi.AwsNative.DataBrew.Inputs.JobCsvOutputOptions
Represents a set of options that define the structure of comma-separated value (CSV) job output.
Csv JobCsvOutputOptions
Represents a set of options that define the structure of comma-separated value (CSV) job output.
csv JobCsvOutputOptions
Represents a set of options that define the structure of comma-separated value (CSV) job output.
csv JobCsvOutputOptions
Represents a set of options that define the structure of comma-separated value (CSV) job output.
csv JobCsvOutputOptions
Represents a set of options that define the structure of comma-separated value (CSV) job output.
csv Property Map
Represents a set of options that define the structure of comma-separated value (CSV) job output.

JobOutputLocation

Bucket This property is required. string
The Amazon S3 bucket name.
BucketOwner string
Key string
The unique name of the object in the bucket.
Bucket This property is required. string
The Amazon S3 bucket name.
BucketOwner string
Key string
The unique name of the object in the bucket.
bucket This property is required. String
The Amazon S3 bucket name.
bucketOwner String
key String
The unique name of the object in the bucket.
bucket This property is required. string
The Amazon S3 bucket name.
bucketOwner string
key string
The unique name of the object in the bucket.
bucket This property is required. str
The Amazon S3 bucket name.
bucket_owner str
key str
The unique name of the object in the bucket.
bucket This property is required. String
The Amazon S3 bucket name.
bucketOwner String
key String
The unique name of the object in the bucket.

JobProfileConfiguration

ColumnStatisticsConfigurations List<Pulumi.AwsNative.DataBrew.Inputs.JobColumnStatisticsConfiguration>
List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations.
DatasetStatisticsConfiguration Pulumi.AwsNative.DataBrew.Inputs.JobStatisticsConfiguration
Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations.
EntityDetectorConfiguration Pulumi.AwsNative.DataBrew.Inputs.JobEntityDetectorConfiguration
Configuration of entity detection for a profile job. When undefined, entity detection is disabled.
ProfileColumns List<Pulumi.AwsNative.DataBrew.Inputs.JobColumnSelector>
List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.
ColumnStatisticsConfigurations []JobColumnStatisticsConfiguration
List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations.
DatasetStatisticsConfiguration JobStatisticsConfiguration
Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations.
EntityDetectorConfiguration JobEntityDetectorConfiguration
Configuration of entity detection for a profile job. When undefined, entity detection is disabled.
ProfileColumns []JobColumnSelector
List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.
columnStatisticsConfigurations List<JobColumnStatisticsConfiguration>
List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations.
datasetStatisticsConfiguration JobStatisticsConfiguration
Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations.
entityDetectorConfiguration JobEntityDetectorConfiguration
Configuration of entity detection for a profile job. When undefined, entity detection is disabled.
profileColumns List<JobColumnSelector>
List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.
columnStatisticsConfigurations JobColumnStatisticsConfiguration[]
List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations.
datasetStatisticsConfiguration JobStatisticsConfiguration
Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations.
entityDetectorConfiguration JobEntityDetectorConfiguration
Configuration of entity detection for a profile job. When undefined, entity detection is disabled.
profileColumns JobColumnSelector[]
List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.
column_statistics_configurations Sequence[JobColumnStatisticsConfiguration]
List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations.
dataset_statistics_configuration JobStatisticsConfiguration
Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations.
entity_detector_configuration JobEntityDetectorConfiguration
Configuration of entity detection for a profile job. When undefined, entity detection is disabled.
profile_columns Sequence[JobColumnSelector]
List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.
columnStatisticsConfigurations List<Property Map>
List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations.
datasetStatisticsConfiguration Property Map
Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations.
entityDetectorConfiguration Property Map
Configuration of entity detection for a profile job. When undefined, entity detection is disabled.
profileColumns List<Property Map>
List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.

JobRecipe

Name This property is required. string
Recipe name
Version string
Recipe version
Name This property is required. string
Recipe name
Version string
Recipe version
name This property is required. String
Recipe name
version String
Recipe version
name This property is required. string
Recipe name
version string
Recipe version
name This property is required. str
Recipe name
version str
Recipe version
name This property is required. String
Recipe name
version String
Recipe version

JobS3Location

Bucket This property is required. string
The Amazon S3 bucket name.
BucketOwner string
The AWS account ID of the bucket owner.
Key string
The unique name of the object in the bucket.
Bucket This property is required. string
The Amazon S3 bucket name.
BucketOwner string
The AWS account ID of the bucket owner.
Key string
The unique name of the object in the bucket.
bucket This property is required. String
The Amazon S3 bucket name.
bucketOwner String
The AWS account ID of the bucket owner.
key String
The unique name of the object in the bucket.
bucket This property is required. string
The Amazon S3 bucket name.
bucketOwner string
The AWS account ID of the bucket owner.
key string
The unique name of the object in the bucket.
bucket This property is required. str
The Amazon S3 bucket name.
bucket_owner str
The AWS account ID of the bucket owner.
key str
The unique name of the object in the bucket.
bucket This property is required. String
The Amazon S3 bucket name.
bucketOwner String
The AWS account ID of the bucket owner.
key String
The unique name of the object in the bucket.

JobS3TableOutputOptions

Location This property is required. Pulumi.AwsNative.DataBrew.Inputs.JobS3Location
Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job.
Location This property is required. JobS3Location
Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job.
location This property is required. JobS3Location
Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job.
location This property is required. JobS3Location
Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job.
location This property is required. JobS3Location
Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job.
location This property is required. Property Map
Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job.

JobSample

Mode Pulumi.AwsNative.DataBrew.JobSampleMode
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 int

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

Mode JobSampleMode
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 int

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

mode JobSampleMode
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

mode JobSampleMode
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 number

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

mode JobSampleMode
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 int

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

mode "FULL_DATASET" | "CUSTOM_ROWS"
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 Number

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

JobSampleMode

JobStatisticOverride

Parameters This property is required. Dictionary<string, string>
A map that includes overrides of an evaluation’s parameters.
Statistic This property is required. string
The name of an evaluation
Parameters This property is required. map[string]string
A map that includes overrides of an evaluation’s parameters.
Statistic This property is required. string
The name of an evaluation
parameters This property is required. Map<String,String>
A map that includes overrides of an evaluation’s parameters.
statistic This property is required. String
The name of an evaluation
parameters This property is required. {[key: string]: string}
A map that includes overrides of an evaluation’s parameters.
statistic This property is required. string
The name of an evaluation
parameters This property is required. Mapping[str, str]
A map that includes overrides of an evaluation’s parameters.
statistic This property is required. str
The name of an evaluation
parameters This property is required. Map<String>
A map that includes overrides of an evaluation’s parameters.
statistic This property is required. String
The name of an evaluation

JobStatisticsConfiguration

IncludedStatistics List<string>
List of included evaluations. When the list is undefined, all supported evaluations will be included.
Overrides List<Pulumi.AwsNative.DataBrew.Inputs.JobStatisticOverride>
List of overrides for evaluations.
IncludedStatistics []string
List of included evaluations. When the list is undefined, all supported evaluations will be included.
Overrides []JobStatisticOverride
List of overrides for evaluations.
includedStatistics List<String>
List of included evaluations. When the list is undefined, all supported evaluations will be included.
overrides List<JobStatisticOverride>
List of overrides for evaluations.
includedStatistics string[]
List of included evaluations. When the list is undefined, all supported evaluations will be included.
overrides JobStatisticOverride[]
List of overrides for evaluations.
included_statistics Sequence[str]
List of included evaluations. When the list is undefined, all supported evaluations will be included.
overrides Sequence[JobStatisticOverride]
List of overrides for evaluations.
includedStatistics List<String>
List of included evaluations. When the list is undefined, all supported evaluations will be included.
overrides List<Property Map>
List of overrides for evaluations.

JobValidationConfiguration

RulesetArn This property is required. string
Arn of the Ruleset
ValidationMode Pulumi.AwsNative.DataBrew.JobValidationMode
Mode of data quality validation. Default mode is "CHECK_ALL" which verifies all rules defined in the selected ruleset.
RulesetArn This property is required. string
Arn of the Ruleset
ValidationMode JobValidationMode
Mode of data quality validation. Default mode is "CHECK_ALL" which verifies all rules defined in the selected ruleset.
rulesetArn This property is required. String
Arn of the Ruleset
validationMode JobValidationMode
Mode of data quality validation. Default mode is "CHECK_ALL" which verifies all rules defined in the selected ruleset.
rulesetArn This property is required. string
Arn of the Ruleset
validationMode JobValidationMode
Mode of data quality validation. Default mode is "CHECK_ALL" which verifies all rules defined in the selected ruleset.
ruleset_arn This property is required. str
Arn of the Ruleset
validation_mode JobValidationMode
Mode of data quality validation. Default mode is "CHECK_ALL" which verifies all rules defined in the selected ruleset.
rulesetArn This property is required. String
Arn of the Ruleset
validationMode "CHECK_ALL"
Mode of data quality validation. Default mode is "CHECK_ALL" which verifies all rules defined in the selected ruleset.

JobValidationMode

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native