AWS Native v0.54.0, Mar 21 23

aws-native.databrew.getJob

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>

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>
DatabaseOutputs List<Pulumi.AwsNative.DataBrew.Outputs.JobDatabaseOutput>
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>
ProfileConfiguration Pulumi.AwsNative.DataBrew.Outputs.JobProfileConfiguration: Profile Job configuration
ProjectName string: Project name
Recipe Pulumi.AwsNative.DataBrew.Outputs.JobRecipe
RoleArn string: Role arn
Timeout int: Timeout
ValidationConfigurations List<Pulumi.AwsNative.DataBrew.Outputs.JobValidationConfiguration>: Data quality rules configuration

DataCatalogOutputs []JobDataCatalogOutput
DatabaseOutputs []JobDatabaseOutput
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
ProfileConfiguration JobProfileConfiguration: Profile Job configuration
ProjectName string: Project name
Recipe JobRecipe
RoleArn string: Role arn
Timeout int: Timeout
ValidationConfigurations []JobValidationConfiguration: Data quality rules configuration

dataCatalogOutputs List<JobDataCatalogOutput>
databaseOutputs List<JobDatabaseOutput>
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>
profileConfiguration JobProfileConfiguration: Profile Job configuration
projectName String: Project name
recipe JobRecipe
roleArn String: Role arn
timeout Integer: Timeout
validationConfigurations List<JobValidationConfiguration>: Data quality rules configuration

dataCatalogOutputs JobDataCatalogOutput[]
databaseOutputs JobDatabaseOutput[]
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[]
profileConfiguration JobProfileConfiguration: Profile Job configuration
projectName string: Project name
recipe JobRecipe
roleArn string: Role arn
timeout number: Timeout
validationConfigurations JobValidationConfiguration[]: Data quality rules configuration

data_catalog_outputs Sequence[JobDataCatalogOutput]
database_outputs Sequence[JobDatabaseOutput]
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]
profile_configuration JobProfileConfiguration: Profile Job configuration
project_name str: Project name
recipe JobRecipe
role_arn str: Role arn
timeout int: Timeout
validation_configurations Sequence[JobValidationConfiguration]: Data quality rules configuration

dataCatalogOutputs List<Property Map>
databaseOutputs List<Property Map>
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>
profileConfiguration Property Map: Profile Job configuration
projectName String: Project name
recipe Property Map
roleArn String: Role arn
timeout Number: Timeout
validationConfigurations List<Property Map>: Data quality rules configuration

Supporting Types

JobAllowedStatistics

Statistics List<string>

Statistics []string

statistics List<String>

statistics string[]

statistics Sequence[str]

statistics List<String>

JobColumnSelector

Name string
Regex string

Name string
Regex string

name String
regex String

name string
regex string

name str
regex str

name String
regex String

JobDatabaseOutputDatabaseOutputMode

JobDatabaseTableOutputOptions

TableName string
TempDirectory Pulumi.AwsNative.DataBrew.Inputs.JobS3Location

TableName string
TempDirectory JobS3Location

tableName String
tempDirectory JobS3Location

tableName string
tempDirectory JobS3Location

table_name str
temp_directory JobS3Location

tableName String
tempDirectory Property Map

JobEncryptionMode

JobEntityDetectorConfiguration

EntityTypes List<string>
AllowedStatistics Pulumi.AwsNative.DataBrew.Inputs.JobAllowedStatistics

EntityTypes []string
AllowedStatistics JobAllowedStatistics

entityTypes List<String>
allowedStatistics JobAllowedStatistics

entityTypes string[]
allowedStatistics JobAllowedStatistics

entity_types Sequence[str]
allowed_statistics JobAllowedStatistics

entityTypes List<String>
allowedStatistics Property Map

JobLogSubscription

JobOutput

Location Pulumi.AwsNative.DataBrew.Inputs.JobS3Location
CompressionFormat Pulumi.AwsNative.DataBrew.JobOutputCompressionFormat
Format Pulumi.AwsNative.DataBrew.JobOutputFormat
FormatOptions Pulumi.AwsNative.DataBrew.Inputs.JobOutputFormatOptions
MaxOutputFiles int
Overwrite bool
PartitionColumns List<string>

Location JobS3Location
CompressionFormat JobOutputCompressionFormat
Format JobOutputFormat
FormatOptions JobOutputFormatOptions
MaxOutputFiles int
Overwrite bool
PartitionColumns []string

location JobS3Location
compressionFormat JobOutputCompressionFormat
format JobOutputFormat
formatOptions JobOutputFormatOptions
maxOutputFiles Integer
overwrite Boolean
partitionColumns List<String>

location JobS3Location
compressionFormat JobOutputCompressionFormat
format JobOutputFormat
formatOptions JobOutputFormatOptions
maxOutputFiles number
overwrite boolean
partitionColumns string[]

location JobS3Location
compression_format JobOutputCompressionFormat
format JobOutputFormat
format_options JobOutputFormatOptions
max_output_files int
overwrite bool
partition_columns Sequence[str]

location Property Map
compressionFormat "GZIP" | "LZ4" | "SNAPPY" | "BZIP2" | "DEFLATE" | "LZO" | "BROTLI" | "ZSTD" | "ZLIB"
format "CSV" | "JSON" | "PARQUET" | "GLUEPARQUET" | "AVRO" | "ORC" | "XML" | "TABLEAUHYPER"
formatOptions Property Map
maxOutputFiles Number
overwrite Boolean
partitionColumns List<String>

JobOutputCompressionFormat

JobOutputFormat

JobOutputFormatOptions

Csv Pulumi.AwsNative.DataBrew.Inputs.JobCsvOutputOptions

Csv JobCsvOutputOptions

csv JobCsvOutputOptions

csv JobCsvOutputOptions

csv JobCsvOutputOptions

csv Property Map

JobOutputLocation

Bucket string
BucketOwner string
Key string

Bucket string
BucketOwner string
Key string

bucket String
bucketOwner String
key String

bucket string
bucketOwner string
key string

bucket str
bucket_owner str
key str

bucket String
bucketOwner String
key String

JobProfileConfiguration

ColumnStatisticsConfigurations List<Pulumi.AwsNative.DataBrew.Inputs.JobColumnStatisticsConfiguration>
DatasetStatisticsConfiguration Pulumi.AwsNative.DataBrew.Inputs.JobStatisticsConfiguration
EntityDetectorConfiguration Pulumi.AwsNative.DataBrew.Inputs.JobEntityDetectorConfiguration
ProfileColumns List<Pulumi.AwsNative.DataBrew.Inputs.JobColumnSelector>

ColumnStatisticsConfigurations []JobColumnStatisticsConfiguration
DatasetStatisticsConfiguration JobStatisticsConfiguration
EntityDetectorConfiguration JobEntityDetectorConfiguration
ProfileColumns []JobColumnSelector

columnStatisticsConfigurations List<JobColumnStatisticsConfiguration>
datasetStatisticsConfiguration JobStatisticsConfiguration
entityDetectorConfiguration JobEntityDetectorConfiguration
profileColumns List<JobColumnSelector>

columnStatisticsConfigurations JobColumnStatisticsConfiguration[]
datasetStatisticsConfiguration JobStatisticsConfiguration
entityDetectorConfiguration JobEntityDetectorConfiguration
profileColumns JobColumnSelector[]

column_statistics_configurations Sequence[JobColumnStatisticsConfiguration]
dataset_statistics_configuration JobStatisticsConfiguration
entity_detector_configuration JobEntityDetectorConfiguration
profile_columns Sequence[JobColumnSelector]

columnStatisticsConfigurations List<Property Map>
datasetStatisticsConfiguration Property Map
entityDetectorConfiguration Property Map
profileColumns List<Property Map>

JobRecipe

Name string: Recipe name
Version string: Recipe version

Name string: Recipe name
Version string: Recipe version

name String: Recipe name
version String: Recipe version

name string: Recipe name
version string: Recipe version

name str: Recipe name
version str: Recipe version

name String: Recipe name
version String: Recipe version

JobS3Location

Bucket string
BucketOwner string
Key string

Bucket string
BucketOwner string
Key string

bucket String
bucketOwner String
key String

bucket string
bucketOwner string
key string

bucket str
bucket_owner str
key str

bucket String
bucketOwner String
key String

JobS3TableOutputOptions

Location Pulumi.AwsNative.DataBrew.Inputs.JobS3Location

Location JobS3Location

location JobS3Location

location JobS3Location

location JobS3Location

location Property Map

JobSample

Mode Pulumi.AwsNative.DataBrew.JobSampleMode
Size int

Mode JobSampleMode
Size int

mode JobSampleMode
size Integer

mode JobSampleMode
size number

mode JobSampleMode
size int

mode "FULL_DATASET" | "CUSTOM_ROWS"
size Number

JobSampleMode

JobStatisticOverride

Parameters Pulumi.AwsNative.DataBrew.Inputs.JobParameterMap
Statistic string

Parameters JobParameterMap
Statistic string

parameters JobParameterMap
statistic String

parameters JobParameterMap
statistic string

parameters JobParameterMap
statistic str

parameters Property Map
statistic String

JobStatisticsConfiguration

IncludedStatistics List<string>
Overrides List<Pulumi.AwsNative.DataBrew.Inputs.JobStatisticOverride>

IncludedStatistics []string
Overrides []JobStatisticOverride

includedStatistics List<String>
overrides List<JobStatisticOverride>

includedStatistics string[]
overrides JobStatisticOverride[]

included_statistics Sequence[str]
overrides Sequence[JobStatisticOverride]

includedStatistics List<String>
overrides List<Property Map>

JobValidationConfiguration

RulesetArn string: Arn of the Ruleset
ValidationMode Pulumi.AwsNative.DataBrew.JobValidationMode

RulesetArn string: Arn of the Ruleset
ValidationMode JobValidationMode

rulesetArn String: Arn of the Ruleset
validationMode JobValidationMode

rulesetArn string: Arn of the Ruleset
validationMode JobValidationMode

ruleset_arn str: Arn of the Ruleset
validation_mode JobValidationMode

rulesetArn String: Arn of the Ruleset
validationMode "CHECK_ALL"

JobValidationMode

Package Details

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