AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Glue DataBrew CreateDataset API operation.

Syntax

New-GDBDataset
-DatabaseInputDefinition_TempDirectory_Bucket <String>
-DataCatalogInputDefinition_TempDirectory_Bucket <String>
-S3InputDefinition_Bucket <String>
-DataCatalogInputDefinition_CatalogId <String>
-DataCatalogInputDefinition_DatabaseName <String>
-DatabaseInputDefinition_DatabaseTableName <String>
-Csv_Delimiter <String>
-LastModifiedDateCondition_Expression <String>
-Format <InputFormat>
-DatabaseInputDefinition_GlueConnectionName <String>
-Csv_HeaderRow <Boolean>
-Excel_HeaderRow <Boolean>
-DatabaseInputDefinition_TempDirectory_Key <String>
-DataCatalogInputDefinition_TempDirectory_Key <String>
-S3InputDefinition_Key <String>
-FilesLimit_MaxFile <Int32>
-Json_MultiLine <Boolean>
-Name <String>
-FilesLimit_Order <Order>
-FilesLimit_OrderedBy <OrderedBy>
-PathOptions_Parameter <Hashtable>
-DatabaseInputDefinition_QueryString <String>
-Excel_SheetIndex <Int32[]>
-Excel_SheetName <String[]>
-Metadata_SourceArn <String>
-DataCatalogInputDefinition_TableName <String>
-Tag <Hashtable>
-LastModifiedDateCondition_ValuesMap <Hashtable>
-Select <String>
-Force <SwitchParameter>

Description

Creates a new DataBrew dataset.

Parameters

-Csv_Delimiter <String>
A single character that specifies the delimiter being used in the CSV file.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormatOptions_Csv_Delimiter
-Csv_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormatOptions_Csv_HeaderRow
-DatabaseInputDefinition_DatabaseTableName <String>
The table within the target database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInput_DatabaseInputDefinition_DatabaseTableName
-DatabaseInputDefinition_GlueConnectionName <String>
The Glue Connection that stores the connection information for the target database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInput_DatabaseInputDefinition_GlueConnectionName
-DatabaseInputDefinition_QueryString <String>
Custom SQL to run against the provided Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInput_DatabaseInputDefinition_QueryString
-DatabaseInputDefinition_TempDirectory_Bucket <String>
The Amazon S3 bucket name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInput_DatabaseInputDefinition_TempDirectory_Bucket
-DatabaseInputDefinition_TempDirectory_Key <String>
The unique name of the object in the bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInput_DatabaseInputDefinition_TempDirectory_Key
-DataCatalogInputDefinition_CatalogId <String>
The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInput_DataCatalogInputDefinition_CatalogId
-DataCatalogInputDefinition_DatabaseName <String>
The name of a database in the Data Catalog.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInput_DataCatalogInputDefinition_DatabaseName
-DataCatalogInputDefinition_TableName <String>
The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInput_DataCatalogInputDefinition_TableName
-DataCatalogInputDefinition_TempDirectory_Bucket <String>
The Amazon S3 bucket name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInput_DataCatalogInputDefinition_TempDirectory_Bucket
-DataCatalogInputDefinition_TempDirectory_Key <String>
The unique name of the object in the bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInput_DataCatalogInputDefinition_TempDirectory_Key
-Excel_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormatOptions_Excel_HeaderRow
-Excel_SheetIndex <Int32[]>
One or more sheet numbers in the Excel file that will be included in the dataset.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormatOptions_Excel_SheetIndexes
-Excel_SheetName <String[]>
One or more named sheets in the Excel file that will be included in the dataset.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormatOptions_Excel_SheetNames
-FilesLimit_MaxFile <Int32>
The number of Amazon S3 files to select.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPathOptions_FilesLimit_MaxFiles
-FilesLimit_Order <Order>
A criteria to use for Amazon S3 files sorting before their selection. By default uses DESCENDING order, i.e. most recent files are selected first. Anotherpossible value is ASCENDING.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPathOptions_FilesLimit_Order
-FilesLimit_OrderedBy <OrderedBy>
A criteria to use for Amazon S3 files sorting before their selection. By default uses LAST_MODIFIED_DATE as a sorting criteria. Currently it's the only allowed value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPathOptions_FilesLimit_OrderedBy
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Format <InputFormat>
The file format of a dataset that is created from an Amazon S3 file or folder.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Json_MultiLine <Boolean>
A value that specifies whether JSON input contains embedded new line characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormatOptions_Json_MultiLine
-LastModifiedDateCondition_Expression <String>
The expression which includes condition names followed by substitution variables, possibly grouped and combined with other conditions. For example, "(starts_with :prefix1 or starts_with :prefix2) and (ends_with :suffix1 or ends_with :suffix2)". Substitution variables should start with ':' symbol.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPathOptions_LastModifiedDateCondition_Expression
-LastModifiedDateCondition_ValuesMap <Hashtable>
The map of substitution variable names to their values used in this filter expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPathOptions_LastModifiedDateCondition_ValuesMap
-Metadata_SourceArn <String>
The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew only supports ARNs from Amazon AppFlow.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInput_Metadata_SourceArn
-Name <String>
The name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PathOptions_Parameter <Hashtable>
A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPathOptions_Parameters
-S3InputDefinition_Bucket <String>
The Amazon S3 bucket name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInput_S3InputDefinition_Bucket
-S3InputDefinition_Key <String>
The unique name of the object in the bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInput_S3InputDefinition_Key
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Name'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GlueDataBrew.Model.CreateDatasetResponse). Specifying the name of a property of type Amazon.GlueDataBrew.Model.CreateDatasetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
Metadata tags to apply to this dataset.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns a System.String object. The service call response (type Amazon.GlueDataBrew.Model.CreateDatasetResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z