AWS.Tools.PinpointEmail.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.PinpointEmail</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.PINE.AddPINEResourceTagCmdlet"> <summary> Add one or more tags (keys and values) to a specified resource. A <i>tag</i> is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags. <para> Each tag consists of a required <i>tag key</i> and an associated <i>tag value</i>, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.AddPINEResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.AddPINEResourceTagCmdlet.Tag"> <summary> <para> <para>A list of the tags that you want to add to the resource. A tag consists of a required tag key (<c>Key</c>) and an associated tag value (<c>Value</c>). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.AddPINEResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.AddPINEResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.AddPINEResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEAccountCmdlet"> <summary> Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEAccountCmdlet.Select"> <summary> 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.GetAccountResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.GetAccountResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEBlacklistReportCmdlet"> <summary> Retrieve a list of the blacklists that your dedicated IP addresses appear on. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEBlacklistReportCmdlet.BlacklistItemName"> <summary> <para> <para>A list of IP addresses that you want to retrieve blacklist information about. You can only specify the dedicated IP addresses that you use to send email using Amazon Pinpoint or Amazon SES.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEBlacklistReportCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BlacklistReport'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.GetBlacklistReportsResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.GetBlacklistReportsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEBlacklistReportCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BlacklistItemName parameter. The -PassThru parameter is deprecated, use -Select '^BlacklistItemName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEConfigurationSetCmdlet"> <summary> Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more. <para> In Amazon Pinpoint, <i>configuration sets</i> are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEConfigurationSetCmdlet.ConfigurationSetName"> <summary> <para> <para>The name of the configuration set that you want to obtain more information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEConfigurationSetCmdlet.Select"> <summary> 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.GetConfigurationSetResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.GetConfigurationSetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEConfigurationSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationSetName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationSetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEConfigurationSetEventDestinationCmdlet"> <summary> Retrieve a list of event destinations that are associated with a configuration set. <para> In Amazon Pinpoint, <i>events</i> include message sends, deliveries, opens, clicks, bounces, and complaints. <i>Event destinations</i> are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEConfigurationSetEventDestinationCmdlet.ConfigurationSetName"> <summary> <para> <para>The name of the configuration set that contains the event destination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEConfigurationSetEventDestinationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventDestinations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.GetConfigurationSetEventDestinationsResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.GetConfigurationSetEventDestinationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEConfigurationSetEventDestinationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationSetName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationSetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEConfigurationSetListCmdlet"> <summary> List all of the configuration sets associated with your Amazon Pinpoint account in the current region. <para> In Amazon Pinpoint, <i>configuration sets</i> are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEConfigurationSetListCmdlet.NextToken"> <summary> <para> <para>A token returned from a previous call to <c>ListConfigurationSets</c> to indicate the position in the list of configuration sets.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEConfigurationSetListCmdlet.PageSize"> <summary> <para> <para>The number of results to show in a single call to <c>ListConfigurationSets</c>. If the number of results is larger than the number you specified in this parameter, then the response includes a <c>NextToken</c> element, which you can use to obtain additional results.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEConfigurationSetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConfigurationSets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.ListConfigurationSetsResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.ListConfigurationSetsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEConfigurationSetListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEDedicatedIpCmdlet"> <summary> Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDedicatedIpCmdlet.Ip"> <summary> <para> <para>The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your Amazon Pinpoint account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDedicatedIpCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DedicatedIp'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.GetDedicatedIpResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.GetDedicatedIpResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDedicatedIpCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Ip parameter. The -PassThru parameter is deprecated, use -Select '^Ip' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEDedicatedIpListCmdlet"> <summary> List the dedicated IP addresses that are associated with your Amazon Pinpoint account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDedicatedIpListCmdlet.PoolName"> <summary> <para> <para>The name of the IP pool that the dedicated IP address is associated with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDedicatedIpListCmdlet.NextToken"> <summary> <para> <para>A token returned from a previous call to <c>GetDedicatedIps</c> to indicate the position of the dedicated IP pool in the list of IP pools.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDedicatedIpListCmdlet.PageSize"> <summary> <para> <para>The number of results to show in a single call to <c>GetDedicatedIpsRequest</c>. If the number of results is larger than the number you specified in this parameter, then the response includes a <c>NextToken</c> element, which you can use to obtain additional results.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDedicatedIpListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DedicatedIps'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.GetDedicatedIpsResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.GetDedicatedIpsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDedicatedIpListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PoolName parameter. The -PassThru parameter is deprecated, use -Select '^PoolName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDedicatedIpListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEDedicatedIpPoolListCmdlet"> <summary> List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDedicatedIpPoolListCmdlet.NextToken"> <summary> <para> <para>A token returned from a previous call to <c>ListDedicatedIpPools</c> to indicate the position in the list of dedicated IP pools.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDedicatedIpPoolListCmdlet.PageSize"> <summary> <para> <para>The number of results to show in a single call to <c>ListDedicatedIpPools</c>. If the number of results is larger than the number you specified in this parameter, then the response includes a <c>NextToken</c> element, which you can use to obtain additional results.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDedicatedIpPoolListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DedicatedIpPools'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.ListDedicatedIpPoolsResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.ListDedicatedIpPoolsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDedicatedIpPoolListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEDeliverabilityDashboardOptionCmdlet"> <summary> Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests. <para> When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see <a href="http://aws.amazon.com/pinpoint/pricing/">Amazon Pinpoint Pricing</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDeliverabilityDashboardOptionCmdlet.Select"> <summary> 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.GetDeliverabilityDashboardOptionsResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.GetDeliverabilityDashboardOptionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEDeliverabilityTestReportCmdlet"> <summary> Retrieve the results of a predictive inbox placement test. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDeliverabilityTestReportCmdlet.ReportId"> <summary> <para> <para>A unique string that identifies the predictive inbox placement test.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDeliverabilityTestReportCmdlet.Select"> <summary> 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.GetDeliverabilityTestReportResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.GetDeliverabilityTestReportResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDeliverabilityTestReportCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReportId parameter. The -PassThru parameter is deprecated, use -Select '^ReportId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEDeliverabilityTestReportListCmdlet"> <summary> Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the <c>GetDeliverabilityTestReport</c> operation to view the results.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDeliverabilityTestReportListCmdlet.NextToken"> <summary> <para> <para>A token returned from a previous call to <c>ListDeliverabilityTestReports</c> to indicate the position in the list of predictive inbox placement tests.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDeliverabilityTestReportListCmdlet.PageSize"> <summary> <para> <para>The number of results to show in a single call to <c>ListDeliverabilityTestReports</c>. If the number of results is larger than the number you specified in this parameter, then the response includes a <c>NextToken</c> element, which you can use to obtain additional results.</para><para>The value you specify has to be at least 0, and can be no more than 1000.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDeliverabilityTestReportListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeliverabilityTestReports'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.ListDeliverabilityTestReportsResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.ListDeliverabilityTestReportsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDeliverabilityTestReportListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainDeliverabilityCampaignCmdlet"> <summary> Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (<c>PutDeliverabilityDashboardOption</c> operation). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainDeliverabilityCampaignCmdlet.CampaignId"> <summary> <para> <para>The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainDeliverabilityCampaignCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainDeliverabilityCampaign'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.GetDomainDeliverabilityCampaignResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.GetDomainDeliverabilityCampaignResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainDeliverabilityCampaignCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CampaignId parameter. The -PassThru parameter is deprecated, use -Select '^CampaignId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainDeliverabilityCampaignListCmdlet"> <summary> Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (<c>PutDeliverabilityDashboardOption</c> operation) for the domain.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainDeliverabilityCampaignListCmdlet.EndDate"> <summary> <para> <para>The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the <c>StartDate</c> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainDeliverabilityCampaignListCmdlet.StartDate"> <summary> <para> <para>The first day, in Unix time format, that you want to obtain deliverability data for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainDeliverabilityCampaignListCmdlet.SubscribedDomain"> <summary> <para> <para>The domain to obtain deliverability data for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainDeliverabilityCampaignListCmdlet.NextToken"> <summary> <para> <para>A token that’s returned from a previous call to the <c>ListDomainDeliverabilityCampaigns</c> operation. This token indicates the position of a campaign in the list of campaigns.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainDeliverabilityCampaignListCmdlet.PageSize"> <summary> <para> <para>The maximum number of results to include in response to a single call to the <c>ListDomainDeliverabilityCampaigns</c> operation. If the number of results is larger than the number that you specify in this parameter, the response includes a <c>NextToken</c> element, which you can use to obtain additional results.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainDeliverabilityCampaignListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainDeliverabilityCampaigns'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.ListDomainDeliverabilityCampaignsResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.ListDomainDeliverabilityCampaignsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainDeliverabilityCampaignListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SubscribedDomain parameter. The -PassThru parameter is deprecated, use -Select '^SubscribedDomain' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainDeliverabilityCampaignListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainStatisticsReportCmdlet"> <summary> Retrieve inbox placement and engagement rates for the domains that you use to send email. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainStatisticsReportCmdlet.Domain"> <summary> <para> <para>The domain that you want to obtain deliverability metrics for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainStatisticsReportCmdlet.EndDate"> <summary> <para> <para>The last day (in Unix time) that you want to obtain domain deliverability metrics for. The <c>EndDate</c> that you specify has to be less than or equal to 30 days after the <c>StartDate</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainStatisticsReportCmdlet.StartDate"> <summary> <para> <para>The first day (in Unix time) that you want to obtain domain deliverability metrics for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainStatisticsReportCmdlet.Select"> <summary> 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.GetDomainStatisticsReportResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.GetDomainStatisticsReportResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEDomainStatisticsReportCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Domain parameter. The -PassThru parameter is deprecated, use -Select '^Domain' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEEmailIdentityCmdlet"> <summary> Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEEmailIdentityCmdlet.EmailIdentity"> <summary> <para> <para>The email identity that you want to retrieve details for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEEmailIdentityCmdlet.Select"> <summary> 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.GetEmailIdentityResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.GetEmailIdentityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEEmailIdentityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EmailIdentity parameter. The -PassThru parameter is deprecated, use -Select '^EmailIdentity' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEEmailIdentityListCmdlet"> <summary> Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEEmailIdentityListCmdlet.NextToken"> <summary> <para> <para>A token returned from a previous call to <c>ListEmailIdentities</c> to indicate the position in the list of identities.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEEmailIdentityListCmdlet.PageSize"> <summary> <para> <para>The number of results to show in a single call to <c>ListEmailIdentities</c>. If the number of results is larger than the number you specified in this parameter, then the response includes a <c>NextToken</c> element, which you can use to obtain additional results.</para><para>The value you specify has to be at least 0, and can be no more than 1000.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEEmailIdentityListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EmailIdentities'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.ListEmailIdentitiesResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.ListEmailIdentitiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEEmailIdentityListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.GetPINEResourceTagCmdlet"> <summary> Retrieve a list of the tags (keys and values) that are associated with a specified resource. A <i>tag</i> is a label that you optionally define and associate with a resource in Amazon Pinpoint. Each tag consists of a required <i>tag key</i> and an optional associated <i>tag value</i>. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to retrieve tag information for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.GetPINEResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetCmdlet"> <summary> Create a configuration set. <i>Configuration sets</i> are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetCmdlet.ConfigurationSetName"> <summary> <para> <para>The name of the configuration set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetCmdlet.TrackingOptions_CustomRedirectDomain"> <summary> <para> <para>The domain that you want to use for tracking open and click events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetCmdlet.ReputationOptions_LastFreshStart"> <summary> <para> <para>The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetCmdlet.ReputationOptions_ReputationMetricsEnabled"> <summary> <para> <para>If <c>true</c>, tracking of reputation metrics is enabled for the configuration set. If <c>false</c>, tracking of reputation metrics is disabled for the configuration set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetCmdlet.SendingOptions_SendingEnabled"> <summary> <para> <para>If <c>true</c>, email sending is enabled for the configuration set. If <c>false</c>, email sending is disabled for the configuration set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetCmdlet.DeliveryOptions_SendingPoolName"> <summary> <para> <para>The name of the dedicated IP pool that you want to associate with the configuration set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetCmdlet.Tag"> <summary> <para> <para>An array of objects that define the tags (keys and values) that you want to associate with the configuration set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetCmdlet.DeliveryOptions_TlsPolicy"> <summary> <para> <para>Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is <c>Require</c>, messages are only delivered if a TLS connection can be established. If the value is <c>Optional</c>, messages can be delivered in plain text if a TLS connection can't be established.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.CreateConfigurationSetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationSetName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationSetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetEventDestinationCmdlet"> <summary> Create an event destination. In Amazon Pinpoint, <i>events</i> include message sends, deliveries, opens, clicks, bounces, and complaints. <i>Event destinations</i> are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. <para> A single configuration set can include more than one event destination. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetEventDestinationCmdlet.PinpointDestination_ApplicationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetEventDestinationCmdlet.ConfigurationSetName"> <summary> <para> <para>The name of the configuration set that you want to add an event destination to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetEventDestinationCmdlet.KinesisFirehoseDestination_DeliveryStreamArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetEventDestinationCmdlet.CloudWatchDestination_DimensionConfiguration"> <summary> <para> <para>An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetEventDestinationCmdlet.EventDestination_Enabled"> <summary> <para> <para>If <c>true</c>, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this <c>EventDestinationDefinition</c>.</para><para>If <c>false</c>, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetEventDestinationCmdlet.EventDestinationName"> <summary> <para> <para>A name that identifies the event destination within the configuration set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetEventDestinationCmdlet.KinesisFirehoseDestination_IamRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetEventDestinationCmdlet.EventDestination_MatchingEventType"> <summary> <para> <para>An array that specifies which events Amazon Pinpoint should send to the destinations in this <c>EventDestinationDefinition</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetEventDestinationCmdlet.SnsDestination_TopicArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetEventDestinationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.CreateConfigurationSetEventDestinationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetEventDestinationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventDestinationName parameter. The -PassThru parameter is deprecated, use -Select '^EventDestinationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEConfigurationSetEventDestinationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.NewPINEDedicatedIpPoolCmdlet"> <summary> Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDedicatedIpPoolCmdlet.PoolName"> <summary> <para> <para>The name of the dedicated IP pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDedicatedIpPoolCmdlet.Tag"> <summary> <para> <para>An object that defines the tags (keys and values) that you want to associate with the pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDedicatedIpPoolCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.CreateDedicatedIpPoolResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDedicatedIpPoolCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PoolName parameter. The -PassThru parameter is deprecated, use -Select '^PoolName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDedicatedIpPoolCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.NewPINEDeliverabilityTestReportCmdlet"> <summary> 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 <c>GetDeliverabilityTestReport</c> operation to view the results of the test. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDeliverabilityTestReportCmdlet.Html_Charset"> <summary> <para> <para>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 <c>UTF-8</c>, <c>ISO-8859-1</c>, or <c>Shift_JIS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDeliverabilityTestReportCmdlet.Text_Charset"> <summary> <para> <para>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 <c>UTF-8</c>, <c>ISO-8859-1</c>, or <c>Shift_JIS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDeliverabilityTestReportCmdlet.Subject_Charset"> <summary> <para> <para>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 <c>UTF-8</c>, <c>ISO-8859-1</c>, or <c>Shift_JIS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDeliverabilityTestReportCmdlet.Raw_Data"> <summary> <para> <para>The raw email message. The message has to meet the following criteria:</para><ul><li><para>The message has to contain a header and a body, separated by one blank line.</para></li><li><para>All of the required header fields must be present in the message.</para></li><li><para>Each part of a multipart MIME message must be formatted properly.</para></li><li><para>Attachments must be in a file format that Amazon Pinpoint supports. </para></li><li><para>The entire message must be Base64 encoded.</para></li><li><para>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.</para></li><li><para>The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in <a href="https://tools.ietf.org/html/rfc5321">RFC 5321</a>.</para></li></ul> </para> <para>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.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDeliverabilityTestReportCmdlet.Html_Data"> <summary> <para> <para>The content of the message itself.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDeliverabilityTestReportCmdlet.Text_Data"> <summary> <para> <para>The content of the message itself.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDeliverabilityTestReportCmdlet.Subject_Data"> <summary> <para> <para>The content of the message itself.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDeliverabilityTestReportCmdlet.FromEmailAddress"> <summary> <para> <para>The email address that the predictive inbox placement test email was sent from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDeliverabilityTestReportCmdlet.ReportName"> <summary> <para> <para>A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDeliverabilityTestReportCmdlet.Tag"> <summary> <para> <para>An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDeliverabilityTestReportCmdlet.Template_TemplateArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDeliverabilityTestReportCmdlet.Template_TemplateData"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDeliverabilityTestReportCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDeliverabilityTestReportCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEDeliverabilityTestReportCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.NewPINEEmailIdentityCmdlet"> <summary> Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address. <para> When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. </para><para> When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEEmailIdentityCmdlet.EmailIdentity"> <summary> <para> <para>The email address or domain that you want to verify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEEmailIdentityCmdlet.Tag"> <summary> <para> <para>An array of objects that define the tags (keys and values) that you want to associate with the email identity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEEmailIdentityCmdlet.Select"> <summary> 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.CreateEmailIdentityResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.CreateEmailIdentityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEEmailIdentityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EmailIdentity parameter. The -PassThru parameter is deprecated, use -Select '^EmailIdentity' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.NewPINEEmailIdentityCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.RemovePINEConfigurationSetCmdlet"> <summary> Delete an existing configuration set. <para> In Amazon Pinpoint, <i>configuration sets</i> are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEConfigurationSetCmdlet.ConfigurationSetName"> <summary> <para> <para>The name of the configuration set that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEConfigurationSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.DeleteConfigurationSetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEConfigurationSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationSetName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationSetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEConfigurationSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.RemovePINEConfigurationSetEventDestinationCmdlet"> <summary> Delete an event destination. <para> In Amazon Pinpoint, <i>events</i> include message sends, deliveries, opens, clicks, bounces, and complaints. <i>Event destinations</i> are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEConfigurationSetEventDestinationCmdlet.ConfigurationSetName"> <summary> <para> <para>The name of the configuration set that contains the event destination that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEConfigurationSetEventDestinationCmdlet.EventDestinationName"> <summary> <para> <para>The name of the event destination that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEConfigurationSetEventDestinationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.DeleteConfigurationSetEventDestinationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEConfigurationSetEventDestinationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventDestinationName parameter. The -PassThru parameter is deprecated, use -Select '^EventDestinationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEConfigurationSetEventDestinationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.RemovePINEDedicatedIpPoolCmdlet"> <summary> Delete a dedicated IP pool. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEDedicatedIpPoolCmdlet.PoolName"> <summary> <para> <para>The name of the dedicated IP pool that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEDedicatedIpPoolCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.DeleteDedicatedIpPoolResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEDedicatedIpPoolCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PoolName parameter. The -PassThru parameter is deprecated, use -Select '^PoolName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEDedicatedIpPoolCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.RemovePINEEmailIdentityCmdlet"> <summary> Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEEmailIdentityCmdlet.EmailIdentity"> <summary> <para> <para>The identity (that is, the email address or domain) that you want to delete from your Amazon Pinpoint account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEEmailIdentityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.DeleteEmailIdentityResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEEmailIdentityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EmailIdentity parameter. The -PassThru parameter is deprecated, use -Select '^EmailIdentity' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEEmailIdentityCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.RemovePINEResourceTagCmdlet"> <summary> Remove one or more tags (keys and values) from a specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to remove one or more tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEResourceTagCmdlet.TagKey"> <summary> <para> <para>The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.</para><para>To remove more than one tag from the resource, append the <c>TagKeys</c> parameter and argument for each additional tag to remove, separated by an ampersand. For example: <c>/v1/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.RemovePINEResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet"> <summary> Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages: <ul><li><para><b>Simple</b> – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon Pinpoint assembles the message for you. </para></li><li><para><b>Raw</b> – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.Destination_BccAddress"> <summary> <para> <para>An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.Destination_CcAddress"> <summary> <para> <para>An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.Html_Charset"> <summary> <para> <para>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 <c>UTF-8</c>, <c>ISO-8859-1</c>, or <c>Shift_JIS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.Text_Charset"> <summary> <para> <para>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 <c>UTF-8</c>, <c>ISO-8859-1</c>, or <c>Shift_JIS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.Subject_Charset"> <summary> <para> <para>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 <c>UTF-8</c>, <c>ISO-8859-1</c>, or <c>Shift_JIS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.ConfigurationSetName"> <summary> <para> <para>The name of the configuration set that you want to use when sending the email.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.Raw_Data"> <summary> <para> <para>The raw email message. The message has to meet the following criteria:</para><ul><li><para>The message has to contain a header and a body, separated by one blank line.</para></li><li><para>All of the required header fields must be present in the message.</para></li><li><para>Each part of a multipart MIME message must be formatted properly.</para></li><li><para>Attachments must be in a file format that Amazon Pinpoint supports. </para></li><li><para>The entire message must be Base64 encoded.</para></li><li><para>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.</para></li><li><para>The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in <a href="https://tools.ietf.org/html/rfc5321">RFC 5321</a>.</para></li></ul> </para> <para>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.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.Html_Data"> <summary> <para> <para>The content of the message itself.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.Text_Data"> <summary> <para> <para>The content of the message itself.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.Subject_Data"> <summary> <para> <para>The content of the message itself.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.EmailTag"> <summary> <para> <para>A list of tags, in the form of name/value pairs, to apply to an email that you send using the <c>SendEmail</c> operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.FeedbackForwardingEmailAddress"> <summary> <para> <para>The address that Amazon Pinpoint should send bounce and complaint notifications to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.FromEmailAddress"> <summary> <para> <para>The email address that you want to use as the "From" address for the email. The address that you specify has to be verified. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.ReplyToAddress"> <summary> <para> <para>The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.Template_TemplateArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.Template_TemplateData"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.Destination_ToAddress"> <summary> <para> <para>An array that contains the email addresses of the "To" recipients for the email.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.SendEmailResponse). Specifying the name of a property of type Amazon.PinpointEmail.Model.SendEmailResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationSetName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationSetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.SendPINEEmailCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.UpdatePINEConfigurationSetEventDestinationCmdlet"> <summary> Update the configuration of an event destination for a configuration set. <para> In Amazon Pinpoint, <i>events</i> include message sends, deliveries, opens, clicks, bounces, and complaints. <i>Event destinations</i> are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.UpdatePINEConfigurationSetEventDestinationCmdlet.PinpointDestination_ApplicationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.UpdatePINEConfigurationSetEventDestinationCmdlet.ConfigurationSetName"> <summary> <para> <para>The name of the configuration set that contains the event destination that you want to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.UpdatePINEConfigurationSetEventDestinationCmdlet.KinesisFirehoseDestination_DeliveryStreamArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.UpdatePINEConfigurationSetEventDestinationCmdlet.CloudWatchDestination_DimensionConfiguration"> <summary> <para> <para>An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.UpdatePINEConfigurationSetEventDestinationCmdlet.EventDestination_Enabled"> <summary> <para> <para>If <c>true</c>, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this <c>EventDestinationDefinition</c>.</para><para>If <c>false</c>, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.UpdatePINEConfigurationSetEventDestinationCmdlet.EventDestinationName"> <summary> <para> <para>The name of the event destination that you want to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.UpdatePINEConfigurationSetEventDestinationCmdlet.KinesisFirehoseDestination_IamRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.UpdatePINEConfigurationSetEventDestinationCmdlet.EventDestination_MatchingEventType"> <summary> <para> <para>An array that specifies which events Amazon Pinpoint should send to the destinations in this <c>EventDestinationDefinition</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.UpdatePINEConfigurationSetEventDestinationCmdlet.SnsDestination_TopicArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.UpdatePINEConfigurationSetEventDestinationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.UpdateConfigurationSetEventDestinationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.UpdatePINEConfigurationSetEventDestinationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventDestinationName parameter. The -PassThru parameter is deprecated, use -Select '^EventDestinationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.UpdatePINEConfigurationSetEventDestinationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.WritePINEAccountDedicatedIpWarmupAttributeCmdlet"> <summary> Enable or disable the automatic warm-up feature for dedicated IP addresses. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEAccountDedicatedIpWarmupAttributeCmdlet.AutoWarmupEnabled"> <summary> <para> <para>Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon Pinpoint account in the current AWS Region. Set to <c>true</c> to enable the automatic warm-up feature, or set to <c>false</c> to disable it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEAccountDedicatedIpWarmupAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.PutAccountDedicatedIpWarmupAttributesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEAccountDedicatedIpWarmupAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AutoWarmupEnabled parameter. The -PassThru parameter is deprecated, use -Select '^AutoWarmupEnabled' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEAccountDedicatedIpWarmupAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.WritePINEAccountSendingAttributeCmdlet"> <summary> Enable or disable the ability of your account to send email. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEAccountSendingAttributeCmdlet.SendingEnabled"> <summary> <para> <para>Enables or disables your account's ability to send email. Set to <c>true</c> to enable email sending, or set to <c>false</c> to disable email sending.</para><note><para>If AWS paused your account's ability to send email, you can't use this operation to resume your account's ability to send email.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEAccountSendingAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.PutAccountSendingAttributesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEAccountSendingAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SendingEnabled parameter. The -PassThru parameter is deprecated, use -Select '^SendingEnabled' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEAccountSendingAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetDeliveryOptionCmdlet"> <summary> Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetDeliveryOptionCmdlet.ConfigurationSetName"> <summary> <para> <para>The name of the configuration set that you want to associate with a dedicated IP pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetDeliveryOptionCmdlet.SendingPoolName"> <summary> <para> <para>The name of the dedicated IP pool that you want to associate with the configuration set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetDeliveryOptionCmdlet.TlsPolicy"> <summary> <para> <para>Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is <c>Require</c>, messages are only delivered if a TLS connection can be established. If the value is <c>Optional</c>, messages can be delivered in plain text if a TLS connection can't be established.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetDeliveryOptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.PutConfigurationSetDeliveryOptionsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetDeliveryOptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationSetName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationSetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetDeliveryOptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetReputationOptionCmdlet"> <summary> Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetReputationOptionCmdlet.ConfigurationSetName"> <summary> <para> <para>The name of the configuration set that you want to enable or disable reputation metric tracking for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetReputationOptionCmdlet.ReputationMetricsEnabled"> <summary> <para> <para>If <c>true</c>, tracking of reputation metrics is enabled for the configuration set. If <c>false</c>, tracking of reputation metrics is disabled for the configuration set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetReputationOptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.PutConfigurationSetReputationOptionsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetReputationOptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationSetName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationSetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetReputationOptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetSendingOptionCmdlet"> <summary> Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetSendingOptionCmdlet.ConfigurationSetName"> <summary> <para> <para>The name of the configuration set that you want to enable or disable email sending for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetSendingOptionCmdlet.SendingEnabled"> <summary> <para> <para>If <c>true</c>, email sending is enabled for the configuration set. If <c>false</c>, email sending is disabled for the configuration set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetSendingOptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.PutConfigurationSetSendingOptionsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetSendingOptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationSetName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationSetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetSendingOptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetTrackingOptionCmdlet"> <summary> Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetTrackingOptionCmdlet.ConfigurationSetName"> <summary> <para> <para>The name of the configuration set that you want to add a custom tracking domain to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetTrackingOptionCmdlet.CustomRedirectDomain"> <summary> <para> <para>The domain that you want to use to track open and click events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetTrackingOptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.PutConfigurationSetTrackingOptionsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetTrackingOptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationSetName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationSetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEConfigurationSetTrackingOptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.WritePINEDedicatedIpInPoolCmdlet"> <summary> Move a dedicated IP address to an existing dedicated IP pool. <note><para> The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account. </para><para> The dedicated IP pool you specify must already exist. You can create a new pool by using the <c>CreateDedicatedIpPool</c> operation. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEDedicatedIpInPoolCmdlet.DestinationPoolName"> <summary> <para> <para>The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEDedicatedIpInPoolCmdlet.Ip"> <summary> <para> <para>The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that's associated with your Amazon Pinpoint account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEDedicatedIpInPoolCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.PutDedicatedIpInPoolResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEDedicatedIpInPoolCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Ip parameter. The -PassThru parameter is deprecated, use -Select '^Ip' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEDedicatedIpInPoolCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <!-- Badly formed XML comment ignored for member "T:Amazon.PowerShell.Cmdlets.PINE.WritePINEDedicatedIpWarmupAttributeCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEDedicatedIpWarmupAttributeCmdlet.Ip"> <summary> <para> <para>The dedicated IP address that you want to update the warm-up attributes for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEDedicatedIpWarmupAttributeCmdlet.WarmupPercentage"> <summary> <para> <para>The warm-up percentage that you want to associate with the dedicated IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEDedicatedIpWarmupAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.PutDedicatedIpWarmupAttributesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEDedicatedIpWarmupAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Ip parameter. The -PassThru parameter is deprecated, use -Select '^Ip' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEDedicatedIpWarmupAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.WritePINEDeliverabilityDashboardOptionCmdlet"> <summary> Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests. <para> When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see <a href="http://aws.amazon.com/pinpoint/pricing/">Amazon Pinpoint Pricing</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEDeliverabilityDashboardOptionCmdlet.DashboardEnabled"> <summary> <para> <para>Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account. To enable the dashboard, set this value to <c>true</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEDeliverabilityDashboardOptionCmdlet.SubscribedDomain"> <summary> <para> <para>An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEDeliverabilityDashboardOptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.PutDeliverabilityDashboardOptionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEDeliverabilityDashboardOptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DashboardEnabled parameter. The -PassThru parameter is deprecated, use -Select '^DashboardEnabled' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEDeliverabilityDashboardOptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityDkimAttributeCmdlet"> <summary> Used to enable or disable DKIM authentication for an email identity. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityDkimAttributeCmdlet.EmailIdentity"> <summary> <para> <para>The email identity that you want to change the DKIM settings for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityDkimAttributeCmdlet.SigningEnabled"> <summary> <para> <para>Sets the DKIM signing configuration for the identity.</para><para>When you set this value <c>true</c>, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. When you set this value to <c>false</c>, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityDkimAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.PutEmailIdentityDkimAttributesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityDkimAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EmailIdentity parameter. The -PassThru parameter is deprecated, use -Select '^EmailIdentity' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityDkimAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityFeedbackAttributeCmdlet"> <summary> Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event. <para> When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email. </para><para> When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityFeedbackAttributeCmdlet.EmailForwardingEnabled"> <summary> <para> <para>Sets the feedback forwarding configuration for the identity.</para><para>If the value is <c>true</c>, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.</para><para>When you set this value to <c>false</c>, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityFeedbackAttributeCmdlet.EmailIdentity"> <summary> <para> <para>The email identity that you want to configure bounce and complaint feedback forwarding for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityFeedbackAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.PutEmailIdentityFeedbackAttributesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityFeedbackAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EmailIdentity parameter. The -PassThru parameter is deprecated, use -Select '^EmailIdentity' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityFeedbackAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityMailFromAttributeCmdlet"> <summary> Used to enable or disable the custom Mail-From domain configuration for an email identity. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityMailFromAttributeCmdlet.BehaviorOnMxFailure"> <summary> <para> <para>The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. When you set this value to <c>UseDefaultValue</c>, Amazon Pinpoint uses <i>amazonses.com</i> as the MAIL FROM domain. When you set this value to <c>RejectMessage</c>, Amazon Pinpoint returns a <c>MailFromDomainNotVerified</c> error, and doesn't attempt to deliver the email.</para><para>These behaviors are taken when the custom MAIL FROM domain configuration is in the <c>Pending</c>, <c>Failed</c>, and <c>TemporaryFailure</c> states.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityMailFromAttributeCmdlet.EmailIdentity"> <summary> <para> <para>The verified email identity that you want to set up the custom MAIL FROM domain for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityMailFromAttributeCmdlet.MailFromDomain"> <summary> <para> <para> The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:</para><ul><li><para>It has to be a subdomain of the verified identity.</para></li><li><para>It can't be used to receive email.</para></li><li><para>It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityMailFromAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.PutEmailIdentityMailFromAttributesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityMailFromAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EmailIdentity parameter. The -PassThru parameter is deprecated, use -Select '^EmailIdentity' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PINE.WritePINEEmailIdentityMailFromAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |