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 Amazon Simple Email Service V2 (SES V2) CreateExportJob API operation.

Syntax

New-SES2ExportJob
-ExportDestination_DataFormat <DataFormat>
-Exclude_Destination <String[]>
-Include_Destination <String[]>
-MetricsDataSource_Dimension <Hashtable>
-MessageInsightsDataSource_EndDate <DateTime>
-MetricsDataSource_EndDate <DateTime>
-Exclude_FromEmailAddress <String[]>
-Include_FromEmailAddress <String[]>
-Exclude_Isp <String[]>
-Include_Isp <String[]>
-Exclude_LastDeliveryEvent <String[]>
-Include_LastDeliveryEvent <String[]>
-Exclude_LastEngagementEvent <String[]>
-Include_LastEngagementEvent <String[]>
-MessageInsightsDataSource_MaxResult <Int32>
-MetricsDataSource_Metric <ExportMetric[]>
-MetricsDataSource_Namespace <MetricNamespace>
-ExportDestination_S3Url <String>
-MessageInsightsDataSource_StartDate <DateTime>
-MetricsDataSource_StartDate <DateTime>
-Exclude_Subject <String[]>
-Include_Subject <String[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonSimpleEmailServiceV2Config>

Description

Creates an export job for a data source and destination. You can execute this operation no more than once per second.

Parameters

-ClientConfig <AmazonSimpleEmailServiceV2Config>
Amazon.PowerShell.Cmdlets.SES2.AmazonSimpleEmailServiceV2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Exclude_Destination <String[]>
The recipient's email address. 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)
AliasesExportDataSource_MessageInsightsDataSource_Exclude_Destination
-Exclude_FromEmailAddress <String[]>
The from address used to send the message. 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)
AliasesExportDataSource_MessageInsightsDataSource_Exclude_FromEmailAddress
-Exclude_Isp <String[]>
The recipient's ISP (e.g., Gmail, Yahoo, etc.). 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)
AliasesExportDataSource_MessageInsightsDataSource_Exclude_Isp
-Exclude_LastDeliveryEvent <String[]>
The last delivery-related event for the email, where the ordering is as follows: SEND < BOUNCE < DELIVERY < COMPLAINT. 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)
AliasesExportDataSource_MessageInsightsDataSource_Exclude_LastDeliveryEvent
-Exclude_LastEngagementEvent <String[]>
The last engagement-related event for the email, where the ordering is as follows: OPEN < CLICK. Engagement events are only available if Engagement tracking is enabled. 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)
AliasesExportDataSource_MessageInsightsDataSource_Exclude_LastEngagementEvent
-Exclude_Subject <String[]>
The subject line of the message. 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)
AliasesExportDataSource_MessageInsightsDataSource_Exclude_Subject
-ExportDestination_DataFormat <DataFormat>
The data format of the final export job file, can be one of the following:
  • CSV - A comma-separated values file.
  • JSON - A Json file.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ExportDestination_S3Url <String>
An Amazon S3 pre-signed URL that points to the generated export file.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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)
-Include_Destination <String[]>
The recipient's email address. 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)
AliasesExportDataSource_MessageInsightsDataSource_Include_Destination
-Include_FromEmailAddress <String[]>
The from address used to send the message. 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)
AliasesExportDataSource_MessageInsightsDataSource_Include_FromEmailAddress
-Include_Isp <String[]>
The recipient's ISP (e.g., Gmail, Yahoo, etc.). 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)
AliasesExportDataSource_MessageInsightsDataSource_Include_Isp
-Include_LastDeliveryEvent <String[]>
The last delivery-related event for the email, where the ordering is as follows: SEND < BOUNCE < DELIVERY < COMPLAINT. 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)
AliasesExportDataSource_MessageInsightsDataSource_Include_LastDeliveryEvent
-Include_LastEngagementEvent <String[]>
The last engagement-related event for the email, where the ordering is as follows: OPEN < CLICK. Engagement events are only available if Engagement tracking is enabled. 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)
AliasesExportDataSource_MessageInsightsDataSource_Include_LastEngagementEvent
-Include_Subject <String[]>
The subject line of the message. 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)
AliasesExportDataSource_MessageInsightsDataSource_Include_Subject
-MessageInsightsDataSource_EndDate <DateTime>
Represents the end date for the export interval as a timestamp. The end date is inclusive.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExportDataSource_MessageInsightsDataSource_EndDate
-MessageInsightsDataSource_MaxResult <Int32>
The maximum number of results.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExportDataSource_MessageInsightsDataSource_MaxResults
-MessageInsightsDataSource_StartDate <DateTime>
Represents the start date for the export interval as a timestamp. The start date is inclusive.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExportDataSource_MessageInsightsDataSource_StartDate
-MetricsDataSource_Dimension <Hashtable>
An object that contains a mapping between a MetricDimensionName and MetricDimensionValue to filter metrics by. Must contain a least 1 dimension but no more than 3 unique ones. 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)
AliasesExportDataSource_MetricsDataSource_Dimensions
-MetricsDataSource_EndDate <DateTime>
Represents the end date for the export interval as a timestamp.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExportDataSource_MetricsDataSource_EndDate
-MetricsDataSource_Metric <ExportMetric[]>
A list of ExportMetric objects to export. 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)
AliasesExportDataSource_MetricsDataSource_Metrics
-MetricsDataSource_Namespace <MetricNamespace>
The metrics namespace - e.g., VDM.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExportDataSource_MetricsDataSource_Namespace
-MetricsDataSource_StartDate <DateTime>
Represents the start date for the export interval as a timestamp.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExportDataSource_MetricsDataSource_StartDate
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleEmailV2.Model.CreateExportJobResponse). Specifying the name of a property of type Amazon.SimpleEmailV2.Model.CreateExportJobResponse 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)

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

System.String or Amazon.SimpleEmailV2.Model.CreateExportJobResponse
This cmdlet returns a System.String object. The service call response (type Amazon.SimpleEmailV2.Model.CreateExportJobResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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