Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. databrew
  5. getDataset

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

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.databrew.getDataset

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::DataBrew::Dataset.

    Using getDataset

    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 getDataset(args: GetDatasetArgs, opts?: InvokeOptions): Promise<GetDatasetResult>
function getDatasetOutput(args: GetDatasetOutputArgs, opts?: InvokeOptions): Output<GetDatasetResult>
    def get_dataset(name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetDatasetResult
def get_dataset_output(name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetDatasetResult]
    func LookupDataset(ctx *Context, args *LookupDatasetArgs, opts ...InvokeOption) (*LookupDatasetResult, error)
func LookupDatasetOutput(ctx *Context, args *LookupDatasetOutputArgs, opts ...InvokeOption) LookupDatasetResultOutput

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

    public static class GetDataset 
{
    public static Task<GetDatasetResult> InvokeAsync(GetDatasetArgs args, InvokeOptions? opts = null)
    public static Output<GetDatasetResult> Invoke(GetDatasetInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDatasetResult> getDataset(GetDatasetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    Name string
    Dataset name
    Name string
    Dataset name
    name String
    Dataset name
    name string
    Dataset name
    name str
    Dataset name
    name String
    Dataset name

    getDataset Result

    The following output properties are available:

    Supporting Types

    DatasetCsvOptions

    Delimiter string
    A single character that specifies the delimiter being used in the CSV file.
    HeaderRow bool
    A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
    Delimiter string
    A single character that specifies the delimiter being used in the CSV file.
    HeaderRow bool
    A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
    delimiter String
    A single character that specifies the delimiter being used in the CSV file.
    headerRow Boolean
    A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
    delimiter string
    A single character that specifies the delimiter being used in the CSV file.
    headerRow boolean
    A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
    delimiter str
    A single character that specifies the delimiter being used in the CSV file.
    header_row bool
    A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
    delimiter String
    A single character that specifies the delimiter being used in the CSV file.
    headerRow Boolean
    A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.

    DatasetDataCatalogInputDefinition

    CatalogId string
    Catalog id
    DatabaseName string
    Database name
    TableName string
    Table name
    TempDirectory Pulumi.AwsNative.DataBrew.Inputs.DatasetS3Location
    An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
    CatalogId string
    Catalog id
    DatabaseName string
    Database name
    TableName string
    Table name
    TempDirectory DatasetS3Location
    An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
    catalogId String
    Catalog id
    databaseName String
    Database name
    tableName String
    Table name
    tempDirectory DatasetS3Location
    An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
    catalogId string
    Catalog id
    databaseName string
    Database name
    tableName string
    Table name
    tempDirectory DatasetS3Location
    An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
    catalog_id str
    Catalog id
    database_name str
    Database name
    table_name str
    Table name
    temp_directory DatasetS3Location
    An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
    catalogId String
    Catalog id
    databaseName String
    Database name
    tableName String
    Table name
    tempDirectory Property Map
    An Amazon location that AWS Glue Data Catalog can use as a temporary directory.

    DatasetDatabaseInputDefinition

    GlueConnectionName string
    Glue connection name
    DatabaseTableName string
    Database table name
    QueryString string
    Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
    TempDirectory Pulumi.AwsNative.DataBrew.Inputs.DatasetS3Location
    An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
    GlueConnectionName string
    Glue connection name
    DatabaseTableName string
    Database table name
    QueryString string
    Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
    TempDirectory DatasetS3Location
    An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
    glueConnectionName String
    Glue connection name
    databaseTableName String
    Database table name
    queryString String
    Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
    tempDirectory DatasetS3Location
    An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
    glueConnectionName string
    Glue connection name
    databaseTableName string
    Database table name
    queryString string
    Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
    tempDirectory DatasetS3Location
    An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
    glue_connection_name str
    Glue connection name
    database_table_name str
    Database table name
    query_string str
    Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
    temp_directory DatasetS3Location
    An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
    glueConnectionName String
    Glue connection name
    databaseTableName String
    Database table name
    queryString String
    Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
    tempDirectory Property Map
    An Amazon location that AWS Glue Data Catalog can use as a temporary directory.

    DatasetDatetimeOptions

    Format string
    Date/time format of a date parameter
    LocaleCode string
    Locale code for a date parameter
    TimezoneOffset string
    Timezone offset
    Format string
    Date/time format of a date parameter
    LocaleCode string
    Locale code for a date parameter
    TimezoneOffset string
    Timezone offset
    format String
    Date/time format of a date parameter
    localeCode String
    Locale code for a date parameter
    timezoneOffset String
    Timezone offset
    format string
    Date/time format of a date parameter
    localeCode string
    Locale code for a date parameter
    timezoneOffset string
    Timezone offset
    format str
    Date/time format of a date parameter
    locale_code str
    Locale code for a date parameter
    timezone_offset str
    Timezone offset
    format String
    Date/time format of a date parameter
    localeCode String
    Locale code for a date parameter
    timezoneOffset String
    Timezone offset

    DatasetExcelOptions

    HeaderRow bool
    A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
    SheetIndexes List<int>
    One or more sheet numbers in the Excel file that will be included in the dataset.
    SheetNames List<string>
    One or more named sheets in the Excel file that will be included in the dataset.
    HeaderRow bool
    A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
    SheetIndexes []int
    One or more sheet numbers in the Excel file that will be included in the dataset.
    SheetNames []string
    One or more named sheets in the Excel file that will be included in the dataset.
    headerRow Boolean
    A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
    sheetIndexes List<Integer>
    One or more sheet numbers in the Excel file that will be included in the dataset.
    sheetNames List<String>
    One or more named sheets in the Excel file that will be included in the dataset.
    headerRow boolean
    A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
    sheetIndexes number[]
    One or more sheet numbers in the Excel file that will be included in the dataset.
    sheetNames string[]
    One or more named sheets in the Excel file that will be included in the dataset.
    header_row bool
    A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
    sheet_indexes Sequence[int]
    One or more sheet numbers in the Excel file that will be included in the dataset.
    sheet_names Sequence[str]
    One or more named sheets in the Excel file that will be included in the dataset.
    headerRow Boolean
    A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
    sheetIndexes List<Number>
    One or more sheet numbers in the Excel file that will be included in the dataset.
    sheetNames List<String>
    One or more named sheets in the Excel file that will be included in the dataset.

    DatasetFilesLimit

    maxFiles Integer
    Maximum number of files
    order DatasetFilesLimitOrder
    Order
    orderedBy DatasetFilesLimitOrderedBy
    Ordered by
    maxFiles number
    Maximum number of files
    order DatasetFilesLimitOrder
    Order
    orderedBy DatasetFilesLimitOrderedBy
    Ordered by
    maxFiles Number
    Maximum number of files
    order "ASCENDING" | "DESCENDING"
    Order
    orderedBy "LAST_MODIFIED_DATE"
    Ordered by

    DatasetFilesLimitOrder

    DatasetFilesLimitOrderedBy

    DatasetFilterExpression

    Expression string
    Filtering expression for a parameter
    ValuesMap List<Pulumi.AwsNative.DataBrew.Inputs.DatasetFilterValue>
    The map of substitution variable names to their values used in this filter expression.
    Expression string
    Filtering expression for a parameter
    ValuesMap []DatasetFilterValue
    The map of substitution variable names to their values used in this filter expression.
    expression String
    Filtering expression for a parameter
    valuesMap List<DatasetFilterValue>
    The map of substitution variable names to their values used in this filter expression.
    expression string
    Filtering expression for a parameter
    valuesMap DatasetFilterValue[]
    The map of substitution variable names to their values used in this filter expression.
    expression str
    Filtering expression for a parameter
    values_map Sequence[DatasetFilterValue]
    The map of substitution variable names to their values used in this filter expression.
    expression String
    Filtering expression for a parameter
    valuesMap List<Property Map>
    The map of substitution variable names to their values used in this filter expression.

    DatasetFilterValue

    Value string
    The value to be associated with the substitution variable.
    ValueReference string
    Variable name
    Value string
    The value to be associated with the substitution variable.
    ValueReference string
    Variable name
    value String
    The value to be associated with the substitution variable.
    valueReference String
    Variable name
    value string
    The value to be associated with the substitution variable.
    valueReference string
    Variable name
    value str
    The value to be associated with the substitution variable.
    value_reference str
    Variable name
    value String
    The value to be associated with the substitution variable.
    valueReference String
    Variable name

    DatasetFormat

    DatasetFormatOptions

    Csv Pulumi.AwsNative.DataBrew.Inputs.DatasetCsvOptions
    Options that define how CSV input is to be interpreted by DataBrew.
    Excel Pulumi.AwsNative.DataBrew.Inputs.DatasetExcelOptions
    Options that define how Excel input is to be interpreted by DataBrew.
    Json Pulumi.AwsNative.DataBrew.Inputs.DatasetJsonOptions
    Options that define how JSON input is to be interpreted by DataBrew.
    Csv DatasetCsvOptions
    Options that define how CSV input is to be interpreted by DataBrew.
    Excel DatasetExcelOptions
    Options that define how Excel input is to be interpreted by DataBrew.
    Json DatasetJsonOptions
    Options that define how JSON input is to be interpreted by DataBrew.
    csv DatasetCsvOptions
    Options that define how CSV input is to be interpreted by DataBrew.
    excel DatasetExcelOptions
    Options that define how Excel input is to be interpreted by DataBrew.
    json DatasetJsonOptions
    Options that define how JSON input is to be interpreted by DataBrew.
    csv DatasetCsvOptions
    Options that define how CSV input is to be interpreted by DataBrew.
    excel DatasetExcelOptions
    Options that define how Excel input is to be interpreted by DataBrew.
    json DatasetJsonOptions
    Options that define how JSON input is to be interpreted by DataBrew.
    csv DatasetCsvOptions
    Options that define how CSV input is to be interpreted by DataBrew.
    excel DatasetExcelOptions
    Options that define how Excel input is to be interpreted by DataBrew.
    json DatasetJsonOptions
    Options that define how JSON input is to be interpreted by DataBrew.
    csv Property Map
    Options that define how CSV input is to be interpreted by DataBrew.
    excel Property Map
    Options that define how Excel input is to be interpreted by DataBrew.
    json Property Map
    Options that define how JSON input is to be interpreted by DataBrew.

    DatasetInput

    DataCatalogInputDefinition Pulumi.AwsNative.DataBrew.Inputs.DatasetDataCatalogInputDefinition
    The AWS Glue Data Catalog parameters for the data.
    DatabaseInputDefinition Pulumi.AwsNative.DataBrew.Inputs.DatasetDatabaseInputDefinition
    Connection information for dataset input files stored in a database.
    Metadata Pulumi.AwsNative.DataBrew.Inputs.DatasetMetadata
    Contains additional resource information needed for specific datasets.
    S3InputDefinition Pulumi.AwsNative.DataBrew.Inputs.DatasetS3Location
    The Amazon S3 location where the data is stored.
    DataCatalogInputDefinition DatasetDataCatalogInputDefinition
    The AWS Glue Data Catalog parameters for the data.
    DatabaseInputDefinition DatasetDatabaseInputDefinition
    Connection information for dataset input files stored in a database.
    Metadata DatasetMetadata
    Contains additional resource information needed for specific datasets.
    S3InputDefinition DatasetS3Location
    The Amazon S3 location where the data is stored.
    dataCatalogInputDefinition DatasetDataCatalogInputDefinition
    The AWS Glue Data Catalog parameters for the data.
    databaseInputDefinition DatasetDatabaseInputDefinition
    Connection information for dataset input files stored in a database.
    metadata DatasetMetadata
    Contains additional resource information needed for specific datasets.
    s3InputDefinition DatasetS3Location
    The Amazon S3 location where the data is stored.
    dataCatalogInputDefinition DatasetDataCatalogInputDefinition
    The AWS Glue Data Catalog parameters for the data.
    databaseInputDefinition DatasetDatabaseInputDefinition
    Connection information for dataset input files stored in a database.
    metadata DatasetMetadata
    Contains additional resource information needed for specific datasets.
    s3InputDefinition DatasetS3Location
    The Amazon S3 location where the data is stored.
    data_catalog_input_definition DatasetDataCatalogInputDefinition
    The AWS Glue Data Catalog parameters for the data.
    database_input_definition DatasetDatabaseInputDefinition
    Connection information for dataset input files stored in a database.
    metadata DatasetMetadata
    Contains additional resource information needed for specific datasets.
    s3_input_definition DatasetS3Location
    The Amazon S3 location where the data is stored.
    dataCatalogInputDefinition Property Map
    The AWS Glue Data Catalog parameters for the data.
    databaseInputDefinition Property Map
    Connection information for dataset input files stored in a database.
    metadata Property Map
    Contains additional resource information needed for specific datasets.
    s3InputDefinition Property Map
    The Amazon S3 location where the data is stored.

    DatasetJsonOptions

    MultiLine bool
    A value that specifies whether JSON input contains embedded new line characters.
    MultiLine bool
    A value that specifies whether JSON input contains embedded new line characters.
    multiLine Boolean
    A value that specifies whether JSON input contains embedded new line characters.
    multiLine boolean
    A value that specifies whether JSON input contains embedded new line characters.
    multi_line bool
    A value that specifies whether JSON input contains embedded new line characters.
    multiLine Boolean
    A value that specifies whether JSON input contains embedded new line characters.

    DatasetMetadata

    SourceArn string
    Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.
    SourceArn string
    Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.
    sourceArn String
    Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.
    sourceArn string
    Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.
    source_arn str
    Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.
    sourceArn String
    Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.

    DatasetParameter

    Name string
    The name of the parameter that is used in the dataset's Amazon S3 path.
    Type Pulumi.AwsNative.DataBrew.DatasetParameterType
    Parameter type
    CreateColumn bool
    Add the value of this parameter as a column in a dataset.
    DatetimeOptions Pulumi.AwsNative.DataBrew.Inputs.DatasetDatetimeOptions
    Additional parameter options such as a format and a timezone. Required for datetime parameters.
    Filter Pulumi.AwsNative.DataBrew.Inputs.DatasetFilterExpression
    The optional filter expression structure to apply additional matching criteria to the parameter.
    Name string
    The name of the parameter that is used in the dataset's Amazon S3 path.
    Type DatasetParameterType
    Parameter type
    CreateColumn bool
    Add the value of this parameter as a column in a dataset.
    DatetimeOptions DatasetDatetimeOptions
    Additional parameter options such as a format and a timezone. Required for datetime parameters.
    Filter DatasetFilterExpression
    The optional filter expression structure to apply additional matching criteria to the parameter.
    name String
    The name of the parameter that is used in the dataset's Amazon S3 path.
    type DatasetParameterType
    Parameter type
    createColumn Boolean
    Add the value of this parameter as a column in a dataset.
    datetimeOptions DatasetDatetimeOptions
    Additional parameter options such as a format and a timezone. Required for datetime parameters.
    filter DatasetFilterExpression
    The optional filter expression structure to apply additional matching criteria to the parameter.
    name string
    The name of the parameter that is used in the dataset's Amazon S3 path.
    type DatasetParameterType
    Parameter type
    createColumn boolean
    Add the value of this parameter as a column in a dataset.
    datetimeOptions DatasetDatetimeOptions
    Additional parameter options such as a format and a timezone. Required for datetime parameters.
    filter DatasetFilterExpression
    The optional filter expression structure to apply additional matching criteria to the parameter.
    name str
    The name of the parameter that is used in the dataset's Amazon S3 path.
    type DatasetParameterType
    Parameter type
    create_column bool
    Add the value of this parameter as a column in a dataset.
    datetime_options DatasetDatetimeOptions
    Additional parameter options such as a format and a timezone. Required for datetime parameters.
    filter DatasetFilterExpression
    The optional filter expression structure to apply additional matching criteria to the parameter.
    name String
    The name of the parameter that is used in the dataset's Amazon S3 path.
    type "String" | "Number" | "Datetime"
    Parameter type
    createColumn Boolean
    Add the value of this parameter as a column in a dataset.
    datetimeOptions Property Map
    Additional parameter options such as a format and a timezone. Required for datetime parameters.
    filter Property Map
    The optional filter expression structure to apply additional matching criteria to the parameter.

    DatasetParameterType

    DatasetPathOptions

    FilesLimit Pulumi.AwsNative.DataBrew.Inputs.DatasetFilesLimit
    If provided, this structure imposes a limit on a number of files that should be selected.
    LastModifiedDateCondition Pulumi.AwsNative.DataBrew.Inputs.DatasetFilterExpression
    If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 .
    Parameters List<Pulumi.AwsNative.DataBrew.Inputs.DatasetPathParameter>
    A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
    FilesLimit DatasetFilesLimit
    If provided, this structure imposes a limit on a number of files that should be selected.
    LastModifiedDateCondition DatasetFilterExpression
    If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 .
    Parameters []DatasetPathParameter
    A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
    filesLimit DatasetFilesLimit
    If provided, this structure imposes a limit on a number of files that should be selected.
    lastModifiedDateCondition DatasetFilterExpression
    If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 .
    parameters List<DatasetPathParameter>
    A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
    filesLimit DatasetFilesLimit
    If provided, this structure imposes a limit on a number of files that should be selected.
    lastModifiedDateCondition DatasetFilterExpression
    If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 .
    parameters DatasetPathParameter[]
    A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
    files_limit DatasetFilesLimit
    If provided, this structure imposes a limit on a number of files that should be selected.
    last_modified_date_condition DatasetFilterExpression
    If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 .
    parameters Sequence[DatasetPathParameter]
    A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
    filesLimit Property Map
    If provided, this structure imposes a limit on a number of files that should be selected.
    lastModifiedDateCondition Property Map
    If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 .
    parameters List<Property Map>
    A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.

    DatasetPathParameter

    DatasetParameter Pulumi.AwsNative.DataBrew.Inputs.DatasetParameter
    The path parameter definition.
    PathParameterName string
    The name of the path parameter.
    DatasetParameter DatasetParameter
    The path parameter definition.
    PathParameterName string
    The name of the path parameter.
    datasetParameter DatasetParameter
    The path parameter definition.
    pathParameterName String
    The name of the path parameter.
    datasetParameter DatasetParameter
    The path parameter definition.
    pathParameterName string
    The name of the path parameter.
    dataset_parameter DatasetParameter
    The path parameter definition.
    path_parameter_name str
    The name of the path parameter.
    datasetParameter Property Map
    The path parameter definition.
    pathParameterName String
    The name of the path parameter.

    DatasetS3Location

    Bucket string
    The Amazon S3 bucket name.
    Key string
    The unique name of the object in the bucket.
    Bucket string
    The Amazon S3 bucket name.
    Key string
    The unique name of the object in the bucket.
    bucket String
    The Amazon S3 bucket name.
    key String
    The unique name of the object in the bucket.
    bucket string
    The Amazon S3 bucket name.
    key string
    The unique name of the object in the bucket.
    bucket str
    The Amazon S3 bucket name.
    key str
    The unique name of the object in the bucket.
    bucket String
    The Amazon S3 bucket name.
    key String
    The unique name of the object in the bucket.

    Package Details

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

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

    AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws-native