AWS.Tools.Pinpoint.dll-Help.xml
|
<helpItems schema="maml">
<command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Add-PINResourceTag</name> <description> <para>Calls the Amazon Pinpoint TagResource API operation.</para> </description> <verb>Add</verb> <noun>PINResourceTag</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds one or more tags (keys and values) to an application, campaign, message template, or segment. </para> </description> <syntax> <syntaxItem> <name>Add-PINResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceArn</name> <description> <para>The Amazon Resource Name (ARN) of the application, campaign, message template, or segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagsModel_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each project, campaign, message template, or segment can have a maximum of 50 tags. Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceArn</name> <description> <para>The Amazon Resource Name (ARN) of the application, campaign, message template, or segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagsModel_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each project, campaign, message template, or segment can have a maximum of 50 tags. Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ResourceArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Pinpoint.Model.TagResourceResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Add-PINResourceTag.html&tocid=Add-PINResourceTag</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Confirm-PINPhoneNumber</name> <description> <para>Calls the Amazon Pinpoint PhoneNumberValidate API operation.</para> </description> <verb>Confirm</verb> <noun>PINPhoneNumber</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about a phone number. </para> </description> <syntax> <syntaxItem> <name>Confirm-PINPhoneNumber</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PhoneNumber</name> <description> <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.NumberValidateRequest</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PhoneNumber</name> <description> <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.NumberValidateRequest</parameterValue> <type> <name>Amazon.Pinpoint.Model.NumberValidateRequest</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.NumberValidateResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.NumberValidateResponse object. The service call response (type Amazon.Pinpoint.Model.PhoneNumberValidateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Confirm-PINPhoneNumber.html&tocid=Confirm-PINPhoneNumber</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINAdmChannel</name> <description> <para>Calls the Amazon Pinpoint GetAdmChannel API operation.</para> </description> <verb>Get</verb> <noun>PINAdmChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status and settings of the ADM channel for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINAdmChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ADMChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ADMChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetAdmChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINAdmChannel.html&tocid=Get-PINAdmChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINApnsChannel</name> <description> <para>Calls the Amazon Pinpoint GetApnsChannel API operation.</para> </description> <verb>Get</verb> <noun>PINApnsChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status and settings of the APNs channel for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINApnsChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.APNSChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetApnsChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINApnsChannel.html&tocid=Get-PINApnsChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINApnsSandboxChannel</name> <description> <para>Calls the Amazon Pinpoint GetApnsSandboxChannel API operation.</para> </description> <verb>Get</verb> <noun>PINApnsSandboxChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status and settings of the APNs sandbox channel for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINApnsSandboxChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSSandboxChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.APNSSandboxChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetApnsSandboxChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINApnsSandboxChannel.html&tocid=Get-PINApnsSandboxChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINApnsVoipChannel</name> <description> <para>Calls the Amazon Pinpoint GetApnsVoipChannel API operation.</para> </description> <verb>Get</verb> <noun>PINApnsVoipChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status and settings of the APNs VoIP channel for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINApnsVoipChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSVoipChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.APNSVoipChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetApnsVoipChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINApnsVoipChannel.html&tocid=Get-PINApnsVoipChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINApnsVoipSandboxChannel</name> <description> <para>Calls the Amazon Pinpoint GetApnsVoipSandboxChannel API operation.</para> </description> <verb>Get</verb> <noun>PINApnsVoipSandboxChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINApnsVoipSandboxChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSVoipSandboxChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.APNSVoipSandboxChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetApnsVoipSandboxChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINApnsVoipSandboxChannel.html&tocid=Get-PINApnsVoipSandboxChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINApp</name> <description> <para>Calls the Amazon Pinpoint GetApp API operation.</para> </description> <verb>Get</verb> <noun>PINApp</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINApp</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ApplicationResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ApplicationResponse object. The service call response (type Amazon.Pinpoint.Model.GetAppResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINApp.html&tocid=Get-PINApp</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINApplicationDateRangeKpi</name> <description> <para>Calls the Amazon Pinpoint GetApplicationDateRangeKpi API operation.</para> </description> <verb>Get</verb> <noun>PINApplicationDateRangeKpi</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves (queries) pre-aggregated data for a standard metric that applies to an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINApplicationDateRangeKpi</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime</name> <description> <para>The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-19T00:00:00Z for July 19, 2019 and 2019-07-19T20:00:00Z for 8:00 PM July 19, 2019. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KpiName</name> <description> <para>The name of the metric, also referred to as a <i>key performance indicator (KPI)</i>, to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the <a href="developerguide.html">Amazon Pinpoint Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartTime</name> <description> <para>The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-15T00:00:00Z for July 15, 2019 and 2019-07-15T16:00:00Z for 4:00 PM July 15, 2019. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime</name> <description> <para>The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-19T00:00:00Z for July 19, 2019 and 2019-07-19T20:00:00Z for 8:00 PM July 19, 2019. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KpiName</name> <description> <para>The name of the metric, also referred to as a <i>key performance indicator (KPI)</i>, to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the <a href="developerguide.html">Amazon Pinpoint Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartTime</name> <description> <para>The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-15T00:00:00Z for July 15, 2019 and 2019-07-15T16:00:00Z for 4:00 PM July 15, 2019. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ApplicationDateRangeKpiResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ApplicationDateRangeKpiResponse object. The service call response (type Amazon.Pinpoint.Model.GetApplicationDateRangeKpiResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINApplicationDateRangeKpi.html&tocid=Get-PINApplicationDateRangeKpi</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINApplicationSettingList</name> <description> <para>Calls the Amazon Pinpoint GetApplicationSettings API operation.</para> </description> <verb>Get</verb> <noun>PINApplicationSettingList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the settings for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINApplicationSettingList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ApplicationSettingsResource</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ApplicationSettingsResource object. The service call response (type Amazon.Pinpoint.Model.GetApplicationSettingsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINApplicationSettingList.html&tocid=Get-PINApplicationSettingList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINAppList</name> <description> <para>Calls the Amazon Pinpoint GetApps API operation.</para> </description> <verb>Get</verb> <noun>PINAppList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about all of your applications. </para> </description> <syntax> <syntaxItem> <name>Get-PINAppList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ApplicationsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ApplicationsResponse object. The service call response (type Amazon.Pinpoint.Model.GetAppsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINAppList.html&tocid=Get-PINAppList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINBaiduChannel</name> <description> <para>Calls the Amazon Pinpoint GetBaiduChannel API operation.</para> </description> <verb>Get</verb> <noun>PINBaiduChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status and settings of the Baidu channel for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINBaiduChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.BaiduChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.BaiduChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetBaiduChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINBaiduChannel.html&tocid=Get-PINBaiduChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINCampaign</name> <description> <para>Calls the Amazon Pinpoint GetCampaign API operation.</para> </description> <verb>Get</verb> <noun>PINCampaign</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status, configuration, and other settings for a campaign. </para> </description> <syntax> <syntaxItem> <name>Get-PINCampaign</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>The unique identifier for the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>The unique identifier for the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.CampaignResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.CampaignResponse object. The service call response (type Amazon.Pinpoint.Model.GetCampaignResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINCampaign.html&tocid=Get-PINCampaign</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINCampaignActivityList</name> <description> <para>Calls the Amazon Pinpoint GetCampaignActivities API operation.</para> </description> <verb>Get</verb> <noun>PINCampaignActivityList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the activity performed by a campaign. </para> </description> <syntax> <syntaxItem> <name>Get-PINCampaignActivityList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>The unique identifier for the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>The unique identifier for the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ActivitiesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ActivitiesResponse object. The service call response (type Amazon.Pinpoint.Model.GetCampaignActivitiesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINCampaignActivityList.html&tocid=Get-PINCampaignActivityList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINCampaignDateRangeKpi</name> <description> <para>Calls the Amazon Pinpoint GetCampaignDateRangeKpi API operation.</para> </description> <verb>Get</verb> <noun>PINCampaignDateRangeKpi</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign. </para> </description> <syntax> <syntaxItem> <name>Get-PINCampaignDateRangeKpi</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>The unique identifier for the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime</name> <description> <para>The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-19T00:00:00Z for July 19, 2019 and 2019-07-19T20:00:00Z for 8:00 PM July 19, 2019. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KpiName</name> <description> <para>The name of the metric, also referred to as a <i>key performance indicator (KPI)</i>, to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the <a href="developerguide.html">Amazon Pinpoint Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartTime</name> <description> <para>The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-15T00:00:00Z for July 15, 2019 and 2019-07-15T16:00:00Z for 4:00 PM July 15, 2019. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>The unique identifier for the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime</name> <description> <para>The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-19T00:00:00Z for July 19, 2019 and 2019-07-19T20:00:00Z for 8:00 PM July 19, 2019. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KpiName</name> <description> <para>The name of the metric, also referred to as a <i>key performance indicator (KPI)</i>, to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the <a href="developerguide.html">Amazon Pinpoint Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartTime</name> <description> <para>The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-15T00:00:00Z for July 15, 2019 and 2019-07-15T16:00:00Z for 4:00 PM July 15, 2019. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.CampaignDateRangeKpiResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.CampaignDateRangeKpiResponse object. The service call response (type Amazon.Pinpoint.Model.GetCampaignDateRangeKpiResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINCampaignDateRangeKpi.html&tocid=Get-PINCampaignDateRangeKpi</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINCampaignList</name> <description> <para>Calls the Amazon Pinpoint GetCampaigns API operation.</para> </description> <verb>Get</verb> <noun>PINCampaignList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINCampaignList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.CampaignsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.CampaignsResponse object. The service call response (type Amazon.Pinpoint.Model.GetCampaignsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINCampaignList.html&tocid=Get-PINCampaignList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINCampaignVersion</name> <description> <para>Calls the Amazon Pinpoint GetCampaignVersion API operation.</para> </description> <verb>Get</verb> <noun>PINCampaignVersion</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status, configuration, and other settings for a specific version of a campaign. </para> </description> <syntax> <syntaxItem> <name>Get-PINCampaignVersion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>The unique identifier for the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Version</name> <description> <para>The unique version number (Version property) for the campaign version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>The unique identifier for the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Version</name> <description> <para>The unique version number (Version property) for the campaign version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.CampaignResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.CampaignResponse object. The service call response (type Amazon.Pinpoint.Model.GetCampaignVersionResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINCampaignVersion.html&tocid=Get-PINCampaignVersion</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINCampaignVersionList</name> <description> <para>Calls the Amazon Pinpoint GetCampaignVersions API operation.</para> </description> <verb>Get</verb> <noun>PINCampaignVersionList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status, configuration, and other settings for all versions of a specific campaign. </para> </description> <syntax> <syntaxItem> <name>Get-PINCampaignVersionList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>The unique identifier for the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>The unique identifier for the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.CampaignsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.CampaignsResponse object. The service call response (type Amazon.Pinpoint.Model.GetCampaignVersionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINCampaignVersionList.html&tocid=Get-PINCampaignVersionList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINChannel</name> <description> <para>Calls the Amazon Pinpoint GetChannels API operation.</para> </description> <verb>Get</verb> <noun>PINChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the history and status of each channel for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ChannelsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ChannelsResponse object. The service call response (type Amazon.Pinpoint.Model.GetChannelsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINChannel.html&tocid=Get-PINChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINEmailChannel</name> <description> <para>Calls the Amazon Pinpoint GetEmailChannel API operation.</para> </description> <verb>Get</verb> <noun>PINEmailChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status and settings of the email channel for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINEmailChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.EmailChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.EmailChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetEmailChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINEmailChannel.html&tocid=Get-PINEmailChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINEmailTemplate</name> <description> <para>Calls the Amazon Pinpoint GetEmailTemplate API operation.</para> </description> <verb>Get</verb> <noun>PINEmailTemplate</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the content and settings for a message template that you can use in messages that are sent through the email channel. </para> </description> <syntax> <syntaxItem> <name>Get-PINEmailTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.EmailTemplateResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.EmailTemplateResponse object. The service call response (type Amazon.Pinpoint.Model.GetEmailTemplateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINEmailTemplate.html&tocid=Get-PINEmailTemplate</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINEndpoint</name> <description> <para>Calls the Amazon Pinpoint GetEndpoint API operation.</para> </description> <verb>Get</verb> <noun>PINEndpoint</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the settings and attributes of a specific endpoint for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINEndpoint</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointId</name> <description> <para>The unique identifier for the endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointId</name> <description> <para>The unique identifier for the endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.EndpointResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.EndpointResponse object. The service call response (type Amazon.Pinpoint.Model.GetEndpointResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINEndpoint.html&tocid=Get-PINEndpoint</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINEventStream</name> <description> <para>Calls the Amazon Pinpoint GetEventStream API operation.</para> </description> <verb>Get</verb> <noun>PINEventStream</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the event stream settings for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINEventStream</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.EventStream</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.EventStream object. The service call response (type Amazon.Pinpoint.Model.GetEventStreamResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINEventStream.html&tocid=Get-PINEventStream</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINExportJob</name> <description> <para>Calls the Amazon Pinpoint GetExportJob API operation.</para> </description> <verb>Get</verb> <noun>PINExportJob</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status and settings of a specific export job for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINExportJob</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>JobId</name> <description> <para>The unique identifier for the job. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>JobId</name> <description> <para>The unique identifier for the job. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ExportJobResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ExportJobResponse object. The service call response (type Amazon.Pinpoint.Model.GetExportJobResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINExportJob.html&tocid=Get-PINExportJob</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINExportJobList</name> <description> <para>Calls the Amazon Pinpoint GetExportJobs API operation.</para> </description> <verb>Get</verb> <noun>PINExportJobList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status and settings of all the export jobs for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINExportJobList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ExportJobsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ExportJobsResponse object. The service call response (type Amazon.Pinpoint.Model.GetExportJobsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINExportJobList.html&tocid=Get-PINExportJobList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINGcmChannel</name> <description> <para>Calls the Amazon Pinpoint GetGcmChannel API operation.</para> </description> <verb>Get</verb> <noun>PINGcmChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status and settings of the GCM channel for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINGcmChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.GCMChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.GCMChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetGcmChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINGcmChannel.html&tocid=Get-PINGcmChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINImportJob</name> <description> <para>Calls the Amazon Pinpoint GetImportJob API operation.</para> </description> <verb>Get</verb> <noun>PINImportJob</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status and settings of a specific import job for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINImportJob</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>JobId</name> <description> <para>The unique identifier for the job. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>JobId</name> <description> <para>The unique identifier for the job. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ImportJobResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ImportJobResponse object. The service call response (type Amazon.Pinpoint.Model.GetImportJobResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINImportJob.html&tocid=Get-PINImportJob</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINImportJobList</name> <description> <para>Calls the Amazon Pinpoint GetImportJobs API operation.</para> </description> <verb>Get</verb> <noun>PINImportJobList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status and settings of all the import jobs for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINImportJobList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ImportJobsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ImportJobsResponse object. The service call response (type Amazon.Pinpoint.Model.GetImportJobsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINImportJobList.html&tocid=Get-PINImportJobList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINPushTemplate</name> <description> <para>Calls the Amazon Pinpoint GetPushTemplate API operation.</para> </description> <verb>Get</verb> <noun>PINPushTemplate</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the content and settings for a message template that you can use in messages that are sent through a push notification channel. </para> </description> <syntax> <syntaxItem> <name>Get-PINPushTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.PushNotificationTemplateResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.PushNotificationTemplateResponse object. The service call response (type Amazon.Pinpoint.Model.GetPushTemplateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINPushTemplate.html&tocid=Get-PINPushTemplate</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINResourceTag</name> <description> <para>Calls the Amazon Pinpoint ListTagsForResource API operation.</para> </description> <verb>Get</verb> <noun>PINResourceTag</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment. </para> </description> <syntax> <syntaxItem> <name>Get-PINResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceArn</name> <description> <para>The Amazon Resource Name (ARN) of the application, campaign, message template, or segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceArn</name> <description> <para>The Amazon Resource Name (ARN) of the application, campaign, message template, or segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.TagsModel</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.TagsModel object. The service call response (type Amazon.Pinpoint.Model.ListTagsForResourceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINResourceTag.html&tocid=Get-PINResourceTag</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINSegment</name> <description> <para>Calls the Amazon Pinpoint GetSegment API operation.</para> </description> <verb>Get</verb> <noun>PINSegment</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINSegment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>The unique identifier for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>The unique identifier for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.SegmentResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.SegmentResponse object. The service call response (type Amazon.Pinpoint.Model.GetSegmentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINSegment.html&tocid=Get-PINSegment</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINSegmentExportJobList</name> <description> <para>Calls the Amazon Pinpoint GetSegmentExportJobs API operation.</para> </description> <verb>Get</verb> <noun>PINSegmentExportJobList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status and settings of the export jobs for a segment. </para> </description> <syntax> <syntaxItem> <name>Get-PINSegmentExportJobList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>The unique identifier for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>The unique identifier for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ExportJobsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ExportJobsResponse object. The service call response (type Amazon.Pinpoint.Model.GetSegmentExportJobsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINSegmentExportJobList.html&tocid=Get-PINSegmentExportJobList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINSegmentImportJobList</name> <description> <para>Calls the Amazon Pinpoint GetSegmentImportJobs API operation.</para> </description> <verb>Get</verb> <noun>PINSegmentImportJobList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status and settings of the import jobs for a segment. </para> </description> <syntax> <syntaxItem> <name>Get-PINSegmentImportJobList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>The unique identifier for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>The unique identifier for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ImportJobsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ImportJobsResponse object. The service call response (type Amazon.Pinpoint.Model.GetSegmentImportJobsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINSegmentImportJobList.html&tocid=Get-PINSegmentImportJobList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINSegmentList</name> <description> <para>Calls the Amazon Pinpoint GetSegments API operation.</para> </description> <verb>Get</verb> <noun>PINSegmentList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINSegmentList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.SegmentsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.SegmentsResponse object. The service call response (type Amazon.Pinpoint.Model.GetSegmentsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINSegmentList.html&tocid=Get-PINSegmentList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINSegmentVersion</name> <description> <para>Calls the Amazon Pinpoint GetSegmentVersion API operation.</para> </description> <verb>Get</verb> <noun>PINSegmentVersion</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINSegmentVersion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>The unique identifier for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Version</name> <description> <para>The unique version number (Version property) for the campaign version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>The unique identifier for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Version</name> <description> <para>The unique version number (Version property) for the campaign version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.SegmentResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.SegmentResponse object. The service call response (type Amazon.Pinpoint.Model.GetSegmentVersionResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINSegmentVersion.html&tocid=Get-PINSegmentVersion</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINSegmentVersionList</name> <description> <para>Calls the Amazon Pinpoint GetSegmentVersions API operation.</para> </description> <verb>Get</verb> <noun>PINSegmentVersionList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the configuration, dimension, and other settings for all versions of a specific segment that's associated with an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINSegmentVersionList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>The unique identifier for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>The unique identifier for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.SegmentsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.SegmentsResponse object. The service call response (type Amazon.Pinpoint.Model.GetSegmentVersionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINSegmentVersionList.html&tocid=Get-PINSegmentVersionList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINSmsChannel</name> <description> <para>Calls the Amazon Pinpoint GetSmsChannel API operation.</para> </description> <verb>Get</verb> <noun>PINSmsChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status and settings of the SMS channel for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINSmsChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.SMSChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.SMSChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetSmsChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINSmsChannel.html&tocid=Get-PINSmsChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINSmsTemplate</name> <description> <para>Calls the Amazon Pinpoint GetSmsTemplate API operation.</para> </description> <verb>Get</verb> <noun>PINSmsTemplate</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the content and settings for a message template that you can use in messages that are sent through the SMS channel. </para> </description> <syntax> <syntaxItem> <name>Get-PINSmsTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.SMSTemplateResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.SMSTemplateResponse object. The service call response (type Amazon.Pinpoint.Model.GetSmsTemplateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINSmsTemplate.html&tocid=Get-PINSmsTemplate</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINTemplateList</name> <description> <para>Calls the Amazon Pinpoint ListTemplates API operation.</para> </description> <verb>Get</verb> <noun>PINTemplateList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about all the message templates that are associated with your Amazon Pinpoint account. </para> </description> <syntax> <syntaxItem> <name>Get-PINTemplateList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Prefix</name> <description> <para>The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TemplateType</name> <description> <para>The type of message template to include in the results. Valid values are: EMAIL, SMS, and PUSH. To include all types of templates in the results, don't include this parameter in your request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The NextToken string that specifies which page of results to return in a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Prefix</name> <description> <para>The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TemplateType</name> <description> <para>The type of message template to include in the results. Valid values are: EMAIL, SMS, and PUSH. To include all types of templates in the results, don't include this parameter in your request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.TemplatesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.TemplatesResponse object. The service call response (type Amazon.Pinpoint.Model.ListTemplatesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINTemplateList.html&tocid=Get-PINTemplateList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINUserEndpoint</name> <description> <para>Calls the Amazon Pinpoint GetUserEndpoints API operation.</para> </description> <verb>Get</verb> <noun>PINUserEndpoint</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about all the endpoints that are associated with a specific user ID. </para> </description> <syntax> <syntaxItem> <name>Get-PINUserEndpoint</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UserId</name> <description> <para>The unique identifier for the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UserId</name> <description> <para>The unique identifier for the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.EndpointsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.EndpointsResponse object. The service call response (type Amazon.Pinpoint.Model.GetUserEndpointsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINUserEndpoint.html&tocid=Get-PINUserEndpoint</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-PINVoiceChannel</name> <description> <para>Calls the Amazon Pinpoint GetVoiceChannel API operation.</para> </description> <verb>Get</verb> <noun>PINVoiceChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the status and settings of the voice channel for an application. </para> </description> <syntax> <syntaxItem> <name>Get-PINVoiceChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.VoiceChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.VoiceChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetVoiceChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PINVoiceChannel.html&tocid=Get-PINVoiceChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>New-PINApp</name> <description> <para>Calls the Amazon Pinpoint CreateApp API operation.</para> </description> <verb>New</verb> <noun>PINApp</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an application. </para> </description> <syntax> <syntaxItem> <name>New-PINApp</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CreateApplicationRequest_Name</name> <description> <para>The display name of the application. This name is displayed as the <b>Project name</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CreateApplicationRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CreateApplicationRequest_Name</name> <description> <para>The display name of the application. This name is displayed as the <b>Project name</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CreateApplicationRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ApplicationResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ApplicationResponse object. The service call response (type Amazon.Pinpoint.Model.CreateAppResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-PINApp.html&tocid=New-PINApp</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>New-PINCampaign</name> <description> <para>Calls the Amazon Pinpoint CreateCampaign API operation.</para> </description> <verb>New</verb> <noun>PINCampaign</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new campaign for an application or updates the settings of an existing campaign for an application. </para> </description> <syntax> <syntaxItem> <name>New-PINCampaign</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_AdditionalTreatment</name> <description> <para>An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.WriteTreatmentResource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Attribute</name> <description> <para>One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Body</name> <description> <para>The body of the email for recipients whose email clients don't support HTML content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Body</name> <description> <para>The body of the SMS message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Daily</name> <description> <para>The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Description</name> <description> <para>The custom description of the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventType_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_End</name> <description> <para>The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_EndTime</name> <description> <para>The scheduled time, in ISO 8601 format, for the campaign to end. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventFilter_FilterType</name> <description> <para>The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.FilterType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_Frequency</name> <description> <para>Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Frequency</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_FromAddress</name> <description> <para>The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_HoldoutPercent</name> <description> <para>The allocated percentage of users (segment members) who shouldn't receive messages from the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_HtmlBody</name> <description> <para>The body of the email, in HTML format, for recipients whose email clients support HTML content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_IsLocalTime</name> <description> <para>Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_IsPaused</name> <description> <para>Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Hook_LambdaFunctionName</name> <description> <para>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MaximumDuration</name> <description> <para>The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MessagesPerSecond</name> <description> <para>The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_MessageType</name> <description> <para>The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.MessageType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Metric</name> <description> <para>One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Hook_Mode</name> <description> <para>Specifies which Lambda mode to use when invoking the AWS Lambda function. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Mode</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Name</name> <description> <para>The custom name of the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PushTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_SegmentId</name> <description> <para>The unique identifier for the segment to associate with the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_SegmentVersion</name> <description> <para>The version of the segment to associate with the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_SenderId</name> <description> <para>The sender ID to display on recipients' devices when they receive the SMS message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_Start</name> <description> <para>The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_StartTime</name> <description> <para>The scheduled time, in ISO 8601 format, for the campaign to begin. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_Timezone</name> <description> <para>The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Title</name> <description> <para>The subject line, or title, of the email. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Total</name> <description> <para>The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_TreatmentDescription</name> <description> <para>The custom description of a variation of the campaign to use for A/B testing. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_TreatmentName</name> <description> <para>The custom name of a variation of the campaign to use for A/B testing. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventType_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Hook_WebUrl</name> <description> <para>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Attribute</name> <description> <para>One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Metric</name> <description> <para>One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Body</name> <description> <para>The body of the email for recipients whose email clients don't support HTML content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_FromAddress</name> <description> <para>The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_HtmlBody</name> <description> <para>The body of the email, in HTML format, for recipients whose email clients support HTML content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Title</name> <description> <para>The subject line, or title, of the email. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventFilter_FilterType</name> <description> <para>The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.FilterType</parameterValue> <type> <name>Amazon.Pinpoint.FilterType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventType_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventType_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Hook_LambdaFunctionName</name> <description> <para>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Hook_Mode</name> <description> <para>Specifies which Lambda mode to use when invoking the AWS Lambda function. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Mode</parameterValue> <type> <name>Amazon.Pinpoint.Mode</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Hook_WebUrl</name> <description> <para>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Daily</name> <description> <para>The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MaximumDuration</name> <description> <para>The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MessagesPerSecond</name> <description> <para>The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Total</name> <description> <para>The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PushTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_End</name> <description> <para>The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_Start</name> <description> <para>The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_EndTime</name> <description> <para>The scheduled time, in ISO 8601 format, for the campaign to end. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_Frequency</name> <description> <para>Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Frequency</parameterValue> <type> <name>Amazon.Pinpoint.Frequency</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_IsLocalTime</name> <description> <para>Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_StartTime</name> <description> <para>The scheduled time, in ISO 8601 format, for the campaign to begin. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_Timezone</name> <description> <para>The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Body</name> <description> <para>The body of the SMS message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_MessageType</name> <description> <para>The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.MessageType</parameterValue> <type> <name>Amazon.Pinpoint.MessageType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_SenderId</name> <description> <para>The sender ID to display on recipients' devices when they receive the SMS message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_AdditionalTreatment</name> <description> <para>An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.WriteTreatmentResource[]</parameterValue> <type> <name>Amazon.Pinpoint.Model.WriteTreatmentResource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Description</name> <description> <para>The custom description of the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_HoldoutPercent</name> <description> <para>The allocated percentage of users (segment members) who shouldn't receive messages from the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_IsPaused</name> <description> <para>Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Name</name> <description> <para>The custom name of the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_SegmentId</name> <description> <para>The unique identifier for the segment to associate with the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_SegmentVersion</name> <description> <para>The version of the segment to associate with the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_TreatmentDescription</name> <description> <para>The custom description of a variation of the campaign to use for A/B testing. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_TreatmentName</name> <description> <para>The custom name of a variation of the campaign to use for A/B testing. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.CampaignResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.CampaignResponse object. The service call response (type Amazon.Pinpoint.Model.CreateCampaignResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-PINCampaign.html&tocid=New-PINCampaign</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>New-PINEmailTemplate</name> <description> <para>Calls the Amazon Pinpoint CreateEmailTemplate API operation.</para> </description> <verb>New</verb> <noun>PINEmailTemplate</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a message template that you can use in messages that are sent through the email channel. </para> </description> <syntax> <syntaxItem> <name>New-PINEmailTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplateRequest_HtmlPart</name> <description> <para>The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that support HTML. You can include links, formatted text, and more in an HTML message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplateRequest_Subject</name> <description> <para>The subject line, or title, to use in email messages that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplateRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplateRequest_TextPart</name> <description> <para>The message body, in text format, to use in email messages that are based on the message template. We recommend using text format for email clients that don't support HTML and clients that are connected to high-latency networks, such as mobile devices. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplateRequest_HtmlPart</name> <description> <para>The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that support HTML. You can include links, formatted text, and more in an HTML message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplateRequest_Subject</name> <description> <para>The subject line, or title, to use in email messages that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplateRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplateRequest_TextPart</name> <description> <para>The message body, in text format, to use in email messages that are based on the message template. We recommend using text format for email clients that don't support HTML and clients that are connected to high-latency networks, such as mobile devices. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.CreateTemplateMessageBody</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.CreateTemplateMessageBody object. The service call response (type Amazon.Pinpoint.Model.CreateEmailTemplateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-PINEmailTemplate.html&tocid=New-PINEmailTemplate</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>New-PINExportJob</name> <description> <para>Calls the Amazon Pinpoint CreateExportJob API operation.</para> </description> <verb>New</verb> <noun>PINExportJob</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an export job for an application. </para> </description> <syntax> <syntaxItem> <name>New-PINExportJob</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ExportJobRequest_RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ExportJobRequest_S3UrlPrefix</name> <description> <para>The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ExportJobRequest_SegmentId</name> <description> <para>The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ExportJobRequest_SegmentVersion</name> <description> <para>The version of the segment to export endpoint definitions from, if specified. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ExportJobRequest_RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ExportJobRequest_S3UrlPrefix</name> <description> <para>The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ExportJobRequest_SegmentId</name> <description> <para>The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ExportJobRequest_SegmentVersion</name> <description> <para>The version of the segment to export endpoint definitions from, if specified. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ExportJobResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ExportJobResponse object. The service call response (type Amazon.Pinpoint.Model.CreateExportJobResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-PINExportJob.html&tocid=New-PINExportJob</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>New-PINImportJob</name> <description> <para>Calls the Amazon Pinpoint CreateImportJob API operation.</para> </description> <verb>New</verb> <noun>PINImportJob</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an import job for an application. </para> </description> <syntax> <syntaxItem> <name>New-PINImportJob</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_DefineSegment</name> <description> <para>Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_ExternalId</name> <description> <para>(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_Format</name> <description> <para>The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Format</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_RegisterEndpoint</name> <description> <para>Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_S3Url</name> <description> <para>The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains. The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_SegmentId</name> <description> <para>The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_SegmentName</name> <description> <para>The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_DefineSegment</name> <description> <para>Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_ExternalId</name> <description> <para>(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_Format</name> <description> <para>The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Format</parameterValue> <type> <name>Amazon.Pinpoint.Format</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_RegisterEndpoint</name> <description> <para>Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_S3Url</name> <description> <para>The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains. The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_SegmentId</name> <description> <para>The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_SegmentName</name> <description> <para>The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ImportJobResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ImportJobResponse object. The service call response (type Amazon.Pinpoint.Model.CreateImportJobResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-PINImportJob.html&tocid=New-PINImportJob</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>New-PINPushTemplate</name> <description> <para>Calls the Amazon Pinpoint CreatePushTemplate API operation.</para> </description> <verb>New</verb> <noun>PINPushTemplate</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a message template that you can use in messages that are sent through a push notification channel. </para> </description> <syntax> <syntaxItem> <name>New-PINPushTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Body</name> <description> <para>The message body to use in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Body</name> <description> <para>The message body to use in push notifications that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Body</name> <description> <para>The message body to use in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Body</name> <description> <para>The message body to use in push notifications that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Body</name> <description> <para>The message body to use in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_ImageUrl</name> <description> <para>The URL of an image to display in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_ImageUrl</name> <description> <para>The URL of an image to display in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_ImageUrl</name> <description> <para>The URL of an image to display in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_MediaUrl</name> <description> <para>The URL of an image or video to display in push notifications that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Sound</name> <description> <para>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Sound</name> <description> <para>The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Sound</name> <description> <para>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Sound</name> <description> <para>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Sound</name> <description> <para>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PushNotificationTemplateRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Title</name> <description> <para>The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Title</name> <description> <para>The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Title</name> <description> <para>The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Title</name> <description> <para>The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Title</name> <description> <para>The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Body</name> <description> <para>The message body to use in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_ImageUrl</name> <description> <para>The URL of an image to display in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Sound</name> <description> <para>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Title</name> <description> <para>The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Body</name> <description> <para>The message body to use in push notifications that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_MediaUrl</name> <description> <para>The URL of an image or video to display in push notifications that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Sound</name> <description> <para>The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Title</name> <description> <para>The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Body</name> <description> <para>The message body to use in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_ImageUrl</name> <description> <para>The URL of an image to display in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Sound</name> <description> <para>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Title</name> <description> <para>The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Body</name> <description> <para>The message body to use in push notifications that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Sound</name> <description> <para>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Title</name> <description> <para>The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Body</name> <description> <para>The message body to use in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_ImageUrl</name> <description> <para>The URL of an image to display in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Sound</name> <description> <para>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Title</name> <description> <para>The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PushNotificationTemplateRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.CreateTemplateMessageBody</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.CreateTemplateMessageBody object. The service call response (type Amazon.Pinpoint.Model.CreatePushTemplateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-PINPushTemplate.html&tocid=New-PINPushTemplate</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>New-PINSegment</name> <description> <para>Calls the Amazon Pinpoint CreateSegment API operation.</para> </description> <verb>New</verb> <noun>PINSegment</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application. </para> </description> <syntax> <syntaxItem> <name>New-PINSegment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Attribute</name> <description> <para>One or more custom attributes to use as criteria for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppVersion_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Channel_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeviceType_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Make_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Model_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Platform_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Country_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Recency_Duration</name> <description> <para>The duration to use when determining whether an endpoint is active or inactive. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Duration</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentGroups_Group</name> <description> <para>An array that defines the set of segment criteria to evaluate when handling segment groups for the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.SegmentGroup[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentGroups_Include</name> <description> <para>Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Include</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Coordinates_Latitude</name> <description> <para>The latitude coordinate of the location. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Coordinates_Longitude</name> <description> <para>The longitude coordinate of the location. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Metric</name> <description> <para>One or more custom metrics to use as criteria for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteSegmentRequest_Name</name> <description> <para>The name of the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GPSPoint_RangeInKilometer</name> <description> <para>The range, in kilometers, from the GPS coordinates. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Recency_RecencyType</name> <description> <para>The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.RecencyType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteSegmentRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_UserAttribute</name> <description> <para>One or more custom user attributes to use as criteria for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppVersion_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Channel_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeviceType_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Make_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Model_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Platform_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Country_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppVersion_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppVersion_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Channel_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Channel_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Coordinates_Latitude</name> <description> <para>The latitude coordinate of the location. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> <type> <name>System.Double</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Coordinates_Longitude</name> <description> <para>The longitude coordinate of the location. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> <type> <name>System.Double</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Country_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Country_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeviceType_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeviceType_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Attribute</name> <description> <para>One or more custom attributes to use as criteria for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Metric</name> <description> <para>One or more custom metrics to use as criteria for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_UserAttribute</name> <description> <para>One or more custom user attributes to use as criteria for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GPSPoint_RangeInKilometer</name> <description> <para>The range, in kilometers, from the GPS coordinates. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> <type> <name>System.Double</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Make_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Make_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Model_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Model_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Platform_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Platform_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Recency_Duration</name> <description> <para>The duration to use when determining whether an endpoint is active or inactive. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Duration</parameterValue> <type> <name>Amazon.Pinpoint.Duration</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Recency_RecencyType</name> <description> <para>The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.RecencyType</parameterValue> <type> <name>Amazon.Pinpoint.RecencyType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentGroups_Group</name> <description> <para>An array that defines the set of segment criteria to evaluate when handling segment groups for the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.SegmentGroup[]</parameterValue> <type> <name>Amazon.Pinpoint.Model.SegmentGroup[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentGroups_Include</name> <description> <para>Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Include</parameterValue> <type> <name>Amazon.Pinpoint.Include</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteSegmentRequest_Name</name> <description> <para>The name of the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteSegmentRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.SegmentResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.SegmentResponse object. The service call response (type Amazon.Pinpoint.Model.CreateSegmentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-PINSegment.html&tocid=New-PINSegment</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>New-PINSmsTemplate</name> <description> <para>Calls the Amazon Pinpoint CreateSmsTemplate API operation.</para> </description> <verb>New</verb> <noun>PINSmsTemplate</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a message template that you can use in messages that are sent through the SMS channel. </para> </description> <syntax> <syntaxItem> <name>New-PINSmsTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSTemplateRequest_Body</name> <description> <para>The message body to use in text messages that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSTemplateRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSTemplateRequest_Body</name> <description> <para>The message body to use in text messages that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSTemplateRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.CreateTemplateMessageBody</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.CreateTemplateMessageBody object. The service call response (type Amazon.Pinpoint.Model.CreateSmsTemplateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-PINSmsTemplate.html&tocid=New-PINSmsTemplate</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINAdmChannel</name> <description> <para>Calls the Amazon Pinpoint DeleteAdmChannel API operation.</para> </description> <verb>Remove</verb> <noun>PINAdmChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disables the ADM channel for an application and deletes any existing settings for the channel. </para> </description> <syntax> <syntaxItem> <name>Remove-PINAdmChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ADMChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ADMChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteAdmChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINAdmChannel.html&tocid=Remove-PINAdmChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINApnsChannel</name> <description> <para>Calls the Amazon Pinpoint DeleteApnsChannel API operation.</para> </description> <verb>Remove</verb> <noun>PINApnsChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disables the APNs channel for an application and deletes any existing settings for the channel. </para> </description> <syntax> <syntaxItem> <name>Remove-PINApnsChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.APNSChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteApnsChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINApnsChannel.html&tocid=Remove-PINApnsChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINApnsSandboxChannel</name> <description> <para>Calls the Amazon Pinpoint DeleteApnsSandboxChannel API operation.</para> </description> <verb>Remove</verb> <noun>PINApnsSandboxChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disables the APNs sandbox channel for an application and deletes any existing settings for the channel. </para> </description> <syntax> <syntaxItem> <name>Remove-PINApnsSandboxChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSSandboxChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.APNSSandboxChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteApnsSandboxChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINApnsSandboxChannel.html&tocid=Remove-PINApnsSandboxChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINApnsVoipChannel</name> <description> <para>Calls the Amazon Pinpoint DeleteApnsVoipChannel API operation.</para> </description> <verb>Remove</verb> <noun>PINApnsVoipChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disables the APNs VoIP channel for an application and deletes any existing settings for the channel. </para> </description> <syntax> <syntaxItem> <name>Remove-PINApnsVoipChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSVoipChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.APNSVoipChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteApnsVoipChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINApnsVoipChannel.html&tocid=Remove-PINApnsVoipChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINApnsVoipSandboxChannel</name> <description> <para>Calls the Amazon Pinpoint DeleteApnsVoipSandboxChannel API operation.</para> </description> <verb>Remove</verb> <noun>PINApnsVoipSandboxChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel. </para> </description> <syntax> <syntaxItem> <name>Remove-PINApnsVoipSandboxChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSVoipSandboxChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.APNSVoipSandboxChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteApnsVoipSandboxChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINApnsVoipSandboxChannel.html&tocid=Remove-PINApnsVoipSandboxChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINApp</name> <description> <para>Calls the Amazon Pinpoint DeleteApp API operation.</para> </description> <verb>Remove</verb> <noun>PINApp</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an application. </para> </description> <syntax> <syntaxItem> <name>Remove-PINApp</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ApplicationResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ApplicationResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteAppResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINApp.html&tocid=Remove-PINApp</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINAttribute</name> <description> <para>Calls the Amazon Pinpoint RemoveAttributes API operation.</para> </description> <verb>Remove</verb> <noun>PINAttribute</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application. </para> </description> <syntax> <syntaxItem> <name>Remove-PINAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AttributeType</name> <description> <para>The type of attribute or attributes to remove. Valid values are: - endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel. - endpoint-custom-metrics - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart. - endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpdateAttributesRequest_Blacklist</name> <description> <para>An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AttributeType</name> <description> <para>The type of attribute or attributes to remove. Valid values are: - endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel. - endpoint-custom-metrics - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart. - endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpdateAttributesRequest_Blacklist</name> <description> <para>An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.AttributesResource</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.AttributesResource object. The service call response (type Amazon.Pinpoint.Model.RemoveAttributesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINAttribute.html&tocid=Remove-PINAttribute</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINBaiduChannel</name> <description> <para>Calls the Amazon Pinpoint DeleteBaiduChannel API operation.</para> </description> <verb>Remove</verb> <noun>PINBaiduChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disables the Baidu channel for an application and deletes any existing settings for the channel. </para> </description> <syntax> <syntaxItem> <name>Remove-PINBaiduChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.BaiduChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.BaiduChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteBaiduChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINBaiduChannel.html&tocid=Remove-PINBaiduChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINCampaign</name> <description> <para>Calls the Amazon Pinpoint DeleteCampaign API operation.</para> </description> <verb>Remove</verb> <noun>PINCampaign</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a campaign from an application. </para> </description> <syntax> <syntaxItem> <name>Remove-PINCampaign</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>The unique identifier for the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>The unique identifier for the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.CampaignResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.CampaignResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteCampaignResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINCampaign.html&tocid=Remove-PINCampaign</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINEmailChannel</name> <description> <para>Calls the Amazon Pinpoint DeleteEmailChannel API operation.</para> </description> <verb>Remove</verb> <noun>PINEmailChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disables the email channel for an application and deletes any existing settings for the channel. </para> </description> <syntax> <syntaxItem> <name>Remove-PINEmailChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.EmailChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.EmailChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteEmailChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINEmailChannel.html&tocid=Remove-PINEmailChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINEmailTemplate</name> <description> <para>Calls the Amazon Pinpoint DeleteEmailTemplate API operation.</para> </description> <verb>Remove</verb> <noun>PINEmailTemplate</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a message template that was designed for use in messages that were sent through the email channel. </para> </description> <syntax> <syntaxItem> <name>Remove-PINEmailTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.MessageBody</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.MessageBody object. The service call response (type Amazon.Pinpoint.Model.DeleteEmailTemplateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINEmailTemplate.html&tocid=Remove-PINEmailTemplate</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINEndpoint</name> <description> <para>Calls the Amazon Pinpoint DeleteEndpoint API operation.</para> </description> <verb>Remove</verb> <noun>PINEndpoint</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an endpoint from an application. </para> </description> <syntax> <syntaxItem> <name>Remove-PINEndpoint</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointId</name> <description> <para>The unique identifier for the endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointId</name> <description> <para>The unique identifier for the endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.EndpointResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.EndpointResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteEndpointResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINEndpoint.html&tocid=Remove-PINEndpoint</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINEventStream</name> <description> <para>Calls the Amazon Pinpoint DeleteEventStream API operation.</para> </description> <verb>Remove</verb> <noun>PINEventStream</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the event stream for an application. </para> </description> <syntax> <syntaxItem> <name>Remove-PINEventStream</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.EventStream</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.EventStream object. The service call response (type Amazon.Pinpoint.Model.DeleteEventStreamResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINEventStream.html&tocid=Remove-PINEventStream</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINGcmChannel</name> <description> <para>Calls the Amazon Pinpoint DeleteGcmChannel API operation.</para> </description> <verb>Remove</verb> <noun>PINGcmChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disables the GCM channel for an application and deletes any existing settings for the channel. </para> </description> <syntax> <syntaxItem> <name>Remove-PINGcmChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.GCMChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.GCMChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteGcmChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINGcmChannel.html&tocid=Remove-PINGcmChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINPushTemplate</name> <description> <para>Calls the Amazon Pinpoint DeletePushTemplate API operation.</para> </description> <verb>Remove</verb> <noun>PINPushTemplate</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a message template that was designed for use in messages that were sent through a push notification channel. </para> </description> <syntax> <syntaxItem> <name>Remove-PINPushTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.MessageBody</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.MessageBody object. The service call response (type Amazon.Pinpoint.Model.DeletePushTemplateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINPushTemplate.html&tocid=Remove-PINPushTemplate</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINResourceTag</name> <description> <para>Calls the Amazon Pinpoint UntagResource API operation.</para> </description> <verb>Remove</verb> <noun>PINResourceTag</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes one or more tags (keys and values) from an application, campaign, message template, or segment. </para> </description> <syntax> <syntaxItem> <name>Remove-PINResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceArn</name> <description> <para>The Amazon Resource Name (ARN) of the application, campaign, message template, or segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>The key of the tag to remove from the application, campaign, message template, or segment. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&). </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceArn</name> <description> <para>The Amazon Resource Name (ARN) of the application, campaign, message template, or segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>The key of the tag to remove from the application, campaign, message template, or segment. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&). </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ResourceArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Pinpoint.Model.UntagResourceResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINResourceTag.html&tocid=Remove-PINResourceTag</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINSegment</name> <description> <para>Calls the Amazon Pinpoint DeleteSegment API operation.</para> </description> <verb>Remove</verb> <noun>PINSegment</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a segment from an application. </para> </description> <syntax> <syntaxItem> <name>Remove-PINSegment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>The unique identifier for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>The unique identifier for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.SegmentResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.SegmentResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteSegmentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINSegment.html&tocid=Remove-PINSegment</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINSmsChannel</name> <description> <para>Calls the Amazon Pinpoint DeleteSmsChannel API operation.</para> </description> <verb>Remove</verb> <noun>PINSmsChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disables the SMS channel for an application and deletes any existing settings for the channel. </para> </description> <syntax> <syntaxItem> <name>Remove-PINSmsChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.SMSChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.SMSChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteSmsChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINSmsChannel.html&tocid=Remove-PINSmsChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINSmsTemplate</name> <description> <para>Calls the Amazon Pinpoint DeleteSmsTemplate API operation.</para> </description> <verb>Remove</verb> <noun>PINSmsTemplate</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a message template that was designed for use in messages that were sent through the SMS channel. </para> </description> <syntax> <syntaxItem> <name>Remove-PINSmsTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.MessageBody</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.MessageBody object. The service call response (type Amazon.Pinpoint.Model.DeleteSmsTemplateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINSmsTemplate.html&tocid=Remove-PINSmsTemplate</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINUserEndpoint</name> <description> <para>Calls the Amazon Pinpoint DeleteUserEndpoints API operation.</para> </description> <verb>Remove</verb> <noun>PINUserEndpoint</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes all the endpoints that are associated with a specific user ID. </para> </description> <syntax> <syntaxItem> <name>Remove-PINUserEndpoint</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UserId</name> <description> <para>The unique identifier for the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UserId</name> <description> <para>The unique identifier for the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.EndpointsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.EndpointsResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteUserEndpointsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINUserEndpoint.html&tocid=Remove-PINUserEndpoint</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-PINVoiceChannel</name> <description> <para>Calls the Amazon Pinpoint DeleteVoiceChannel API operation.</para> </description> <verb>Remove</verb> <noun>PINVoiceChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disables the voice channel for an application and deletes any existing settings for the channel. </para> </description> <syntax> <syntaxItem> <name>Remove-PINVoiceChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.VoiceChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.VoiceChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteVoiceChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-PINVoiceChannel.html&tocid=Remove-PINVoiceChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Send-PINMessage</name> <description> <para>Calls the Amazon Pinpoint SendMessages API operation.</para> </description> <verb>Send</verb> <noun>PINMessage</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates and sends a direct message. </para> </description> <syntax> <syntaxItem> <name>Send-PINMessage</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Action</name> <description> <para>The action to occur if the recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Action</name> <description> <para>The action to occur if the recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Action</name> <description> <para>The action to occur if the recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Action</name> <description> <para>The default action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Action</name> <description> <para>The action to occur if the recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageRequest_Address</name> <description> <para>A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Badge</name> <description> <para>The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Body</name> <description> <para>The body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Body</name> <description> <para>The body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Body</name> <description> <para>The body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Body</name> <description> <para>The default message body of the push notification, email, or SMS message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Body</name> <description> <para>The default body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Body</name> <description> <para>The body of the email message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Body</name> <description> <para>The body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Body</name> <description> <para>The body of the SMS message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_Body</name> <description> <para>The text script for the voice message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Category</name> <description> <para>The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HtmlPart_Charset</name> <description> <para>The applicable character set for the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Subject_Charset</name> <description> <para>The applicable character set for the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TextPart_Charset</name> <description> <para>The applicable character set for the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_CollapseId</name> <description> <para>An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes. Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_CollapseKey</name> <description> <para>An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active. Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ConsolidationKey</name> <description> <para>An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageRequest_Context</name> <description> <para>A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Data</name> <description> <para>The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Data</name> <description> <para>The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Data</name> <description> <para>The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Data</name> <description> <para>The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RawEmail_Data</name> <description> <para>The email message, represented as a raw MIME message. The entire message must be base64 encoded. </para> </description> <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HtmlPart_Data</name> <description> <para>The textual data of the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Subject_Data</name> <description> <para>The textual data of the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TextPart_Data</name> <description> <para>The textual data of the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Data</name> <description> <para>The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageRequest_Endpoint</name> <description> <para>A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ExpiresAfter</name> <description> <para>The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_FeedbackForwardingAddress</name> <description> <para>The email address to forward bounces and complaints to, if feedback forwarding is enabled. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_FromAddress</name> <description> <para>The verified email address to send the email message from. The default value is the FromAddress specified for the email channel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Keyword</name> <description> <para>The SMS program name that you provided to AWS Support when you requested your dedicated number. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_LanguageCode</name> <description> <para>The language to use when delivering the message. For a list of supported languages, see the <a href="AmazonPollyDG.html">Amazon Polly Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_MD5</name> <description> <para>The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_MediaUrl</name> <description> <para>The URL of an image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_MessageType</name> <description> <para>The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.MessageType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PushTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_OriginationNumber</name> <description> <para>The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_OriginationNumber</name> <description> <para>The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_PreferredAuthenticationMethod</name> <description> <para>The authentication method that you want Amazon Pinpoint to use when authenticating with Apple Push Notification service (APNs), CERTIFICATE or TOKEN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Priority</name> <description> <para>para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled. /listitem> - 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device. /para> Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs. The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Priority</name> <description> <para>para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required. /listitem> - high - The notification is sent immediately and might wake a sleeping device. /para> Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM. The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message. If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification">Generating a Remote Notification</a> and <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app">Pushing Background Updates to Your App</a> on the Apple Developer website. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_ReplyToAddress</name> <description> <para>The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RestrictedPackageName</name> <description> <para>The package name of the application where registration tokens must match in order for the recipient to receive the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_SenderId</name> <description> <para>The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center. Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background. If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification">Generating a Remote Notification</a> and <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app">Pushing Background Updates to Your App</a> on the Apple Developer website. Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_SilentPush</name> <description> <para>Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Sound</name> <description> <para>The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Sound</name> <description> <para>The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Sound</name> <description> <para>The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Sound</name> <description> <para>The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override these default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Substitution</name> <description> <para>The default message variables to use in the push notification, email, or SMS message. You can override these default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Substitution</name> <description> <para>The default message variables to use in the email message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Substitution</name> <description> <para>The message variables to use in the SMS message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_Substitution</name> <description> <para>The default message variables to use in the voice message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ThreadId</name> <description> <para>The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_TimeToLive</name> <description> <para>The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_TimeToLive</name> <description> <para>The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_TimeToLive</name> <description> <para>The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days). Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Title</name> <description> <para>The title to display above the notification message on the recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Title</name> <description> <para>The title to display above the notification message on the recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Title</name> <description> <para>The title to display above the notification message on the recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Title</name> <description> <para>The default title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Title</name> <description> <para>The title to display above the notification message on the recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageRequest_TraceId</name> <description> <para>The unique identifier for tracing the message. This identifier is visible to message recipients. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Url</name> <description> <para>The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_VoiceId</name> <description> <para>The name of the voice to use when delivering the message. For a list of supported voices, see the <a href="AmazonPollyDG.html">Amazon Polly Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Action</name> <description> <para>The action to occur if the recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Body</name> <description> <para>The body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ConsolidationKey</name> <description> <para>An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Data</name> <description> <para>The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ExpiresAfter</name> <description> <para>The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_MD5</name> <description> <para>The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Sound</name> <description> <para>The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Title</name> <description> <para>The title to display above the notification message on the recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Action</name> <description> <para>The action to occur if the recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Badge</name> <description> <para>The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Body</name> <description> <para>The body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Category</name> <description> <para>The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_CollapseId</name> <description> <para>An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes. Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Data</name> <description> <para>The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_MediaUrl</name> <description> <para>The URL of an image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_PreferredAuthenticationMethod</name> <description> <para>The authentication method that you want Amazon Pinpoint to use when authenticating with Apple Push Notification service (APNs), CERTIFICATE or TOKEN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Priority</name> <description> <para>para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled. /listitem> - 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device. /para> Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs. The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message. If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification">Generating a Remote Notification</a> and <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app">Pushing Background Updates to Your App</a> on the Apple Developer website. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center. Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background. If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification">Generating a Remote Notification</a> and <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app">Pushing Background Updates to Your App</a> on the Apple Developer website. Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Sound</name> <description> <para>The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override these default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ThreadId</name> <description> <para>The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_TimeToLive</name> <description> <para>The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Title</name> <description> <para>The title to display above the notification message on the recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Action</name> <description> <para>The action to occur if the recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Body</name> <description> <para>The body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Data</name> <description> <para>The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Sound</name> <description> <para>The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_TimeToLive</name> <description> <para>The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Title</name> <description> <para>The title to display above the notification message on the recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Body</name> <description> <para>The default message body of the push notification, email, or SMS message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Substitution</name> <description> <para>The default message variables to use in the push notification, email, or SMS message. You can override these default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Action</name> <description> <para>The default action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Body</name> <description> <para>The default body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Data</name> <description> <para>The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_SilentPush</name> <description> <para>Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Title</name> <description> <para>The default title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Url</name> <description> <para>The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Body</name> <description> <para>The body of the email message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_FeedbackForwardingAddress</name> <description> <para>The email address to forward bounces and complaints to, if feedback forwarding is enabled. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_FromAddress</name> <description> <para>The verified email address to send the email message from. The default value is the FromAddress specified for the email channel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_ReplyToAddress</name> <description> <para>The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Substitution</name> <description> <para>The default message variables to use in the email message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Action</name> <description> <para>The action to occur if the recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Body</name> <description> <para>The body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_CollapseKey</name> <description> <para>An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active. Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Data</name> <description> <para>The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Priority</name> <description> <para>para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required. /listitem> - high - The notification is sent immediately and might wake a sleeping device. /para> Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM. The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RestrictedPackageName</name> <description> <para>The package name of the application where registration tokens must match in order for the recipient to receive the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Sound</name> <description> <para>The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_TimeToLive</name> <description> <para>The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days). Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Title</name> <description> <para>The title to display above the notification message on the recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HtmlPart_Charset</name> <description> <para>The applicable character set for the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HtmlPart_Data</name> <description> <para>The textual data of the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageRequest_Address</name> <description> <para>A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageRequest_Context</name> <description> <para>A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageRequest_Endpoint</name> <description> <para>A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageRequest_TraceId</name> <description> <para>The unique identifier for tracing the message. This identifier is visible to message recipients. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PushTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RawEmail_Data</name> <description> <para>The email message, represented as a raw MIME message. The entire message must be base64 encoded. </para> </description> <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue> <type> <name>System.Byte[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Body</name> <description> <para>The body of the SMS message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Keyword</name> <description> <para>The SMS program name that you provided to AWS Support when you requested your dedicated number. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_MessageType</name> <description> <para>The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.MessageType</parameterValue> <type> <name>Amazon.Pinpoint.MessageType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_OriginationNumber</name> <description> <para>The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_SenderId</name> <description> <para>The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Substitution</name> <description> <para>The message variables to use in the SMS message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Subject_Charset</name> <description> <para>The applicable character set for the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Subject_Data</name> <description> <para>The textual data of the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TextPart_Charset</name> <description> <para>The applicable character set for the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TextPart_Data</name> <description> <para>The textual data of the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_Body</name> <description> <para>The text script for the voice message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_LanguageCode</name> <description> <para>The language to use when delivering the message. For a list of supported languages, see the <a href="AmazonPollyDG.html">Amazon Polly Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_OriginationNumber</name> <description> <para>The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_Substitution</name> <description> <para>The default message variables to use in the voice message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_VoiceId</name> <description> <para>The name of the voice to use when delivering the message. For a list of supported voices, see the <a href="AmazonPollyDG.html">Amazon Polly Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.MessageResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.MessageResponse object. The service call response (type Amazon.Pinpoint.Model.SendMessagesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Send-PINMessage.html&tocid=Send-PINMessage</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Send-PINUserMessageBatch</name> <description> <para>Calls the Amazon Pinpoint SendUsersMessages API operation.</para> </description> <verb>Send</verb> <noun>PINUserMessageBatch</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates and sends a message to a list of users. </para> </description> <syntax> <syntaxItem> <name>Send-PINUserMessageBatch</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Action</name> <description> <para>The action to occur if the recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Action</name> <description> <para>The action to occur if the recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Action</name> <description> <para>The action to occur if the recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Action</name> <description> <para>The default action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Action</name> <description> <para>The action to occur if the recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Badge</name> <description> <para>The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Body</name> <description> <para>The body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Body</name> <description> <para>The body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Body</name> <description> <para>The body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Body</name> <description> <para>The default message body of the push notification, email, or SMS message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Body</name> <description> <para>The default body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Body</name> <description> <para>The body of the email message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Body</name> <description> <para>The body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Body</name> <description> <para>The body of the SMS message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_Body</name> <description> <para>The text script for the voice message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Category</name> <description> <para>The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HtmlPart_Charset</name> <description> <para>The applicable character set for the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Subject_Charset</name> <description> <para>The applicable character set for the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TextPart_Charset</name> <description> <para>The applicable character set for the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_CollapseId</name> <description> <para>An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes. Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_CollapseKey</name> <description> <para>An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active. Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ConsolidationKey</name> <description> <para>An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SendUsersMessageRequest_Context</name> <description> <para>A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Data</name> <description> <para>The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Data</name> <description> <para>The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Data</name> <description> <para>The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Data</name> <description> <para>The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RawEmail_Data</name> <description> <para>The email message, represented as a raw MIME message. The entire message must be base64 encoded. </para> </description> <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HtmlPart_Data</name> <description> <para>The textual data of the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Subject_Data</name> <description> <para>The textual data of the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TextPart_Data</name> <description> <para>The textual data of the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Data</name> <description> <para>The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ExpiresAfter</name> <description> <para>The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_FeedbackForwardingAddress</name> <description> <para>The email address to forward bounces and complaints to, if feedback forwarding is enabled. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_FromAddress</name> <description> <para>The verified email address to send the email message from. The default value is the FromAddress specified for the email channel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Keyword</name> <description> <para>The SMS program name that you provided to AWS Support when you requested your dedicated number. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_LanguageCode</name> <description> <para>The language to use when delivering the message. For a list of supported languages, see the <a href="AmazonPollyDG.html">Amazon Polly Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_MD5</name> <description> <para>The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_MediaUrl</name> <description> <para>The URL of an image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_MessageType</name> <description> <para>The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.MessageType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PushTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_OriginationNumber</name> <description> <para>The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_OriginationNumber</name> <description> <para>The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_PreferredAuthenticationMethod</name> <description> <para>The authentication method that you want Amazon Pinpoint to use when authenticating with Apple Push Notification service (APNs), CERTIFICATE or TOKEN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Priority</name> <description> <para>para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled. /listitem> - 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device. /para> Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs. The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Priority</name> <description> <para>para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required. /listitem> - high - The notification is sent immediately and might wake a sleeping device. /para> Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM. The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message. If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification">Generating a Remote Notification</a> and <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app">Pushing Background Updates to Your App</a> on the Apple Developer website. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_ReplyToAddress</name> <description> <para>The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RestrictedPackageName</name> <description> <para>The package name of the application where registration tokens must match in order for the recipient to receive the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_SenderId</name> <description> <para>The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center. Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background. If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification">Generating a Remote Notification</a> and <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app">Pushing Background Updates to Your App</a> on the Apple Developer website. Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_SilentPush</name> <description> <para>Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Sound</name> <description> <para>The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Sound</name> <description> <para>The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Sound</name> <description> <para>The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Sound</name> <description> <para>The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override these default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Substitution</name> <description> <para>The default message variables to use in the push notification, email, or SMS message. You can override these default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Substitution</name> <description> <para>The default message variables to use in the email message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Substitution</name> <description> <para>The message variables to use in the SMS message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_Substitution</name> <description> <para>The default message variables to use in the voice message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ThreadId</name> <description> <para>The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_TimeToLive</name> <description> <para>The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_TimeToLive</name> <description> <para>The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_TimeToLive</name> <description> <para>The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days). Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Title</name> <description> <para>The title to display above the notification message on the recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Title</name> <description> <para>The title to display above the notification message on the recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Title</name> <description> <para>The title to display above the notification message on the recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Title</name> <description> <para>The default title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Title</name> <description> <para>The title to display above the notification message on the recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SendUsersMessageRequest_TraceId</name> <description> <para>The unique identifier for tracing the message. This identifier is visible to message recipients. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Url</name> <description> <para>The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SendUsersMessageRequest_User</name> <description> <para>A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_VoiceId</name> <description> <para>The name of the voice to use when delivering the message. For a list of supported voices, see the <a href="AmazonPollyDG.html">Amazon Polly Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Action</name> <description> <para>The action to occur if the recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Body</name> <description> <para>The body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ConsolidationKey</name> <description> <para>An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Data</name> <description> <para>The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ExpiresAfter</name> <description> <para>The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_MD5</name> <description> <para>The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Sound</name> <description> <para>The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Title</name> <description> <para>The title to display above the notification message on the recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Action</name> <description> <para>The action to occur if the recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Badge</name> <description> <para>The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Body</name> <description> <para>The body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Category</name> <description> <para>The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_CollapseId</name> <description> <para>An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes. Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Data</name> <description> <para>The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_MediaUrl</name> <description> <para>The URL of an image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_PreferredAuthenticationMethod</name> <description> <para>The authentication method that you want Amazon Pinpoint to use when authenticating with Apple Push Notification service (APNs), CERTIFICATE or TOKEN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Priority</name> <description> <para>para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled. /listitem> - 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device. /para> Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs. The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message. If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification">Generating a Remote Notification</a> and <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app">Pushing Background Updates to Your App</a> on the Apple Developer website. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center. Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background. If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification">Generating a Remote Notification</a> and <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app">Pushing Background Updates to Your App</a> on the Apple Developer website. Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Sound</name> <description> <para>The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override these default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ThreadId</name> <description> <para>The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_TimeToLive</name> <description> <para>The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Title</name> <description> <para>The title to display above the notification message on the recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Action</name> <description> <para>The action to occur if the recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Body</name> <description> <para>The body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Data</name> <description> <para>The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Sound</name> <description> <para>The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_TimeToLive</name> <description> <para>The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Title</name> <description> <para>The title to display above the notification message on the recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Body</name> <description> <para>The default message body of the push notification, email, or SMS message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Substitution</name> <description> <para>The default message variables to use in the push notification, email, or SMS message. You can override these default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Action</name> <description> <para>The default action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Body</name> <description> <para>The default body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Data</name> <description> <para>The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_SilentPush</name> <description> <para>Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Title</name> <description> <para>The default title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Url</name> <description> <para>The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Body</name> <description> <para>The body of the email message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_FeedbackForwardingAddress</name> <description> <para>The email address to forward bounces and complaints to, if feedback forwarding is enabled. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_FromAddress</name> <description> <para>The verified email address to send the email message from. The default value is the FromAddress specified for the email channel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_ReplyToAddress</name> <description> <para>The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Substitution</name> <description> <para>The default message variables to use in the email message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Action</name> <description> <para>The action to occur if the recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Body</name> <description> <para>The body of the notification message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_CollapseKey</name> <description> <para>An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active. Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Data</name> <description> <para>The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Priority</name> <description> <para>para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required. /listitem> - high - The notification is sent immediately and might wake a sleeping device. /para> Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM. The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RestrictedPackageName</name> <description> <para>The package name of the application where registration tokens must match in order for the recipient to receive the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Sound</name> <description> <para>The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Substitution</name> <description> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_TimeToLive</name> <description> <para>The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days). Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Title</name> <description> <para>The title to display above the notification message on the recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HtmlPart_Charset</name> <description> <para>The applicable character set for the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HtmlPart_Data</name> <description> <para>The textual data of the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PushTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RawEmail_Data</name> <description> <para>The email message, represented as a raw MIME message. The entire message must be base64 encoded. </para> </description> <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue> <type> <name>System.Byte[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SendUsersMessageRequest_Context</name> <description> <para>A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SendUsersMessageRequest_TraceId</name> <description> <para>The unique identifier for tracing the message. This identifier is visible to message recipients. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SendUsersMessageRequest_User</name> <description> <para>A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Body</name> <description> <para>The body of the SMS message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Keyword</name> <description> <para>The SMS program name that you provided to AWS Support when you requested your dedicated number. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_MessageType</name> <description> <para>The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.MessageType</parameterValue> <type> <name>Amazon.Pinpoint.MessageType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_OriginationNumber</name> <description> <para>The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_SenderId</name> <description> <para>The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Substitution</name> <description> <para>The message variables to use in the SMS message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Subject_Charset</name> <description> <para>The applicable character set for the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Subject_Data</name> <description> <para>The textual data of the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TextPart_Charset</name> <description> <para>The applicable character set for the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TextPart_Data</name> <description> <para>The textual data of the message content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_Body</name> <description> <para>The text script for the voice message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_LanguageCode</name> <description> <para>The language to use when delivering the message. For a list of supported languages, see the <a href="AmazonPollyDG.html">Amazon Polly Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_OriginationNumber</name> <description> <para>The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_Substitution</name> <description> <para>The default message variables to use in the voice message. You can override the default variables with individual address variables. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceMessage_VoiceId</name> <description> <para>The name of the voice to use when delivering the message. For a list of supported voices, see the <a href="AmazonPollyDG.html">Amazon Polly Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.SendUsersMessageResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.SendUsersMessageResponse object. The service call response (type Amazon.Pinpoint.Model.SendUsersMessagesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Send-PINUserMessageBatch.html&tocid=Send-PINUserMessageBatch</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINAdmChannel</name> <description> <para>Calls the Amazon Pinpoint UpdateAdmChannel API operation.</para> </description> <verb>Update</verb> <noun>PINAdmChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application. </para> </description> <syntax> <syntaxItem> <name>Update-PINAdmChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMChannelRequest_ClientId</name> <description> <para>The Client ID that you received from Amazon to send messages by using ADM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMChannelRequest_ClientSecret</name> <description> <para>The Client Secret that you received from Amazon to send messages by using ADM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the ADM channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMChannelRequest_ClientId</name> <description> <para>The Client ID that you received from Amazon to send messages by using ADM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMChannelRequest_ClientSecret</name> <description> <para>The Client Secret that you received from Amazon to send messages by using ADM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the ADM channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ADMChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ADMChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateAdmChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINAdmChannel.html&tocid=Update-PINAdmChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINApnsChannel</name> <description> <para>Calls the Amazon Pinpoint UpdateApnsChannel API operation.</para> </description> <verb>Update</verb> <noun>PINApnsChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application. </para> </description> <syntax> <syntaxItem> <name>Update-PINApnsChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_BundleId</name> <description> <para>The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_Certificate</name> <description> <para>The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_DefaultAuthenticationMethod</name> <description> <para>The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the APNs channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_PrivateKey</name> <description> <para>The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_TeamId</name> <description> <para>The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_TokenKey</name> <description> <para>The authentication key to use for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_TokenKeyId</name> <description> <para>The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_BundleId</name> <description> <para>The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_Certificate</name> <description> <para>The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_DefaultAuthenticationMethod</name> <description> <para>The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the APNs channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_PrivateKey</name> <description> <para>The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_TeamId</name> <description> <para>The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_TokenKey</name> <description> <para>The authentication key to use for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_TokenKeyId</name> <description> <para>The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.APNSChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateApnsChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINApnsChannel.html&tocid=Update-PINApnsChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINApnsSandboxChannel</name> <description> <para>Calls the Amazon Pinpoint UpdateApnsSandboxChannel API operation.</para> </description> <verb>Update</verb> <noun>PINApnsSandboxChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application. </para> </description> <syntax> <syntaxItem> <name>Update-PINApnsSandboxChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_BundleId</name> <description> <para>The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_Certificate</name> <description> <para>The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_DefaultAuthenticationMethod</name> <description> <para>The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the APNs sandbox channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_PrivateKey</name> <description> <para>The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_TeamId</name> <description> <para>The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_TokenKey</name> <description> <para>The authentication key to use for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_TokenKeyId</name> <description> <para>The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_BundleId</name> <description> <para>The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_Certificate</name> <description> <para>The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_DefaultAuthenticationMethod</name> <description> <para>The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the APNs sandbox channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_PrivateKey</name> <description> <para>The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_TeamId</name> <description> <para>The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_TokenKey</name> <description> <para>The authentication key to use for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_TokenKeyId</name> <description> <para>The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSSandboxChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.APNSSandboxChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateApnsSandboxChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINApnsSandboxChannel.html&tocid=Update-PINApnsSandboxChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINApnsVoipChannel</name> <description> <para>Calls the Amazon Pinpoint UpdateApnsVoipChannel API operation.</para> </description> <verb>Update</verb> <noun>PINApnsVoipChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application. </para> </description> <syntax> <syntaxItem> <name>Update-PINApnsVoipChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_BundleId</name> <description> <para>The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_Certificate</name> <description> <para>The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_DefaultAuthenticationMethod</name> <description> <para>The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the APNs VoIP channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_PrivateKey</name> <description> <para>The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_TeamId</name> <description> <para>The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_TokenKey</name> <description> <para>The authentication key to use for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_TokenKeyId</name> <description> <para>The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_BundleId</name> <description> <para>The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_Certificate</name> <description> <para>The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_DefaultAuthenticationMethod</name> <description> <para>The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the APNs VoIP channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_PrivateKey</name> <description> <para>The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_TeamId</name> <description> <para>The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_TokenKey</name> <description> <para>The authentication key to use for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_TokenKeyId</name> <description> <para>The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSVoipChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.APNSVoipChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateApnsVoipChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINApnsVoipChannel.html&tocid=Update-PINApnsVoipChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINApnsVoipSandboxChannel</name> <description> <para>Calls the Amazon Pinpoint UpdateApnsVoipSandboxChannel API operation.</para> </description> <verb>Update</verb> <noun>PINApnsVoipSandboxChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application. </para> </description> <syntax> <syntaxItem> <name>Update-PINApnsVoipSandboxChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_BundleId</name> <description> <para>The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_Certificate</name> <description> <para>The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_DefaultAuthenticationMethod</name> <description> <para>The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_Enabled</name> <description> <para>Specifies whether the APNs VoIP sandbox channel is enabled for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_PrivateKey</name> <description> <para>The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_TeamId</name> <description> <para>The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_TokenKey</name> <description> <para>The authentication key to use for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_TokenKeyId</name> <description> <para>The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_BundleId</name> <description> <para>The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_Certificate</name> <description> <para>The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_DefaultAuthenticationMethod</name> <description> <para>The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_Enabled</name> <description> <para>Specifies whether the APNs VoIP sandbox channel is enabled for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_PrivateKey</name> <description> <para>The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_TeamId</name> <description> <para>The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_TokenKey</name> <description> <para>The authentication key to use for APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_TokenKeyId</name> <description> <para>The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSVoipSandboxChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.APNSVoipSandboxChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateApnsVoipSandboxChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINApnsVoipSandboxChannel.html&tocid=Update-PINApnsVoipSandboxChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINApplicationSettingList</name> <description> <para>Calls the Amazon Pinpoint UpdateApplicationSettings API operation.</para> </description> <verb>Update</verb> <noun>PINApplicationSettingList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the settings for an application. </para> </description> <syntax> <syntaxItem> <name>Update-PINApplicationSettingList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteApplicationSettingsRequest_CloudWatchMetricsEnabled</name> <description> <para>Specifies whether to enable application-related alarms in Amazon CloudWatch. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Daily</name> <description> <para>The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_End</name> <description> <para>The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignHook_LambdaFunctionName</name> <description> <para>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MaximumDuration</name> <description> <para>The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MessagesPerSecond</name> <description> <para>The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignHook_Mode</name> <description> <para>Specifies which Lambda mode to use when invoking the AWS Lambda function. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Mode</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_Start</name> <description> <para>The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Total</name> <description> <para>The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignHook_WebUrl</name> <description> <para>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignHook_LambdaFunctionName</name> <description> <para>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignHook_Mode</name> <description> <para>Specifies which Lambda mode to use when invoking the AWS Lambda function. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Mode</parameterValue> <type> <name>Amazon.Pinpoint.Mode</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignHook_WebUrl</name> <description> <para>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Daily</name> <description> <para>The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MaximumDuration</name> <description> <para>The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MessagesPerSecond</name> <description> <para>The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Total</name> <description> <para>The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_End</name> <description> <para>The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_Start</name> <description> <para>The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteApplicationSettingsRequest_CloudWatchMetricsEnabled</name> <description> <para>Specifies whether to enable application-related alarms in Amazon CloudWatch. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ApplicationSettingsResource</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.ApplicationSettingsResource object. The service call response (type Amazon.Pinpoint.Model.UpdateApplicationSettingsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINApplicationSettingList.html&tocid=Update-PINApplicationSettingList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINBaiduChannel</name> <description> <para>Calls the Amazon Pinpoint UpdateBaiduChannel API operation.</para> </description> <verb>Update</verb> <noun>PINBaiduChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application. </para> </description> <syntax> <syntaxItem> <name>Update-PINBaiduChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduChannelRequest_ApiKey</name> <description> <para>The API key that you received from the Baidu Cloud Push service to communicate with the service. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the Baidu channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduChannelRequest_SecretKey</name> <description> <para>The secret key that you received from the Baidu Cloud Push service to communicate with the service. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduChannelRequest_ApiKey</name> <description> <para>The API key that you received from the Baidu Cloud Push service to communicate with the service. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the Baidu channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduChannelRequest_SecretKey</name> <description> <para>The secret key that you received from the Baidu Cloud Push service to communicate with the service. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.BaiduChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.BaiduChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateBaiduChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINBaiduChannel.html&tocid=Update-PINBaiduChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINCampaign</name> <description> <para>Calls the Amazon Pinpoint UpdateCampaign API operation.</para> </description> <verb>Update</verb> <noun>PINCampaign</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the settings for a campaign. </para> </description> <syntax> <syntaxItem> <name>Update-PINCampaign</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_AdditionalTreatment</name> <description> <para>An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.WriteTreatmentResource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Attribute</name> <description> <para>One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Body</name> <description> <para>The body of the email for recipients whose email clients don't support HTML content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Body</name> <description> <para>The body of the SMS message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>The unique identifier for the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Daily</name> <description> <para>The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Description</name> <description> <para>The custom description of the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventType_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_End</name> <description> <para>The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_EndTime</name> <description> <para>The scheduled time, in ISO 8601 format, for the campaign to end. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventFilter_FilterType</name> <description> <para>The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.FilterType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_Frequency</name> <description> <para>Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Frequency</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_FromAddress</name> <description> <para>The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_HoldoutPercent</name> <description> <para>The allocated percentage of users (segment members) who shouldn't receive messages from the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_HtmlBody</name> <description> <para>The body of the email, in HTML format, for recipients whose email clients support HTML content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_IsLocalTime</name> <description> <para>Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_IsPaused</name> <description> <para>Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Hook_LambdaFunctionName</name> <description> <para>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MaximumDuration</name> <description> <para>The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MessagesPerSecond</name> <description> <para>The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_MessageType</name> <description> <para>The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.MessageType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Metric</name> <description> <para>One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Hook_Mode</name> <description> <para>Specifies which Lambda mode to use when invoking the AWS Lambda function. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Mode</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Name</name> <description> <para>The custom name of the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PushTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_SegmentId</name> <description> <para>The unique identifier for the segment to associate with the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_SegmentVersion</name> <description> <para>The version of the segment to associate with the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_SenderId</name> <description> <para>The sender ID to display on recipients' devices when they receive the SMS message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_Start</name> <description> <para>The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_StartTime</name> <description> <para>The scheduled time, in ISO 8601 format, for the campaign to begin. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_Timezone</name> <description> <para>The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Title</name> <description> <para>The subject line, or title, of the email. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Total</name> <description> <para>The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_TreatmentDescription</name> <description> <para>The custom description of a variation of the campaign to use for A/B testing. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_TreatmentName</name> <description> <para>The custom name of a variation of the campaign to use for A/B testing. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventType_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Hook_WebUrl</name> <description> <para>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>The unique identifier for the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Attribute</name> <description> <para>One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Metric</name> <description> <para>One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Body</name> <description> <para>The body of the email for recipients whose email clients don't support HTML content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_FromAddress</name> <description> <para>The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_HtmlBody</name> <description> <para>The body of the email, in HTML format, for recipients whose email clients support HTML content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Title</name> <description> <para>The subject line, or title, of the email. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventFilter_FilterType</name> <description> <para>The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.FilterType</parameterValue> <type> <name>Amazon.Pinpoint.FilterType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventType_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventType_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Action</name> <description> <para>The action to occur if a recipient taps the push notification. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Body</name> <description> <para>The body of the notification message. The maximum number of characters is 200. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageIconUrl</name> <description> <para>The URL of the image to display as the push-notification icon, such as the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageSmallIconUrl</name> <description> <para>The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageUrl</name> <description> <para>The URL of an image to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_JsonBody</name> <description> <para>The JSON payload to use for a silent push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_MediaUrl</name> <description> <para>The URL of the image or video to display in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RawContent</name> <description> <para>The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SilentPush</name> <description> <para>Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_TimeToLive</name> <description> <para>The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Title</name> <description> <para>The title to display above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Hook_LambdaFunctionName</name> <description> <para>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Hook_Mode</name> <description> <para>Specifies which Lambda mode to use when invoking the AWS Lambda function. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Mode</parameterValue> <type> <name>Amazon.Pinpoint.Mode</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Hook_WebUrl</name> <description> <para>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Daily</name> <description> <para>The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MaximumDuration</name> <description> <para>The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MessagesPerSecond</name> <description> <para>The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Total</name> <description> <para>The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PushTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_End</name> <description> <para>The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_Start</name> <description> <para>The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_EndTime</name> <description> <para>The scheduled time, in ISO 8601 format, for the campaign to end. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_Frequency</name> <description> <para>Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Frequency</parameterValue> <type> <name>Amazon.Pinpoint.Frequency</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_IsLocalTime</name> <description> <para>Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_StartTime</name> <description> <para>The scheduled time, in ISO 8601 format, for the campaign to begin. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_Timezone</name> <description> <para>The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Body</name> <description> <para>The body of the SMS message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_MessageType</name> <description> <para>The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.MessageType</parameterValue> <type> <name>Amazon.Pinpoint.MessageType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_SenderId</name> <description> <para>The sender ID to display on recipients' devices when they receive the SMS message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSTemplate_Name</name> <description> <para>The name of the message template to use for the message. If specified, this value must match the name of an existing message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_AdditionalTreatment</name> <description> <para>An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.WriteTreatmentResource[]</parameterValue> <type> <name>Amazon.Pinpoint.Model.WriteTreatmentResource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Description</name> <description> <para>The custom description of the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_HoldoutPercent</name> <description> <para>The allocated percentage of users (segment members) who shouldn't receive messages from the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_IsPaused</name> <description> <para>Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Name</name> <description> <para>The custom name of the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_SegmentId</name> <description> <para>The unique identifier for the segment to associate with the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_SegmentVersion</name> <description> <para>The version of the segment to associate with the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_TreatmentDescription</name> <description> <para>The custom description of a variation of the campaign to use for A/B testing. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_TreatmentName</name> <description> <para>The custom name of a variation of the campaign to use for A/B testing. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.CampaignResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.CampaignResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateCampaignResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINCampaign.html&tocid=Update-PINCampaign</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINEmailChannel</name> <description> <para>Calls the Amazon Pinpoint UpdateEmailChannel API operation.</para> </description> <verb>Update</verb> <noun>PINEmailChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables the email channel for an application or updates the status and settings of the email channel for an application. </para> </description> <syntax> <syntaxItem> <name>Update-PINEmailChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailChannelRequest_ConfigurationSet</name> <description> <para>The configuration set that you want to apply to email that you send through the channel by using the <a href="emailAPIreference.html">Amazon Pinpoint Email API</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the email channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailChannelRequest_FromAddress</name> <description> <para>The verified email address that you want to send email from when you send email through the channel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailChannelRequest_Identity</name> <description> <para>The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailChannelRequest_RoleArn</name> <description> <para>The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailChannelRequest_ConfigurationSet</name> <description> <para>The configuration set that you want to apply to email that you send through the channel by using the <a href="emailAPIreference.html">Amazon Pinpoint Email API</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the email channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailChannelRequest_FromAddress</name> <description> <para>The verified email address that you want to send email from when you send email through the channel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailChannelRequest_Identity</name> <description> <para>The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailChannelRequest_RoleArn</name> <description> <para>The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.EmailChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.EmailChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateEmailChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINEmailChannel.html&tocid=Update-PINEmailChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINEmailTemplate</name> <description> <para>Calls the Amazon Pinpoint UpdateEmailTemplate API operation.</para> </description> <verb>Update</verb> <noun>PINEmailTemplate</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates an existing message template that you can use in messages that are sent through the email channel. </para> </description> <syntax> <syntaxItem> <name>Update-PINEmailTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplateRequest_HtmlPart</name> <description> <para>The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that support HTML. You can include links, formatted text, and more in an HTML message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplateRequest_Subject</name> <description> <para>The subject line, or title, to use in email messages that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplateRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplateRequest_TextPart</name> <description> <para>The message body, in text format, to use in email messages that are based on the message template. We recommend using text format for email clients that don't support HTML and clients that are connected to high-latency networks, such as mobile devices. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplateRequest_HtmlPart</name> <description> <para>The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that support HTML. You can include links, formatted text, and more in an HTML message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplateRequest_Subject</name> <description> <para>The subject line, or title, to use in email messages that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplateRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailTemplateRequest_TextPart</name> <description> <para>The message body, in text format, to use in email messages that are based on the message template. We recommend using text format for email clients that don't support HTML and clients that are connected to high-latency networks, such as mobile devices. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.MessageBody</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.MessageBody object. The service call response (type Amazon.Pinpoint.Model.UpdateEmailTemplateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINEmailTemplate.html&tocid=Update-PINEmailTemplate</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINEndpoint</name> <description> <para>Calls the Amazon Pinpoint UpdateEndpoint API operation.</para> </description> <verb>Update</verb> <noun>PINEndpoint</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for an endpoint. </para> </description> <syntax> <syntaxItem> <name>Update-PINEndpoint</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_Address</name> <description> <para>The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_AppVersion</name> <description> <para>The version of the app that's associated with the endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_Attribute</name> <description> <para>One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_ChannelType</name> <description> <para>The channel to use when sending messages or push notifications to the endpoint. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.ChannelType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_City</name> <description> <para>The name of the city where the endpoint is located. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_Country</name> <description> <para>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_EffectiveDate</name> <description> <para>The date and time, in ISO 8601 format, when the endpoint is updated. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointId</name> <description> <para>The unique identifier for the endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_EndpointStatus</name> <description> <para>Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint. Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_Latitude</name> <description> <para>The latitude coordinate of the endpoint location, rounded to one decimal place. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_Locale</name> <description> <para>The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_Longitude</name> <description> <para>The longitude coordinate of the endpoint location, rounded to one decimal place. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_Make</name> <description> <para>The manufacturer of the endpoint device, such as Apple or Samsung. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_Metric</name> <description> <para>One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_Model</name> <description> <para>The model name or number of the endpoint device, such as iPhone. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_ModelVersion</name> <description> <para>The model version of the endpoint device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_OptOut</name> <description> <para>Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_Platform</name> <description> <para>The platform of the endpoint device, such as iOS or Android. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_PlatformVersion</name> <description> <para>The platform version of the endpoint device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_PostalCode</name> <description> <para>The postal or ZIP code for the area where the endpoint is located. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_Region</name> <description> <para>The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_RequestId</name> <description> <para>The unique identifier for the most recent request to update the endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_Timezone</name> <description> <para>The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>User_UserAttribute</name> <description> <para>One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>User_UserId</name> <description> <para>The unique identifier for the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_AppVersion</name> <description> <para>The version of the app that's associated with the endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_Locale</name> <description> <para>The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_Make</name> <description> <para>The manufacturer of the endpoint device, such as Apple or Samsung. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_Model</name> <description> <para>The model name or number of the endpoint device, such as iPhone. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_ModelVersion</name> <description> <para>The model version of the endpoint device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_Platform</name> <description> <para>The platform of the endpoint device, such as iOS or Android. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_PlatformVersion</name> <description> <para>The platform version of the endpoint device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_Timezone</name> <description> <para>The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointId</name> <description> <para>The unique identifier for the endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_Address</name> <description> <para>The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_Attribute</name> <description> <para>One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_ChannelType</name> <description> <para>The channel to use when sending messages or push notifications to the endpoint. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.ChannelType</parameterValue> <type> <name>Amazon.Pinpoint.ChannelType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_EffectiveDate</name> <description> <para>The date and time, in ISO 8601 format, when the endpoint is updated. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_EndpointStatus</name> <description> <para>Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint. Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_Metric</name> <description> <para>One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_OptOut</name> <description> <para>Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_RequestId</name> <description> <para>The unique identifier for the most recent request to update the endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_City</name> <description> <para>The name of the city where the endpoint is located. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_Country</name> <description> <para>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_Latitude</name> <description> <para>The latitude coordinate of the endpoint location, rounded to one decimal place. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> <type> <name>System.Double</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_Longitude</name> <description> <para>The longitude coordinate of the endpoint location, rounded to one decimal place. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> <type> <name>System.Double</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_PostalCode</name> <description> <para>The postal or ZIP code for the area where the endpoint is located. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_Region</name> <description> <para>The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>User_UserAttribute</name> <description> <para>One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>User_UserId</name> <description> <para>The unique identifier for the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.MessageBody</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.MessageBody object. The service call response (type Amazon.Pinpoint.Model.UpdateEndpointResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINEndpoint.html&tocid=Update-PINEndpoint</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINEndpointsBatch</name> <description> <para>Calls the Amazon Pinpoint UpdateEndpointsBatch API operation.</para> </description> <verb>Update</verb> <noun>PINEndpointsBatch</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for a batch of endpoints. </para> </description> <syntax> <syntaxItem> <name>Update-PINEndpointsBatch</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointBatchRequest_Item</name> <description> <para>An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change. An array can contain a maximum of 100 items. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.EndpointBatchItem[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointBatchRequest_Item</name> <description> <para>An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change. An array can contain a maximum of 100 items. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.EndpointBatchItem[]</parameterValue> <type> <name>Amazon.Pinpoint.Model.EndpointBatchItem[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.MessageBody</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.MessageBody object. The service call response (type Amazon.Pinpoint.Model.UpdateEndpointsBatchResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINEndpointsBatch.html&tocid=Update-PINEndpointsBatch</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINGcmChannel</name> <description> <para>Calls the Amazon Pinpoint UpdateGcmChannel API operation.</para> </description> <verb>Update</verb> <noun>PINGcmChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application. </para> </description> <syntax> <syntaxItem> <name>Update-PINGcmChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMChannelRequest_ApiKey</name> <description> <para>The Web API Key, also referred to as an <i>API_KEY</i> or <i>server key</i>, that you received from Google to communicate with Google services. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the GCM channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMChannelRequest_ApiKey</name> <description> <para>The Web API Key, also referred to as an <i>API_KEY</i> or <i>server key</i>, that you received from Google to communicate with Google services. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the GCM channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.GCMChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.GCMChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateGcmChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINGcmChannel.html&tocid=Update-PINGcmChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINPushTemplate</name> <description> <para>Calls the Amazon Pinpoint UpdatePushTemplate API operation.</para> </description> <verb>Update</verb> <noun>PINPushTemplate</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates an existing message template that you can use in messages that are sent through a push notification channel. </para> </description> <syntax> <syntaxItem> <name>Update-PINPushTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Body</name> <description> <para>The message body to use in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Body</name> <description> <para>The message body to use in push notifications that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Body</name> <description> <para>The message body to use in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Body</name> <description> <para>The message body to use in push notifications that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Body</name> <description> <para>The message body to use in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_ImageUrl</name> <description> <para>The URL of an image to display in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_ImageUrl</name> <description> <para>The URL of an image to display in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_ImageUrl</name> <description> <para>The URL of an image to display in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_MediaUrl</name> <description> <para>The URL of an image or video to display in push notifications that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Sound</name> <description> <para>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Sound</name> <description> <para>The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Sound</name> <description> <para>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Sound</name> <description> <para>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Sound</name> <description> <para>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PushNotificationTemplateRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Title</name> <description> <para>The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Title</name> <description> <para>The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Title</name> <description> <para>The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Title</name> <description> <para>The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Title</name> <description> <para>The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Body</name> <description> <para>The message body to use in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_ImageUrl</name> <description> <para>The URL of an image to display in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Sound</name> <description> <para>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Title</name> <description> <para>The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADM_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Body</name> <description> <para>The message body to use in push notifications that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_MediaUrl</name> <description> <para>The URL of an image or video to display in push notifications that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Sound</name> <description> <para>The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Title</name> <description> <para>The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNS_Url</name> <description> <para>The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Body</name> <description> <para>The message body to use in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_ImageUrl</name> <description> <para>The URL of an image to display in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Sound</name> <description> <para>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Title</name> <description> <para>The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Baidu_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Body</name> <description> <para>The message body to use in push notifications that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Sound</name> <description> <para>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Title</name> <description> <para>The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Default_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Action</name> <description> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Body</name> <description> <para>The message body to use in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_ImageIconUrl</name> <description> <para>The URL of the large icon image to display in the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_ImageUrl</name> <description> <para>The URL of an image to display in a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_SmallImageIconUrl</name> <description> <para>The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Sound</name> <description> <para>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Title</name> <description> <para>The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCM_Url</name> <description> <para>The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PushNotificationTemplateRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.MessageBody</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.MessageBody object. The service call response (type Amazon.Pinpoint.Model.UpdatePushTemplateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINPushTemplate.html&tocid=Update-PINPushTemplate</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINSegment</name> <description> <para>Calls the Amazon Pinpoint UpdateSegment API operation.</para> </description> <verb>Update</verb> <noun>PINSegment</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application. </para> </description> <syntax> <syntaxItem> <name>Update-PINSegment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Attribute</name> <description> <para>One or more custom attributes to use as criteria for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppVersion_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Channel_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeviceType_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Make_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Model_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Platform_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Country_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Recency_Duration</name> <description> <para>The duration to use when determining whether an endpoint is active or inactive. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Duration</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentGroups_Group</name> <description> <para>An array that defines the set of segment criteria to evaluate when handling segment groups for the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.SegmentGroup[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentGroups_Include</name> <description> <para>Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Include</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Coordinates_Latitude</name> <description> <para>The latitude coordinate of the location. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Coordinates_Longitude</name> <description> <para>The longitude coordinate of the location. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Metric</name> <description> <para>One or more custom metrics to use as criteria for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteSegmentRequest_Name</name> <description> <para>The name of the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GPSPoint_RangeInKilometer</name> <description> <para>The range, in kilometers, from the GPS coordinates. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Recency_RecencyType</name> <description> <para>The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.RecencyType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>The unique identifier for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteSegmentRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_UserAttribute</name> <description> <para>One or more custom user attributes to use as criteria for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppVersion_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Channel_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeviceType_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Make_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Model_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Platform_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Country_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppVersion_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppVersion_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Channel_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Channel_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Coordinates_Latitude</name> <description> <para>The latitude coordinate of the location. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> <type> <name>System.Double</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Coordinates_Longitude</name> <description> <para>The longitude coordinate of the location. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> <type> <name>System.Double</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Country_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Country_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeviceType_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeviceType_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Attribute</name> <description> <para>One or more custom attributes to use as criteria for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Metric</name> <description> <para>One or more custom metrics to use as criteria for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_UserAttribute</name> <description> <para>One or more custom user attributes to use as criteria for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GPSPoint_RangeInKilometer</name> <description> <para>The range, in kilometers, from the GPS coordinates. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> <type> <name>System.Double</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Make_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Make_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Model_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Model_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Platform_DimensionType</name> <description> <para>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Platform_Value</name> <description> <para>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Recency_Duration</name> <description> <para>The duration to use when determining whether an endpoint is active or inactive. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Duration</parameterValue> <type> <name>Amazon.Pinpoint.Duration</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Recency_RecencyType</name> <description> <para>The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.RecencyType</parameterValue> <type> <name>Amazon.Pinpoint.RecencyType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentGroups_Group</name> <description> <para>An array that defines the set of segment criteria to evaluate when handling segment groups for the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.SegmentGroup[]</parameterValue> <type> <name>Amazon.Pinpoint.Model.SegmentGroup[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentGroups_Include</name> <description> <para>Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Include</parameterValue> <type> <name>Amazon.Pinpoint.Include</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>The unique identifier for the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteSegmentRequest_Name</name> <description> <para>The name of the segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteSegmentRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.SegmentResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.SegmentResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateSegmentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINSegment.html&tocid=Update-PINSegment</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINSmsChannel</name> <description> <para>Calls the Amazon Pinpoint UpdateSmsChannel API operation.</para> </description> <verb>Update</verb> <noun>PINSmsChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application. </para> </description> <syntax> <syntaxItem> <name>Update-PINSmsChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the SMS channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSChannelRequest_SenderId</name> <description> <para>The identity that you want to display on recipients' devices when they receive messages from the SMS channel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSChannelRequest_ShortCode</name> <description> <para>The registered short code that you want to use when you send messages through the SMS channel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the SMS channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSChannelRequest_SenderId</name> <description> <para>The identity that you want to display on recipients' devices when they receive messages from the SMS channel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSChannelRequest_ShortCode</name> <description> <para>The registered short code that you want to use when you send messages through the SMS channel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.SMSChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.SMSChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateSmsChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINSmsChannel.html&tocid=Update-PINSmsChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINSmsTemplate</name> <description> <para>Calls the Amazon Pinpoint UpdateSmsTemplate API operation.</para> </description> <verb>Update</verb> <noun>PINSmsTemplate</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates an existing message template that you can use in messages that are sent through the SMS channel. </para> </description> <syntax> <syntaxItem> <name>Update-PINSmsTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSTemplateRequest_Body</name> <description> <para>The message body to use in text messages that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSTemplateRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSTemplateRequest_Body</name> <description> <para>The message body to use in text messages that are based on the message template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSTemplateRequest_Tag</name> <description> <para>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.MessageBody</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.MessageBody object. The service call response (type Amazon.Pinpoint.Model.UpdateSmsTemplateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINSmsTemplate.html&tocid=Update-PINSmsTemplate</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-PINVoiceChannel</name> <description> <para>Calls the Amazon Pinpoint UpdateVoiceChannel API operation.</para> </description> <verb>Update</verb> <noun>PINVoiceChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables the voice channel for an application or updates the status and settings of the voice channel for an application. </para> </description> <syntax> <syntaxItem> <name>Update-PINVoiceChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the voice channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceChannelRequest_Enabled</name> <description> <para>Specifies whether to enable the voice channel for the application. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.VoiceChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.VoiceChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateVoiceChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-PINVoiceChannel.html&tocid=Update-PINVoiceChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Write-PINEvent</name> <description> <para>Calls the Amazon Pinpoint PutEvents API operation.</para> </description> <verb>Write</verb> <noun>PINEvent</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with. </para> </description> <syntax> <syntaxItem> <name>Write-PINEvent</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventsRequest_BatchItem</name> <description> <para>The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventsRequest_BatchItem</name> <description> <para>The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.EventsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.EventsResponse object. The service call response (type Amazon.Pinpoint.Model.PutEventsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Write-PINEvent.html&tocid=Write-PINEvent</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Write-PINEventStream</name> <description> <para>Calls the Amazon Pinpoint PutEventStream API operation.</para> </description> <verb>Write</verb> <noun>PINEventStream</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new event stream for an application or updates the settings of an existing event stream for an application. </para> </description> <syntax> <syntaxItem> <name>Write-PINEventStream</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteEventStream_DestinationStreamArn</name> <description> <para>The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to. For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteEventStream_RoleArn</name> <description> <para>The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteEventStream_DestinationStreamArn</name> <description> <para>The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to. For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteEventStream_RoleArn</name> <description> <para>The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.EventStream</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Pinpoint.Model.EventStream object. The service call response (type Amazon.Pinpoint.Model.PutEventStreamResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Write-PINEventStream.html&tocid=Write-PINEventStream</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> </helpItems> |