AWS Native v0.109.0, Jun 26 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.databrew.getJob

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi

pulumi/pulumi-aws-native

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>

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]

func LookupJob(ctx *Context, args *LookupJobArgs, opts ...InvokeOption) (*LookupJobResult, error)
func LookupJobOutput(ctx *Context, args *LookupJobOutputArgs, opts ...InvokeOption) LookupJobResultOutput

> 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)
}

public static CompletableFuture<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:databrew:getJob
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Job name

Name string: Job name

name String: Job name

name string: Job name

name str: Job name

name 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
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
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
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
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
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
timeout Number: Timeout
validationConfigurations List<Property Map>: Data quality rules configuration

Supporting Types

JobAllowedStatistics

Statistics List<string>: One or more column statistics to allow for columns that contain detected entities.

Statistics []string: One or more column statistics to allow for columns that contain detected entities.

statistics List<String>: One or more column statistics to allow for columns that contain detected entities.

statistics string[]: One or more column statistics to allow for columns that contain detected entities.

statistics Sequence[str]: One or more column statistics to allow for columns that contain detected entities.

statistics 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 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 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 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 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 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 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 string: The name of a database in the Data Catalog.
TableName 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 string: The name of a database in the Data Catalog.
TableName 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 String: The name of a database in the Data Catalog.
tableName 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 string: The name of a database in the Data Catalog.
tableName 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 str: The name of a database in the Data Catalog.
table_name 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 String: The name of a database in the Data Catalog.
tableName 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 Pulumi.AwsNative.DataBrew.Inputs.JobDatabaseTableOutputOptions: Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
GlueConnectionName string: Glue connection name
DatabaseOutputMode Pulumi.AwsNative.DataBrew.JobDatabaseOutputDatabaseOutputMode: Database table name

DatabaseOptions JobDatabaseTableOutputOptions: Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
GlueConnectionName string: Glue connection name
DatabaseOutputMode JobDatabaseOutputDatabaseOutputMode: Database table name

databaseOptions JobDatabaseTableOutputOptions: Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
glueConnectionName String: Glue connection name
databaseOutputMode JobDatabaseOutputDatabaseOutputMode: Database table name

databaseOptions JobDatabaseTableOutputOptions: Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
glueConnectionName string: Glue connection name
databaseOutputMode JobDatabaseOutputDatabaseOutputMode: Database table name

database_options JobDatabaseTableOutputOptions: Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
glue_connection_name str: Glue connection name
database_output_mode JobDatabaseOutputDatabaseOutputMode: Database table name

databaseOptions Property Map: Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
glueConnectionName String: Glue connection name
databaseOutputMode "NEW_TABLE": Database table name

JobDatabaseOutputDatabaseOutputMode

JobDatabaseTableOutputOptions

TableName 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 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 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 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 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 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