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 Pinpoint Email CreateDeliverabilityTestReport API operation.

Syntax

New-PINEDeliverabilityTestReport
-FromEmailAddress <String>
-Html_Charset <String>
-Text_Charset <String>
-Subject_Charset <String>
-Raw_Data <Byte[]>
-Html_Data <String>
-Text_Data <String>
-Subject_Data <String>
-ReportName <String>
-Tag <Tag[]>
-Template_TemplateArn <String>
-Template_TemplateData <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

Parameters

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 that the predictive inbox placement test email was sent from.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Html_Charset <String>
The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Simple_Body_Html_Charset
-Html_Data <String>
The content of the message itself.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Simple_Body_Html_Data
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the FromEmailAddress parameter. The -PassThru parameter is deprecated, use -Select '^FromEmailAddress' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Raw_Data <Byte[]>
The raw email message. The message has to meet the following criteria:
  • The message has to contain a header and a body, separated by one blank line.
  • All of the required header fields must be present in the message.
  • Each part of a multipart MIME message must be formatted properly.
  • Attachments must be in a file format that Amazon Pinpoint supports.
  • The entire message must be Base64 encoded.
  • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
  • The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Raw_Data
-ReportName <String>
A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.PinpointEmail.Model.CreateDeliverabilityTestReportResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.CreateDeliverabilityTestReportResponse 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)
-Subject_Charset <String>
The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Simple_Subject_Charset
-Subject_Data <String>
The content of the message itself.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Simple_Subject_Data
-Tag <Tag[]>
An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Template_TemplateArn <String>
The Amazon Resource Name (ARN) of the template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_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)
AliasesContent_Template_TemplateData
-Text_Charset <String>
The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Simple_Body_Text_Charset
-Text_Data <String>
The content of the message itself.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Simple_Body_Text_Data

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 an Amazon.PinpointEmail.Model.CreateDeliverabilityTestReportResponse object containing multiple properties. The object 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