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 Data Exchange CreateJob API operation.

Syntax

New-DTEXJob
-Type <Type>
-ImportAssetFromApiGatewayApi_ApiDescription <String>
-ImportAssetFromApiGatewayApi_ApiId <String>
-ImportAssetFromApiGatewayApi_ApiKey <String>
-ImportAssetFromApiGatewayApi_ApiName <String>
-ImportAssetFromApiGatewayApi_ApiSpecificationMd5Hash <String>
-ExportAssetsToS3_AssetDestination <AssetDestinationEntry[]>
-ExportAssetToSignedUrl_AssetId <String>
-ImportAssetFromSignedUrl_AssetName <String>
-ImportAssetsFromRedshiftDataShares_AssetSource <RedshiftDataShareAssetSourceEntry[]>
-ImportAssetsFromS3_AssetSource <AssetSourceEntry[]>
-AssetSource_Bucket <String>
-ImportAssetsFromLakeFormationTagPolicy_CatalogId <String>
-CreateS3DataAccessFromS3Bucket_DataSetId <String>
-ExportAssetsToS3_DataSetId <String>
-ExportAssetToSignedUrl_DataSetId <String>
-ExportRevisionsToS3_DataSetId <String>
-ImportAssetFromApiGatewayApi_DataSetId <String>
-ImportAssetFromSignedUrl_DataSetId <String>
-ImportAssetsFromLakeFormationTagPolicy_DataSetId <String>
-ImportAssetsFromRedshiftDataShares_DataSetId <String>
-ImportAssetsFromS3_DataSetId <String>
-Database_Expression <LFTag[]>
-Table_Expression <LFTag[]>
-AssetSource_KeyPrefix <String[]>
-AssetSource_Key <String[]>
-Encryption_KmsKeyArn <String>
-Details_ExportRevisionsToS3_Encryption_KmsKeyArn <String>
-AssetSource_KmsKeysToGrant <KmsKeyToGrant[]>
-ImportAssetFromSignedUrl_Md5Hash <String>
-Database_Permission <String[]>
-Table_Permission <String[]>
-ImportAssetFromApiGatewayApi_ProtocolType <ProtocolType>
-ExportRevisionsToS3_RevisionDestination <RevisionDestinationEntry[]>
-CreateS3DataAccessFromS3Bucket_RevisionId <String>
-ExportAssetsToS3_RevisionId <String>
-ExportAssetToSignedUrl_RevisionId <String>
-ImportAssetFromApiGatewayApi_RevisionId <String>
-ImportAssetFromSignedUrl_RevisionId <String>
-ImportAssetsFromLakeFormationTagPolicy_RevisionId <String>
-ImportAssetsFromRedshiftDataShares_RevisionId <String>
-ImportAssetsFromS3_RevisionId <String>
-ImportAssetsFromLakeFormationTagPolicy_RoleArn <String>
-ImportAssetFromApiGatewayApi_Stage <String>
-Encryption_Type <ServerSideEncryptionTypes>
-Details_ExportRevisionsToS3_Encryption_Type <ServerSideEncryptionTypes>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonDataExchangeConfig>

Description

This operation creates a job.

Parameters

