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) SendBulkEmail API operation.

Syntax

Send-SES2BulkEmail
-Template_Attachment <Attachment[]>
-BulkEmailEntry <BulkEmailEntry[]>
-ConfigurationSetName <String>
-DefaultEmailTag <MessageTag[]>
-EndpointId <String>
-FeedbackForwardingEmailAddress <String>
-FeedbackForwardingEmailAddressIdentityArn <String>
-FromEmailAddress <String>
-FromEmailAddressIdentityArn <String>
-Template_Header <MessageHeader[]>
-TemplateContent_Html <String>
-ReplyToAddress <String[]>
-TemplateContent_Subject <String>
-Template_TemplateArn <String>
-Template_TemplateData <String>
-Template_TemplateName <String>
-TenantName <String>
-TemplateContent_Text <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonSimpleEmailServiceV2Config>

Description

Composes an email message to multiple destinations.

Parameters

-BulkEmailEntry <BulkEmailEntry[]>
The list of bulk email entry objects. 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?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBulkEmailEntries
-ClientConfig <AmazonSimpleEmailServiceV2Config>
Amazon.PowerShell.Cmdlets.SES2.AmazonSimpleEmailServiceV2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfigurationSetName <String>
The name of the configuration set to use when sending the email.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultEmailTag <MessageTag[]>
A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. 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)
AliasesDefaultEmailTags
-EndpointId <String>
The ID of the multi-region endpoint (global-endpoint).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FeedbackForwardingEmailAddress <String>
The address that you want bounce and complaint notifications to be sent to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FeedbackForwardingEmailAddressIdentityArn <String>
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.For more information about sending authorization, see the Amazon SES Developer Guide.
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)
-FromEmailAddress <String>
The email address to use as the "From" address for the email. The address that you specify has to be verified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FromEmailAddressIdentityArn <String>
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.For more information about sending authorization, see the Amazon SES Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReplyToAddress <String[]>
The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply. 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)
AliasesReplyToAddresses
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'BulkEmailEntryResults'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleEmailV2.Model.SendBulkEmailResponse). Specifying the name of a property of type Amazon.SimpleEmailV2.Model.SendBulkEmailResponse 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)
-Template_Attachment <Attachment[]>
The List of attachments to include in your email. All recipients will receive the same attachments. 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)
AliasesDefaultContent_Template_Attachments
-Template_Header <MessageHeader[]>
The list of message headers that will be added to the email 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)
AliasesDefaultContent_Template_Headers
-Template_TemplateArn <String>
The Amazon Resource Name (ARN) of the template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultContent_Template_TemplateArn
-Template_TemplateData <String>
An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultContent_Template_TemplateData
-Template_TemplateName <String>
The name of the template. You will refer to this name when you send email using the SendEmail or SendBulkEmail operations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultContent_Template_TemplateName
-TemplateContent_Html <String>
The HTML body of the email.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultContent_Template_TemplateContent_Html
-TemplateContent_Subject <String>
The subject line of the email.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultContent_Template_TemplateContent_Subject
-TemplateContent_Text <String>
The email body that will be visible to recipients whose email clients do not display HTML.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultContent_Template_TemplateContent_Text
-TenantName <String>
The name of the tenant through which this bulk email will be sent. The email sending operation will only succeed if all referenced resources (identities, configuration sets, and templates) are associated with this tenant.
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

Amazon.SimpleEmailV2.Model.BulkEmailEntryResult or Amazon.SimpleEmailV2.Model.SendBulkEmailResponse
This cmdlet returns a collection of Amazon.SimpleEmailV2.Model.BulkEmailEntryResult objects. The service call response (type Amazon.SimpleEmailV2.Model.SendBulkEmailResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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