-AssetSource_Bucket <String>
The Amazon S3 bucket used for hosting shared data in the Amazon S3 data access.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_CreateS3DataAccessFromS3Bucket_AssetSource_Bucket
-AssetSource_Key <String[]>
The keys used to create the Amazon S3 data access. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_CreateS3DataAccessFromS3Bucket_AssetSource_Keys
-AssetSource_KeyPrefix <String[]>
Organizes Amazon S3 asset key prefixes stored in an Amazon S3 bucket. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_CreateS3DataAccessFromS3Bucket_AssetSource_KeyPrefixes
-AssetSource_KmsKeysToGrant <KmsKeyToGrant[]>
List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used to encrypt S3 objects being shared in this S3 Data Access asset. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_CreateS3DataAccessFromS3Bucket_AssetSource_KmsKeysToGrant
-ClientConfig <AmazonDataExchangeConfig>
Amazon.PowerShell.Cmdlets.DTEX.AmazonDataExchangeClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CreateS3DataAccessFromS3Bucket_DataSetId <String>
The unique identifier for the data set associated with the creation of this Amazon S3 data access.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_CreateS3DataAccessFromS3Bucket_DataSetId
-CreateS3DataAccessFromS3Bucket_RevisionId <String>
The unique identifier for a revision.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_CreateS3DataAccessFromS3Bucket_RevisionId
-Database_Expression <LFTag[]>
A list of LF-tag conditions that apply to database resources. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetsFromLakeFormationTagPolicy_Database_Expression
-Database_Permission <String[]>
The permissions granted to subscribers on database resources. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetsFromLakeFormationTagPolicy_Database_Permissions
-Details_ExportRevisionsToS3_Encryption_KmsKeyArn <String>
The Amazon Resource Name (ARN) of the AWS KMS key you want to use to encrypt the Amazon S3 objects. This parameter is required if you choose aws:kms as an encryption type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Details_ExportRevisionsToS3_Encryption_Type <ServerSideEncryptionTypes>
The type of server side encryption used for encrypting the objects in Amazon S3.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Encryption_KmsKeyArn <String>
The Amazon Resource Name (ARN) of the AWS KMS key you want to use to encrypt the Amazon S3 objects. This parameter is required if you choose aws:kms as an encryption type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ExportAssetsToS3_Encryption_KmsKeyArn
-Encryption_Type <ServerSideEncryptionTypes>
The type of server side encryption used for encrypting the objects in Amazon S3.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ExportAssetsToS3_Encryption_Type
-ExportAssetsToS3_AssetDestination <AssetDestinationEntry[]>
The destination for the asset. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ExportAssetsToS3_AssetDestinations
-ExportAssetsToS3_DataSetId <String>
The unique identifier for the data set associated with this export job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ExportAssetsToS3_DataSetId
-ExportAssetsToS3_RevisionId <String>
The unique identifier for the revision associated with this export request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ExportAssetsToS3_RevisionId
-ExportAssetToSignedUrl_AssetId <String>
The unique identifier for the asset that is exported to a signed URL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ExportAssetToSignedUrl_AssetId
-ExportAssetToSignedUrl_DataSetId <String>
The unique identifier for the data set associated with this export job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ExportAssetToSignedUrl_DataSetId
-ExportAssetToSignedUrl_RevisionId <String>
The unique identifier for the revision associated with this export request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ExportAssetToSignedUrl_RevisionId
-ExportRevisionsToS3_DataSetId <String>
The unique identifier for the data set associated with this export job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ExportRevisionsToS3_DataSetId
-ExportRevisionsToS3_RevisionDestination <RevisionDestinationEntry[]>
The destination for the revision. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ExportRevisionsToS3_RevisionDestinations
-Force <SwitchParameter>
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)
-ImportAssetFromApiGatewayApi_ApiDescription <String>
The API description. Markdown supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetFromApiGatewayApi_ApiDescription
-ImportAssetFromApiGatewayApi_ApiId <String>
The API Gateway API ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetFromApiGatewayApi_ApiId
-ImportAssetFromApiGatewayApi_ApiKey <String>
The API Gateway API key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetFromApiGatewayApi_ApiKey
-ImportAssetFromApiGatewayApi_ApiName <String>
The API name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetFromApiGatewayApi_ApiName
-ImportAssetFromApiGatewayApi_ApiSpecificationMd5Hash <String>
The Base64-encoded MD5 hash of the OpenAPI 3.0 JSON API specification file. It is used to ensure the integrity of the file.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetFromApiGatewayApi_ApiSpecificationMd5Hash
-ImportAssetFromApiGatewayApi_DataSetId <String>
The data set ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetFromApiGatewayApi_DataSetId
-ImportAssetFromApiGatewayApi_ProtocolType <ProtocolType>
The protocol type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetFromApiGatewayApi_ProtocolType
-ImportAssetFromApiGatewayApi_RevisionId <String>
The revision ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetFromApiGatewayApi_RevisionId
-ImportAssetFromApiGatewayApi_Stage <String>
The API stage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetFromApiGatewayApi_Stage
-ImportAssetFromSignedUrl_AssetName <String>
The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used as the asset name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetFromSignedUrl_AssetName
-ImportAssetFromSignedUrl_DataSetId <String>
The unique identifier for the data set associated with this import job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetFromSignedUrl_DataSetId
-ImportAssetFromSignedUrl_Md5Hash <String>
The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetFromSignedUrl_Md5Hash
-ImportAssetFromSignedUrl_RevisionId <String>
The unique identifier for the revision associated with this import request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetFromSignedUrl_RevisionId
-ImportAssetsFromLakeFormationTagPolicy_CatalogId <String>
The identifier for the AWS Glue Data Catalog.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetsFromLakeFormationTagPolicy_CatalogId
-ImportAssetsFromLakeFormationTagPolicy_DataSetId <String>
The unique identifier for the data set associated with this import job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetsFromLakeFormationTagPolicy_DataSetId
-ImportAssetsFromLakeFormationTagPolicy_RevisionId <String>
The unique identifier for the revision associated with this import job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetsFromLakeFormationTagPolicy_RevisionId
-ImportAssetsFromLakeFormationTagPolicy_RoleArn <String>
The IAM role's ARN that allows AWS Data Exchange to assume the role and grant and revoke permissions of subscribers to AWS Lake Formation data permissions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetsFromLakeFormationTagPolicy_RoleArn
-ImportAssetsFromRedshiftDataShares_AssetSource <RedshiftDataShareAssetSourceEntry[]>
A list of Amazon Redshift datashare assets. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetsFromRedshiftDataShares_AssetSources
-ImportAssetsFromRedshiftDataShares_DataSetId <String>
The unique identifier for the data set associated with this import job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetsFromRedshiftDataShares_DataSetId
-ImportAssetsFromRedshiftDataShares_RevisionId <String>
The unique identifier for the revision associated with this import job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetsFromRedshiftDataShares_RevisionId
-ImportAssetsFromS3_AssetSource <AssetSourceEntry[]>
Is a list of Amazon S3 bucket and object key pairs. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetsFromS3_AssetSources
-ImportAssetsFromS3_DataSetId <String>
The unique identifier for the data set associated with this import job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetsFromS3_DataSetId
-ImportAssetsFromS3_RevisionId <String>
The unique identifier for the revision associated with this import request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetsFromS3_RevisionId
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataExchange.Model.CreateJobResponse). Specifying the name of a property of type Amazon.DataExchange.Model.CreateJobResponse 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)
-Table_Expression <LFTag[]>
A list of LF-tag conditions that apply to table resources. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetsFromLakeFormationTagPolicy_Table_Expression
-Table_Permission <String[]>
The permissions granted to subscribers on table resources. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDetails_ImportAssetsFromLakeFormationTagPolicy_Table_Permissions
-Type <Type>
The type of job to be created.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)

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

Amazon.DataExchange.Model.CreateJobResponse
This cmdlet returns an Amazon.DataExchange.Model.CreateJobResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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