AWS.Tools.Pinpoint.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Pinpoint</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.PIN.AddPINResourceTagCmdlet"> <summary> Adds one or more tags (keys and values) to an application, campaign, message template, or segment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.AddPINResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.AddPINResourceTagCmdlet.TagsModel_Tag"> <summary> <para> <para>A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.</para><para>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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.AddPINResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.AddPINResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.ConfirmPINOTPMessageCmdlet"> <summary> Verify an OTP </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.ConfirmPINOTPMessageCmdlet.ApplicationId"> <summary> <para> <para>The unique ID of your Amazon Pinpoint application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.ConfirmPINOTPMessageCmdlet.VerifyOTPMessageRequestParameters_DestinationIdentity"> <summary> <para> <para>The destination identity to send OTP to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.ConfirmPINOTPMessageCmdlet.VerifyOTPMessageRequestParameters_Otp"> <summary> <para> <para>The OTP the end user provided for verification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.ConfirmPINOTPMessageCmdlet.VerifyOTPMessageRequestParameters_ReferenceId"> <summary> <para> <para>The reference identifier provided when the OTP was previously sent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.ConfirmPINOTPMessageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VerificationResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.VerifyOTPMessageResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.VerifyOTPMessageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.ConfirmPINOTPMessageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.ConfirmPINPhoneNumberCmdlet"> <summary> Retrieves information about a phone number. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.ConfirmPINPhoneNumberCmdlet.PhoneNumber"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.ConfirmPINPhoneNumberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NumberValidateResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.PhoneNumberValidateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.PhoneNumberValidateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.ConfirmPINPhoneNumberCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINAdmChannelCmdlet"> <summary> Retrieves information about the status and settings of the ADM channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINAdmChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINAdmChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ADMChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetAdmChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetAdmChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINApnsChannelCmdlet"> <summary> Retrieves information about the status and settings of the APNs channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApnsChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApnsChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'APNSChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetApnsChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetApnsChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINApnsSandboxChannelCmdlet"> <summary> Retrieves information about the status and settings of the APNs sandbox channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApnsSandboxChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApnsSandboxChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'APNSSandboxChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetApnsSandboxChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetApnsSandboxChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINApnsVoipChannelCmdlet"> <summary> Retrieves information about the status and settings of the APNs VoIP channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApnsVoipChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApnsVoipChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'APNSVoipChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetApnsVoipChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetApnsVoipChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINApnsVoipSandboxChannelCmdlet"> <summary> Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApnsVoipSandboxChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApnsVoipSandboxChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'APNSVoipSandboxChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetApnsVoipSandboxChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetApnsVoipSandboxChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINAppCmdlet"> <summary> Retrieves information about an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINAppCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINAppCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApplicationResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetAppResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetAppResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINApplicationDateRangeKpiCmdlet"> <summary> Retrieves (queries) pre-aggregated data for a standard metric that applies to an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApplicationDateRangeKpiCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApplicationDateRangeKpiCmdlet.EndTime"> <summary> <para> <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 and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApplicationDateRangeKpiCmdlet.KpiName"> <summary> <para> <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="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApplicationDateRangeKpiCmdlet.StartTime"> <summary> <para> <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 and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApplicationDateRangeKpiCmdlet.NextToken"> <summary> <para> <para>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApplicationDateRangeKpiCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApplicationDateRangeKpiCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApplicationDateRangeKpiResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetApplicationDateRangeKpiResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetApplicationDateRangeKpiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINApplicationSettingListCmdlet"> <summary> Retrieves information about the settings for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApplicationSettingListCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINApplicationSettingListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApplicationSettingsResource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetApplicationSettingsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetApplicationSettingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINAppListCmdlet"> <summary> Retrieves information about all the applications that are associated with your Amazon Pinpoint account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINAppListCmdlet.Token"> <summary> <para> <para>The NextToken string that specifies which page of results to return in a paginated response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINAppListCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINAppListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApplicationsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetAppsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetAppsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINBaiduChannelCmdlet"> <summary> Retrieves information about the status and settings of the Baidu channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINBaiduChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINBaiduChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BaiduChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetBaiduChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetBaiduChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignCmdlet"> <summary> Retrieves information about the status, configuration, and other settings for a campaign. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignCmdlet.CampaignId"> <summary> <para> <para>The unique identifier for the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CampaignResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetCampaignResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetCampaignResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignActivityListCmdlet"> <summary> Retrieves information about all the activities for a campaign. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignActivityListCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignActivityListCmdlet.CampaignId"> <summary> <para> <para>The unique identifier for the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignActivityListCmdlet.Token"> <summary> <para> <para>The NextToken string that specifies which page of results to return in a paginated response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignActivityListCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignActivityListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ActivitiesResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetCampaignActivitiesResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetCampaignActivitiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignDateRangeKpiCmdlet"> <summary> Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignDateRangeKpiCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignDateRangeKpiCmdlet.CampaignId"> <summary> <para> <para>The unique identifier for the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignDateRangeKpiCmdlet.EndTime"> <summary> <para> <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 and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignDateRangeKpiCmdlet.KpiName"> <summary> <para> <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="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignDateRangeKpiCmdlet.StartTime"> <summary> <para> <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 and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignDateRangeKpiCmdlet.NextToken"> <summary> <para> <para>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignDateRangeKpiCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignDateRangeKpiCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CampaignDateRangeKpiResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetCampaignDateRangeKpiResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetCampaignDateRangeKpiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignListCmdlet"> <summary> Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignListCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignListCmdlet.Token"> <summary> <para> <para>The NextToken string that specifies which page of results to return in a paginated response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignListCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CampaignsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetCampaignsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetCampaignsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignVersionCmdlet"> <summary> Retrieves information about the status, configuration, and other settings for a specific version of a campaign. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignVersionCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignVersionCmdlet.CampaignId"> <summary> <para> <para>The unique identifier for the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignVersionCmdlet.Version"> <summary> <para> <para>The unique version number (Version property) for the campaign version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CampaignResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetCampaignVersionResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetCampaignVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignVersionListCmdlet"> <summary> Retrieves information about the status, configuration, and other settings for all versions of a campaign. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignVersionListCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignVersionListCmdlet.CampaignId"> <summary> <para> <para>The unique identifier for the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignVersionListCmdlet.Token"> <summary> <para> <para>The NextToken string that specifies which page of results to return in a paginated response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignVersionListCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINCampaignVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CampaignsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetCampaignVersionsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetCampaignVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINChannelCmdlet"> <summary> Retrieves information about the history and status of each channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetChannelsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetChannelsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINEmailChannelCmdlet"> <summary> Retrieves information about the status and settings of the email channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINEmailChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINEmailChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EmailChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetEmailChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetEmailChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINEmailTemplateCmdlet"> <summary> Retrieves the content and settings of a message template for messages that are sent through the email channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINEmailTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINEmailTemplateCmdlet.Version"> <summary> <para> <para>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</para><ul><li><para>For a get operation, retrieves information about the active version of the template.</para></li><li><para>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</para></li><li><para>For a delete operation, deletes the template, including all versions of the template.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINEmailTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EmailTemplateResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetEmailTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetEmailTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINEndpointCmdlet"> <summary> Retrieves information about the settings and attributes of a specific endpoint for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINEndpointCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINEndpointCmdlet.EndpointId"> <summary> <para> <para>The case insensitive unique identifier for the endpoint. The identifier can't contain <c>$</c>, <c>{</c> or <c>}</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetEndpointResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINEventStreamCmdlet"> <summary> Retrieves information about the event stream settings for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINEventStreamCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINEventStreamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventStream'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetEventStreamResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetEventStreamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINExportJobCmdlet"> <summary> Retrieves information about the status and settings of a specific export job for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINExportJobCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINExportJobCmdlet.JobId"> <summary> <para> <para>The unique identifier for the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINExportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExportJobResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetExportJobResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetExportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINExportJobListCmdlet"> <summary> Retrieves information about the status and settings of all the export jobs for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINExportJobListCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINExportJobListCmdlet.Token"> <summary> <para> <para>The NextToken string that specifies which page of results to return in a paginated response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINExportJobListCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINExportJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExportJobsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetExportJobsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetExportJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINGcmChannelCmdlet"> <summary> Retrieves information about the status and settings of the GCM channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINGcmChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINGcmChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GCMChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetGcmChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetGcmChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINImportJobCmdlet"> <summary> Retrieves information about the status and settings of a specific import job for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINImportJobCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINImportJobCmdlet.JobId"> <summary> <para> <para>The unique identifier for the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINImportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImportJobResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetImportJobResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetImportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINImportJobListCmdlet"> <summary> Retrieves information about the status and settings of all the import jobs for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINImportJobListCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINImportJobListCmdlet.Token"> <summary> <para> <para>The NextToken string that specifies which page of results to return in a paginated response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINImportJobListCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINImportJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImportJobsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetImportJobsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetImportJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINInAppMessageCmdlet"> <summary> Retrieves the in-app messages targeted for the provided endpoint ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINInAppMessageCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINInAppMessageCmdlet.EndpointId"> <summary> <para> <para>The unique identifier for the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINInAppMessageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InAppMessagesResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetInAppMessagesResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetInAppMessagesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINInAppTemplateCmdlet"> <summary> Retrieves the content and settings of a message template for messages sent through the in-app channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINInAppTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINInAppTemplateCmdlet.Version"> <summary> <para> <para>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</para><ul><li><para>For a get operation, retrieves information about the active version of the template.</para></li><li><para>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</para></li><li><para>For a delete operation, deletes the template, including all versions of the template.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINInAppTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InAppTemplateResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetInAppTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetInAppTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyCmdlet"> <summary> Retrieves information about the status, configuration, and other settings for a journey. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyCmdlet.JourneyId"> <summary> <para> <para>The unique identifier for the journey.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JourneyResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetJourneyResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetJourneyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyDateRangeKpiCmdlet"> <summary> Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyDateRangeKpiCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyDateRangeKpiCmdlet.EndTime"> <summary> <para> <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 and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyDateRangeKpiCmdlet.JourneyId"> <summary> <para> <para>The unique identifier for the journey.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyDateRangeKpiCmdlet.KpiName"> <summary> <para> <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="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyDateRangeKpiCmdlet.StartTime"> <summary> <para> <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 and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyDateRangeKpiCmdlet.NextToken"> <summary> <para> <para>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyDateRangeKpiCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyDateRangeKpiCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JourneyDateRangeKpiResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetJourneyDateRangeKpiResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetJourneyDateRangeKpiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyExecutionActivityMetricCmdlet"> <summary> Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyExecutionActivityMetricCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyExecutionActivityMetricCmdlet.JourneyActivityId"> <summary> <para> <para>The unique identifier for the journey activity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyExecutionActivityMetricCmdlet.JourneyId"> <summary> <para> <para>The unique identifier for the journey.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyExecutionActivityMetricCmdlet.NextToken"> <summary> <para> <para>The <code /> string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyExecutionActivityMetricCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyExecutionActivityMetricCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JourneyExecutionActivityMetricsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetJourneyExecutionActivityMetricsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetJourneyExecutionActivityMetricsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyExecutionMetricCmdlet"> <summary> Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyExecutionMetricCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyExecutionMetricCmdlet.JourneyId"> <summary> <para> <para>The unique identifier for the journey.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyExecutionMetricCmdlet.NextToken"> <summary> <para> <para>The <code /> string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyExecutionMetricCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyExecutionMetricCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JourneyExecutionMetricsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetJourneyExecutionMetricsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetJourneyExecutionMetricsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyListCmdlet"> <summary> Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyListCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyListCmdlet.Token"> <summary> <para> <para>The NextToken string that specifies which page of results to return in a paginated response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyListCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JourneysResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.ListJourneysResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.ListJourneysResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunCmdlet"> <summary> Provides information about the runs of a journey. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunCmdlet.JourneyId"> <summary> <para> <para>The unique identifier for the journey.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunCmdlet.Token"> <summary> <para> <para>The NextToken string that specifies which page of results to return in a paginated response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JourneyRunsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetJourneyRunsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetJourneyRunsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunExecutionActivityMetricCmdlet"> <summary> Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunExecutionActivityMetricCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunExecutionActivityMetricCmdlet.JourneyActivityId"> <summary> <para> <para>The unique identifier for the journey activity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunExecutionActivityMetricCmdlet.JourneyId"> <summary> <para> <para>The unique identifier for the journey.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunExecutionActivityMetricCmdlet.RunId"> <summary> <para> <para>The unique identifier for the journey run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunExecutionActivityMetricCmdlet.NextToken"> <summary> <para> <para>The <code /> string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunExecutionActivityMetricCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunExecutionActivityMetricCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JourneyRunExecutionActivityMetricsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetJourneyRunExecutionActivityMetricsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetJourneyRunExecutionActivityMetricsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunExecutionMetricCmdlet"> <summary> Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunExecutionMetricCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunExecutionMetricCmdlet.JourneyId"> <summary> <para> <para>The unique identifier for the journey.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunExecutionMetricCmdlet.RunId"> <summary> <para> <para>The unique identifier for the journey run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunExecutionMetricCmdlet.NextToken"> <summary> <para> <para>The <code /> string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunExecutionMetricCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINJourneyRunExecutionMetricCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JourneyRunExecutionMetricsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetJourneyRunExecutionMetricsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetJourneyRunExecutionMetricsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINPushTemplateCmdlet"> <summary> Retrieves the content and settings of a message template for messages that are sent through a push notification channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINPushTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINPushTemplateCmdlet.Version"> <summary> <para> <para>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</para><ul><li><para>For a get operation, retrieves information about the active version of the template.</para></li><li><para>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</para></li><li><para>For a delete operation, deletes the template, including all versions of the template.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINPushTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PushNotificationTemplateResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetPushTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetPushTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINRecommenderConfigurationCmdlet"> <summary> Retrieves information about an Amazon Pinpoint configuration for a recommender model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINRecommenderConfigurationCmdlet.RecommenderId"> <summary> <para> <para>The unique identifier for the recommender model configuration. This identifier is displayed as the <b>Recommender ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINRecommenderConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RecommenderConfigurationResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetRecommenderConfigurationResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetRecommenderConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINRecommenderConfigurationListCmdlet"> <summary> Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINRecommenderConfigurationListCmdlet.Token"> <summary> <para> <para>The NextToken string that specifies which page of results to return in a paginated response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINRecommenderConfigurationListCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINRecommenderConfigurationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ListRecommenderConfigurationsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetRecommenderConfigurationsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetRecommenderConfigurationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINResourceTagCmdlet"> <summary> Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TagsModel'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentCmdlet"> <summary> Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentCmdlet.SegmentId"> <summary> <para> <para>The unique identifier for the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SegmentResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetSegmentResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetSegmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentExportJobListCmdlet"> <summary> Retrieves information about the status and settings of the export jobs for a segment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentExportJobListCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentExportJobListCmdlet.SegmentId"> <summary> <para> <para>The unique identifier for the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentExportJobListCmdlet.Token"> <summary> <para> <para>The NextToken string that specifies which page of results to return in a paginated response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentExportJobListCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentExportJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExportJobsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetSegmentExportJobsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetSegmentExportJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentImportJobListCmdlet"> <summary> Retrieves information about the status and settings of the import jobs for a segment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentImportJobListCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentImportJobListCmdlet.SegmentId"> <summary> <para> <para>The unique identifier for the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentImportJobListCmdlet.Token"> <summary> <para> <para>The NextToken string that specifies which page of results to return in a paginated response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentImportJobListCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentImportJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImportJobsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetSegmentImportJobsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetSegmentImportJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentListCmdlet"> <summary> Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentListCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentListCmdlet.Token"> <summary> <para> <para>The NextToken string that specifies which page of results to return in a paginated response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentListCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SegmentsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetSegmentsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetSegmentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentVersionCmdlet"> <summary> Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentVersionCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentVersionCmdlet.SegmentId"> <summary> <para> <para>The unique identifier for the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentVersionCmdlet.Version"> <summary> <para> <para>The unique version number (Version property) for the campaign version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SegmentResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetSegmentVersionResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetSegmentVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentVersionListCmdlet"> <summary> Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentVersionListCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentVersionListCmdlet.SegmentId"> <summary> <para> <para>The unique identifier for the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentVersionListCmdlet.Token"> <summary> <para> <para>The NextToken string that specifies which page of results to return in a paginated response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentVersionListCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSegmentVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SegmentsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetSegmentVersionsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetSegmentVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINSmsChannelCmdlet"> <summary> Retrieves information about the status and settings of the SMS channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSmsChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSmsChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SMSChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetSmsChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetSmsChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINSmsTemplateCmdlet"> <summary> Retrieves the content and settings of a message template for messages that are sent through the SMS channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSmsTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSmsTemplateCmdlet.Version"> <summary> <para> <para>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</para><ul><li><para>For a get operation, retrieves information about the active version of the template.</para></li><li><para>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</para></li><li><para>For a delete operation, deletes the template, including all versions of the template.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINSmsTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SMSTemplateResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetSmsTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetSmsTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINTemplateListCmdlet"> <summary> Retrieves information about all the message templates that are associated with your Amazon Pinpoint account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINTemplateListCmdlet.Prefix"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINTemplateListCmdlet.TemplateType"> <summary> <para> <para>The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINTemplateListCmdlet.NextToken"> <summary> <para> <para>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINTemplateListCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINTemplateListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TemplatesResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.ListTemplatesResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.ListTemplatesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINTemplateVersionListCmdlet"> <summary> Retrieves information about all the versions of a specific message template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINTemplateVersionListCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINTemplateVersionListCmdlet.TemplateType"> <summary> <para> <para>The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINTemplateVersionListCmdlet.NextToken"> <summary> <para> <para>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINTemplateVersionListCmdlet.PageSize"> <summary> <para> <para>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINTemplateVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TemplateVersionsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.ListTemplateVersionsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.ListTemplateVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINUserEndpointCmdlet"> <summary> Retrieves information about all the endpoints that are associated with a specific user ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINUserEndpointCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINUserEndpointCmdlet.UserId"> <summary> <para> <para>The unique identifier for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINUserEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetUserEndpointsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetUserEndpointsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINVoiceChannelCmdlet"> <summary> Retrieves information about the status and settings of the voice channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINVoiceChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINVoiceChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VoiceChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetVoiceChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetVoiceChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.GetPINVoiceTemplateCmdlet"> <summary> Retrieves the content and settings of a message template for messages that are sent through the voice channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINVoiceTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINVoiceTemplateCmdlet.Version"> <summary> <para> <para>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</para><ul><li><para>For a get operation, retrieves information about the active version of the template.</para></li><li><para>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</para></li><li><para>For a delete operation, deletes the template, including all versions of the template.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.GetPINVoiceTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VoiceTemplateResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetVoiceTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.GetVoiceTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.NewPINAppCmdlet"> <summary> Creates an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINAppCmdlet.CreateApplicationRequest_Name"> <summary> <para> <para>The display name of the application. This name is displayed as the <b>Project name</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINAppCmdlet.CreateApplicationRequest_Tag"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINAppCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApplicationResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.CreateAppResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.CreateAppResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINAppCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet"> <summary> Creates a new campaign for an application or updates the settings of an existing campaign for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.ADMMessage_Action"> <summary> <para> <para>The action to occur if a recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.APNSMessage_Action"> <summary> <para> <para>The action to occur if a recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.BaiduMessage_Action"> <summary> <para> <para>The action to occur if a recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.DefaultMessage_Action"> <summary> <para> <para>The action to occur if a recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.GCMMessage_Action"> <summary> <para> <para>The action to occur if a recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.WriteCampaignRequest_AdditionalTreatment"> <summary> <para> <para>An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Dimensions_Attribute"> <summary> <para> <para>One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.ADMMessage_Body"> <summary> <para> <para>The body of the notification message. The maximum number of characters is 200.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.APNSMessage_Body"> <summary> <para> <para>The body of the notification message. The maximum number of characters is 200.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.BaiduMessage_Body"> <summary> <para> <para>The body of the notification message. The maximum number of characters is 200.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.DefaultMessage_Body"> <summary> <para> <para>The body of the notification message. The maximum number of characters is 200.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.EmailMessage_Body"> <summary> <para> <para>The body of the email for recipients whose email clients don't render HTML content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.GCMMessage_Body"> <summary> <para> <para>The body of the notification message. The maximum number of characters is 200.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.InAppMessage_Body"> <summary> <para> <para>The message body of the notification, the email body or the text message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.SMSMessage_Body"> <summary> <para> <para>The body of the SMS message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.InAppMessage_Content"> <summary> <para> <para>In-app message content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.InAppMessage_CustomConfig"> <summary> <para> <para>Custom config to be sent to client.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Limits_Daily"> <summary> <para> <para>The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.CustomMessage_Data"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.CustomDeliveryConfiguration_DeliveryUri"> <summary> <para> <para>The destination to send the campaign or treatment to. This value can be one of the following:</para><ul><li><para>The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.</para></li><li><para>The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.WriteCampaignRequest_Description"> <summary> <para> <para>A custom description of the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.EventType_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.QuietTime_End"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.CustomDeliveryConfiguration_EndpointType"> <summary> <para> <para>The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Schedule_EndTime"> <summary> <para> <para>The scheduled time, in ISO 8601 format, when the campaign ended or will end.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.SMSMessage_EntityId"> <summary> <para> <para>The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.EventFilter_FilterType"> <summary> <para> <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 (<link linkend="apps-application-id-events">Events</link> resource) occurs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Schedule_Frequency"> <summary> <para> <para>Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.EmailMessage_FromAddress"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.EmailMessage_Header"> <summary> <para> <para>The list of <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-campaigns-campaign-id.html#apps-application-id-campaigns-campaign-id-model-messageheader">MessageHeaders</a> for the email. You can have up to 15 MessageHeaders for each email.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.WriteCampaignRequest_HoldoutPercent"> <summary> <para> <para>The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.EmailMessage_HtmlBody"> <summary> <para> <para>The body of the email, in HTML format, for recipients whose email clients render HTML content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.ADMMessage_ImageIconUrl"> <summary> <para> <para>The URL of the image to display as the push-notification icon, such as the icon for the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.APNSMessage_ImageIconUrl"> <summary> <para> <para>The URL of the image to display as the push-notification icon, such as the icon for the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.BaiduMessage_ImageIconUrl"> <summary> <para> <para>The URL of the image to display as the push-notification icon, such as the icon for the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.DefaultMessage_ImageIconUrl"> <summary> <para> <para>The URL of the image to display as the push-notification icon, such as the icon for the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.GCMMessage_ImageIconUrl"> <summary> <para> <para>The URL of the image to display as the push-notification icon, such as the icon for the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.ADMMessage_ImageSmallIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.APNSMessage_ImageSmallIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.BaiduMessage_ImageSmallIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.DefaultMessage_ImageSmallIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.GCMMessage_ImageSmallIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.ADMMessage_ImageUrl"> <summary> <para> <para>The URL of an image to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.APNSMessage_ImageUrl"> <summary> <para> <para>The URL of an image to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.BaiduMessage_ImageUrl"> <summary> <para> <para>The URL of an image to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.DefaultMessage_ImageUrl"> <summary> <para> <para>The URL of an image to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.GCMMessage_ImageUrl"> <summary> <para> <para>The URL of an image to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Schedule_IsLocalTime"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.WriteCampaignRequest_IsPaused"> <summary> <para> <para>Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.ADMMessage_JsonBody"> <summary> <para> <para>The JSON payload to use for a silent push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.APNSMessage_JsonBody"> <summary> <para> <para>The JSON payload to use for a silent push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.BaiduMessage_JsonBody"> <summary> <para> <para>The JSON payload to use for a silent push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.DefaultMessage_JsonBody"> <summary> <para> <para>The JSON payload to use for a silent push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.GCMMessage_JsonBody"> <summary> <para> <para>The JSON payload to use for a silent push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Hook_LambdaFunctionName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.InAppMessage_Layout"> <summary> <para> <para>In-app message layout.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Limits_MaximumDuration"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.ADMMessage_MediaUrl"> <summary> <para> <para>The URL of the image or video to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.APNSMessage_MediaUrl"> <summary> <para> <para>The URL of the image or video to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.BaiduMessage_MediaUrl"> <summary> <para> <para>The URL of the image or video to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.DefaultMessage_MediaUrl"> <summary> <para> <para>The URL of the image or video to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.GCMMessage_MediaUrl"> <summary> <para> <para>The URL of the image or video to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Limits_MessagesPerSecond"> <summary> <para> <para>The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.SMSMessage_MessageType"> <summary> <para> <para>The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Dimensions_Metric"> <summary> <para> <para>One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Hook_Mode"> <summary> <para> <para>The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:</para><ul><li><para>FILTER - Invoke the function to customize the segment that's used by a campaign.</para></li><li><para>DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.WriteCampaignRequest_Name"> <summary> <para> <para>A custom name for the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.EmailTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.InAppTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.PushTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.SMSTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.VoiceTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.SMSMessage_OriginationNumber"> <summary> <para> <para>The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.WriteCampaignRequest_Priority"> <summary> <para> <para>Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.ADMMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.APNSMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.BaiduMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.DefaultMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.GCMMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.WriteCampaignRequest_SegmentId"> <summary> <para> <para>The unique identifier for the segment to associate with the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.WriteCampaignRequest_SegmentVersion"> <summary> <para> <para>The version of the segment to associate with the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.SMSMessage_SenderId"> <summary> <para> <para>The sender ID to display on recipients' devices when they receive the SMS message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Limits_Session"> <summary> <para> <para>The maximum total number of messages that the campaign can send per user session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.ADMMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.APNSMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.BaiduMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.DefaultMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.GCMMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.QuietTime_Start"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Schedule_StartTime"> <summary> <para> <para>The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.WriteCampaignRequest_Tag"> <summary> <para> <note><para>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</para></note><para>(Deprecated) 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.SMSMessage_TemplateId"> <summary> <para> <para>The template ID received from the regulatory body for sending SMS in your country.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.ADMMessage_TimeToLive"> <summary> <para> <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.</para><para>This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.APNSMessage_TimeToLive"> <summary> <para> <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.</para><para>This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.BaiduMessage_TimeToLive"> <summary> <para> <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.</para><para>This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.DefaultMessage_TimeToLive"> <summary> <para> <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.</para><para>This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.GCMMessage_TimeToLive"> <summary> <para> <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.</para><para>This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Schedule_Timezone"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.ADMMessage_Title"> <summary> <para> <para>The title to display above the notification message on a recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.APNSMessage_Title"> <summary> <para> <para>The title to display above the notification message on a recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.BaiduMessage_Title"> <summary> <para> <para>The title to display above the notification message on a recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.DefaultMessage_Title"> <summary> <para> <para>The title to display above the notification message on a recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.EmailMessage_Title"> <summary> <para> <para>The subject line, or title, of the email.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.GCMMessage_Title"> <summary> <para> <para>The title to display above the notification message on a recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Limits_Total"> <summary> <para> <para>The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.WriteCampaignRequest_TreatmentDescription"> <summary> <para> <para>A custom description of the default treatment for the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.WriteCampaignRequest_TreatmentName"> <summary> <para> <para>A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A <i>treatment</i> is a variation of a campaign that's used for A/B testing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.ADMMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.APNSMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.BaiduMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.DefaultMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.GCMMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.EventType_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.EmailTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.InAppTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.PushTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.SMSTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.VoiceTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Hook_WebUrl"> <summary> <para> <para>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CampaignResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.CreateCampaignResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.CreateCampaignResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINCampaignCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.NewPINEmailTemplateCmdlet"> <summary> Creates a message template for messages that are sent through the email channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINEmailTemplateCmdlet.EmailTemplateRequest_DefaultSubstitution"> <summary> <para> <para>A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINEmailTemplateCmdlet.EmailTemplateRequest_Header"> <summary> <para> <para>The list of <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/templates-template-name-email.html#templates-template-name-email-model-messageheader">MessageHeaders</a> for the email. You can have up to 15 Headers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINEmailTemplateCmdlet.EmailTemplateRequest_HtmlPart"> <summary> <para> <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 render HTML content. You can include links, formatted text, and more in an HTML message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINEmailTemplateCmdlet.EmailTemplateRequest_RecommenderId"> <summary> <para> <para>The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINEmailTemplateCmdlet.EmailTemplateRequest_Subject"> <summary> <para> <para>The subject line, or title, to use in email messages that are based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINEmailTemplateCmdlet.EmailTemplateRequest_Tag"> <summary> <para> <note><para>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</para></note><para>(Deprecated) 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINEmailTemplateCmdlet.EmailTemplateRequest_TemplateDescription"> <summary> <para> <para>A custom description of the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINEmailTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINEmailTemplateCmdlet.EmailTemplateRequest_TextPart"> <summary> <para> <para>The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINEmailTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CreateTemplateMessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.CreateEmailTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.CreateEmailTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINEmailTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.NewPINExportJobCmdlet"> <summary> Creates an export job for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINExportJobCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINExportJobCmdlet.ExportJobRequest_RoleArn"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINExportJobCmdlet.ExportJobRequest_S3UrlPrefix"> <summary> <para> <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://<replaceable>bucket-name</replaceable>/<replaceable>folder-name</replaceable>/.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINExportJobCmdlet.ExportJobRequest_SegmentId"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINExportJobCmdlet.ExportJobRequest_SegmentVersion"> <summary> <para> <para>The version of the segment to export endpoint definitions from, if specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINExportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExportJobResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.CreateExportJobResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.CreateExportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINExportJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.NewPINImportJobCmdlet"> <summary> Creates an import job for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINImportJobCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINImportJobCmdlet.ImportJobRequest_DefineSegment"> <summary> <para> <para>Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINImportJobCmdlet.ImportJobRequest_ExternalId"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINImportJobCmdlet.ImportJobRequest_Format"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINImportJobCmdlet.ImportJobRequest_RegisterEndpoint"> <summary> <para> <para>Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINImportJobCmdlet.ImportJobRequest_RoleArn"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINImportJobCmdlet.ImportJobRequest_S3Url"> <summary> <para> <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.</para><para>The URL should be in the following format: s3://<replaceable>bucket-name</replaceable>/<replaceable>folder-name</replaceable>/<replaceable>file-name</replaceable>. The location can end with the key for an individual object or a prefix that qualifies multiple objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINImportJobCmdlet.ImportJobRequest_SegmentId"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINImportJobCmdlet.ImportJobRequest_SegmentName"> <summary> <para> <para>A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINImportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImportJobResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.CreateImportJobResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.CreateImportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINImportJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.NewPINInAppTemplateCmdlet"> <summary> Creates a new message template for messages using the in-app message channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINInAppTemplateCmdlet.InAppTemplateRequest_Content"> <summary> <para> <para>The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINInAppTemplateCmdlet.InAppTemplateRequest_CustomConfig"> <summary> <para> <para>Custom config to be sent to client.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINInAppTemplateCmdlet.InAppTemplateRequest_Layout"> <summary> <para> <para>The layout of the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINInAppTemplateCmdlet.InAppTemplateRequest_Tag"> <summary> <para> <note><para>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</para></note><para>(Deprecated) 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINInAppTemplateCmdlet.InAppTemplateRequest_TemplateDescription"> <summary> <para> <para>The description of the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINInAppTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINInAppTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TemplateCreateMessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.CreateInAppTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.CreateInAppTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINInAppTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet"> <summary> Creates a journey for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.WriteJourneyRequest_Activity"> <summary> <para> <para>A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.Dimensions_Attribute"> <summary> <para> <para>One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.TimeframeCap_Cap"> <summary> <para> <para>The maximum number of messages that all journeys can send to an endpoint during the specified timeframe. The maximum value is 100. If set to 0, this limit will not apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.JourneyChannelSettings_ConnectCampaignArn"> <summary> <para> <para>Amazon Resource Name (ARN) of the Connect Campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.JourneyChannelSettings_ConnectCampaignExecutionRoleArn"> <summary> <para> <para>IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.WriteJourneyRequest_CreationDate"> <summary> <para> <para>The date, in ISO 8601 format, when the journey was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.ClosedDays_CUSTOM"> <summary> <para> <para>Rules for the Custom channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.OpenHours_CUSTOM"> <summary> <para> <para>Specifies the schedule settings for the custom channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.Limits_DailyCap"> <summary> <para> <para>The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.TimeframeCap_Day"> <summary> <para> <para>The length of the timeframe in days. The maximum value is 30. If set to 0, this limit will not apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.StartCondition_Description"> <summary> <para> <para>The custom description of the condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.EventType_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.ClosedDays_EMAIL"> <summary> <para> <para>Rules for the Email channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.OpenHours_EMAIL"> <summary> <para> <para>Specifies the schedule settings for the email channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.QuietTime_End"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.Limits_EndpointReentryCap"> <summary> <para> <para>The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.Limits_EndpointReentryInterval"> <summary> <para> <para>Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.Schedule_EndTime"> <summary> <para> <para>The scheduled time, in ISO 8601 format, when the journey ended or will end.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.EventFilter_FilterType"> <summary> <para> <para>The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (<link linkend="apps-application-id-events">Events resource</link>) occurs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.WriteJourneyRequest_LastModifiedDate"> <summary> <para> <para>The date, in ISO 8601 format, when the journey was last modified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.WriteJourneyRequest_LocalTime"> <summary> <para> <para>Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.Limits_MessagesPerSecond"> <summary> <para> <para>The maximum number of messages that the journey can send each second.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.Dimensions_Metric"> <summary> <para> <para>One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.WriteJourneyRequest_Name"> <summary> <para> <para>The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.ClosedDays_PUSH"> <summary> <para> <para>Rules for the Push channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.OpenHours_PUSH"> <summary> <para> <para>Specifies the schedule settings for the push channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.WriteJourneyRequest_RefreshFrequency"> <summary> <para> <para>The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.WriteJourneyRequest_RefreshOnSegmentUpdate"> <summary> <para> <para>Indicates whether the journey participants should be refreshed when a segment is updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.EventStartCondition_SegmentId"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.SegmentStartCondition_SegmentId"> <summary> <para> <para>The unique identifier for the segment to associate with the activity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.WriteJourneyRequest_SendingSchedule"> <summary> <para> <para>Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.ClosedDays_SMS"> <summary> <para> <para>Rules for the SMS channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.OpenHours_SMS"> <summary> <para> <para>Specifies the schedule settings for the SMS channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.QuietTime_Start"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.WriteJourneyRequest_StartActivity"> <summary> <para> <para>The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.Schedule_StartTime"> <summary> <para> <para>The scheduled time, in ISO 8601 format, when the journey began or will begin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.WriteJourneyRequest_State"> <summary> <para> <para>The status of the journey. Valid values are:</para><ul><li><para>DRAFT - Saves the journey and doesn't publish it.</para></li><li><para>ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.</para></li></ul><para>PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the <link linkend="apps-application-id-journeys-journey-id-state">Journey State</link> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.Schedule_Timezone"> <summary> <para> <para>The starting UTC offset for the journey schedule, if the value of the journey's LocalTime 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+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.WriteJourneyRequest_TimezoneEstimationMethod"> <summary> <para> <para>An array of time zone estimation methods, if any, to use for determining an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-endpoints-endpoint-id.html">Endpoints</a> time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.</para><ul><li><para>PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.</para></li><li><para>POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.</para><note><para>POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.</para></note></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.Limits_TotalCap"> <summary> <para> <para>The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.EventType_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.ClosedDays_VOICE"> <summary> <para> <para>Rules for the Voice channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.OpenHours_VOICE"> <summary> <para> <para>Specifies the schedule settings for the voice channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.WriteJourneyRequest_WaitForQuietTime"> <summary> <para> <para>Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JourneyResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.CreateJourneyResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.CreateJourneyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINJourneyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet"> <summary> Creates a message template for messages that are sent through a push notification channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.ADM_Action"> <summary> <para> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.APNS_Action"> <summary> <para> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.Baidu_Action"> <summary> <para> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.Default_Action"> <summary> <para> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.GCM_Action"> <summary> <para> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.ADM_Body"> <summary> <para> <para>The message body to use in a push notification that's based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.APNS_Body"> <summary> <para> <para>The message body to use in push notifications that are based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.Baidu_Body"> <summary> <para> <para>The message body to use in a push notification that's based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.Default_Body"> <summary> <para> <para>The message body to use in push notifications that are based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.GCM_Body"> <summary> <para> <para>The message body to use in a push notification that's based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.PushNotificationTemplateRequest_DefaultSubstitution"> <summary> <para> <para>A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.ADM_ImageIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.Baidu_ImageIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.GCM_ImageIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.ADM_ImageUrl"> <summary> <para> <para>The URL of an image to display in a push notification that's based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.Baidu_ImageUrl"> <summary> <para> <para>The URL of an image to display in a push notification that's based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.GCM_ImageUrl"> <summary> <para> <para>The URL of an image to display in a push notification that's based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.APNS_MediaUrl"> <summary> <para> <para>The URL of an image or video to display in push notifications that are based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.ADM_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.APNS_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.Baidu_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.GCM_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.PushNotificationTemplateRequest_RecommenderId"> <summary> <para> <para>The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.ADM_SmallImageIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.Baidu_SmallImageIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.GCM_SmallImageIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.ADM_Sound"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.APNS_Sound"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.Baidu_Sound"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.Default_Sound"> <summary> <para> <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><para>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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.GCM_Sound"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.PushNotificationTemplateRequest_Tag"> <summary> <para> <note><para>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</para></note><para>(Deprecated) 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.PushNotificationTemplateRequest_TemplateDescription"> <summary> <para> <para>A custom description of the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.ADM_Title"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.APNS_Title"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.Baidu_Title"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.Default_Title"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.GCM_Title"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.ADM_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.APNS_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.Baidu_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.Default_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.GCM_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CreateTemplateMessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.CreatePushTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.CreatePushTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINPushTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.NewPINRecommenderConfigurationCmdlet"> <summary> Creates an Amazon Pinpoint configuration for a recommender model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINRecommenderConfigurationCmdlet.CreateRecommenderConfiguration_Attribute"> <summary> <para> <para>A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.</para><para>In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the <b>Attribute finder</b> of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:</para><ul><li><para>An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.</para></li><li><para>An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</para></li></ul><para>This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINRecommenderConfigurationCmdlet.CreateRecommenderConfiguration_Description"> <summary> <para> <para>A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINRecommenderConfigurationCmdlet.CreateRecommenderConfiguration_Name"> <summary> <para> <para>A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINRecommenderConfigurationCmdlet.CreateRecommenderConfiguration_RecommendationProviderIdType"> <summary> <para> <para>The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:</para><ul><li><para>PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.</para></li><li><para>PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINRecommenderConfigurationCmdlet.CreateRecommenderConfiguration_RecommendationProviderRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINRecommenderConfigurationCmdlet.CreateRecommenderConfiguration_RecommendationProviderUri"> <summary> <para> <para>The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINRecommenderConfigurationCmdlet.CreateRecommenderConfiguration_RecommendationsDisplayName"> <summary> <para> <para>A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.</para><para>This name appears in the <b>Attribute finder</b> of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINRecommenderConfigurationCmdlet.CreateRecommenderConfiguration_RecommendationsPerMessage"> <summary> <para> <para>The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.</para><para>To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINRecommenderConfigurationCmdlet.CreateRecommenderConfiguration_RecommendationTransformerUri"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINRecommenderConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RecommenderConfigurationResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.CreateRecommenderConfigurationResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.CreateRecommenderConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINRecommenderConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Dimensions_Attribute"> <summary> <para> <para>One or more custom attributes to use as criteria for the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.AppVersion_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Channel_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.DeviceType_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Make_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Model_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Platform_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Country_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Recency_Duration"> <summary> <para> <para>The duration to use when determining whether an endpoint is active or inactive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.SegmentGroups_Group"> <summary> <para> <para>An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.SegmentGroups_Include"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Coordinates_Latitude"> <summary> <para> <para>The latitude coordinate of the location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Coordinates_Longitude"> <summary> <para> <para>The longitude coordinate of the location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Dimensions_Metric"> <summary> <para> <para>One or more custom metrics to use as criteria for the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.WriteSegmentRequest_Name"> <summary> <para> <para>The name of the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.GPSPoint_RangeInKilometer"> <summary> <para> <para>The range, in kilometers, from the GPS coordinates.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Recency_RecencyType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.WriteSegmentRequest_Tag"> <summary> <para> <note><para>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</para></note><para>(Deprecated) 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Dimensions_UserAttribute"> <summary> <para> <para>One or more custom user attributes to use as criteria for the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.AppVersion_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Channel_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.DeviceType_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Make_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Model_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Platform_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Country_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SegmentResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.CreateSegmentResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.CreateSegmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSegmentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.NewPINSmsTemplateCmdlet"> <summary> Creates a message template for messages that are sent through the SMS channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSmsTemplateCmdlet.SMSTemplateRequest_Body"> <summary> <para> <para>The message body to use in text messages that are based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSmsTemplateCmdlet.SMSTemplateRequest_DefaultSubstitution"> <summary> <para> <para>A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSmsTemplateCmdlet.SMSTemplateRequest_RecommenderId"> <summary> <para> <para>The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSmsTemplateCmdlet.SMSTemplateRequest_Tag"> <summary> <para> <note><para>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</para></note><para>(Deprecated) 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSmsTemplateCmdlet.SMSTemplateRequest_TemplateDescription"> <summary> <para> <para>A custom description of the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSmsTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSmsTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CreateTemplateMessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.CreateSmsTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.CreateSmsTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINSmsTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.NewPINVoiceTemplateCmdlet"> <summary> Creates a message template for messages that are sent through the voice channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINVoiceTemplateCmdlet.VoiceTemplateRequest_Body"> <summary> <para> <para>The text of the script to use in messages that are based on the message template, in plain text format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINVoiceTemplateCmdlet.VoiceTemplateRequest_DefaultSubstitution"> <summary> <para> <para>A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINVoiceTemplateCmdlet.VoiceTemplateRequest_LanguageCode"> <summary> <para> <para>The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINVoiceTemplateCmdlet.VoiceTemplateRequest_Tag"> <summary> <para> <note><para>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</para></note><para>(Deprecated) 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINVoiceTemplateCmdlet.VoiceTemplateRequest_TemplateDescription"> <summary> <para> <para>A custom description of the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINVoiceTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINVoiceTemplateCmdlet.VoiceTemplateRequest_VoiceId"> <summary> <para> <para>The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINVoiceTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CreateTemplateMessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.CreateVoiceTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.CreateVoiceTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.NewPINVoiceTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINAdmChannelCmdlet"> <summary> Disables the ADM channel for an application and deletes any existing settings for the channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINAdmChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINAdmChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ADMChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteAdmChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteAdmChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINAdmChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINApnsChannelCmdlet"> <summary> Disables the APNs channel for an application and deletes any existing settings for the channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINApnsChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINApnsChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'APNSChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteApnsChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteApnsChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINApnsChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINApnsSandboxChannelCmdlet"> <summary> Disables the APNs sandbox channel for an application and deletes any existing settings for the channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINApnsSandboxChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINApnsSandboxChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'APNSSandboxChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteApnsSandboxChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteApnsSandboxChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINApnsSandboxChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINApnsVoipChannelCmdlet"> <summary> Disables the APNs VoIP channel for an application and deletes any existing settings for the channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINApnsVoipChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINApnsVoipChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'APNSVoipChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteApnsVoipChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteApnsVoipChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINApnsVoipChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINApnsVoipSandboxChannelCmdlet"> <summary> Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINApnsVoipSandboxChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINApnsVoipSandboxChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'APNSVoipSandboxChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteApnsVoipSandboxChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteApnsVoipSandboxChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINApnsVoipSandboxChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINAppCmdlet"> <summary> Deletes an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINAppCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINAppCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApplicationResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteAppResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteAppResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINAppCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINAttributeCmdlet"> <summary> Removes one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINAttributeCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINAttributeCmdlet.AttributeType"> <summary> <para> <para>The type of attribute or attributes to remove. Valid values are:</para><ul><li><para>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.</para></li><li><para>endpoint-metric-attributes - 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.</para></li><li><para>endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINAttributeCmdlet.UpdateAttributesRequest_Blacklist"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AttributesResource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.RemoveAttributesResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.RemoveAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINBaiduChannelCmdlet"> <summary> Disables the Baidu channel for an application and deletes any existing settings for the channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINBaiduChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINBaiduChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BaiduChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteBaiduChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteBaiduChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINBaiduChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINCampaignCmdlet"> <summary> Deletes a campaign from an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINCampaignCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINCampaignCmdlet.CampaignId"> <summary> <para> <para>The unique identifier for the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINCampaignCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CampaignResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteCampaignResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteCampaignResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINCampaignCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINEmailChannelCmdlet"> <summary> Disables the email channel for an application and deletes any existing settings for the channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINEmailChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINEmailChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EmailChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteEmailChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteEmailChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINEmailChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINEmailTemplateCmdlet"> <summary> Deletes a message template for messages that were sent through the email channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINEmailTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINEmailTemplateCmdlet.Version"> <summary> <para> <para>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</para><ul><li><para>For a get operation, retrieves information about the active version of the template.</para></li><li><para>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</para></li><li><para>For a delete operation, deletes the template, including all versions of the template.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINEmailTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteEmailTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteEmailTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINEmailTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINEndpointCmdlet"> <summary> Deletes an endpoint from an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINEndpointCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINEndpointCmdlet.EndpointId"> <summary> <para> <para>The case insensitive unique identifier for the endpoint. The identifier can't contain <c>$</c>, <c>{</c> or <c>}</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteEndpointResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINEventStreamCmdlet"> <summary> Deletes the event stream for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINEventStreamCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINEventStreamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventStream'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteEventStreamResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteEventStreamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINEventStreamCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINGcmChannelCmdlet"> <summary> Disables the GCM channel for an application and deletes any existing settings for the channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINGcmChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINGcmChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GCMChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteGcmChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteGcmChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINGcmChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINInAppTemplateCmdlet"> <summary> Deletes a message template for messages sent using the in-app message channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINInAppTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINInAppTemplateCmdlet.Version"> <summary> <para> <para>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</para><ul><li><para>For a get operation, retrieves information about the active version of the template.</para></li><li><para>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</para></li><li><para>For a delete operation, deletes the template, including all versions of the template.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINInAppTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteInAppTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteInAppTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINInAppTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINJourneyCmdlet"> <summary> Deletes a journey from an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINJourneyCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINJourneyCmdlet.JourneyId"> <summary> <para> <para>The unique identifier for the journey.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINJourneyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JourneyResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteJourneyResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteJourneyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINJourneyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINPushTemplateCmdlet"> <summary> Deletes a message template for messages that were sent through a push notification channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINPushTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINPushTemplateCmdlet.Version"> <summary> <para> <para>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</para><ul><li><para>For a get operation, retrieves information about the active version of the template.</para></li><li><para>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</para></li><li><para>For a delete operation, deletes the template, including all versions of the template.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINPushTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeletePushTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeletePushTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINPushTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINRecommenderConfigurationCmdlet"> <summary> Deletes an Amazon Pinpoint configuration for a recommender model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINRecommenderConfigurationCmdlet.RecommenderId"> <summary> <para> <para>The unique identifier for the recommender model configuration. This identifier is displayed as the <b>Recommender ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINRecommenderConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RecommenderConfigurationResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteRecommenderConfigurationResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteRecommenderConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINRecommenderConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINResourceTagCmdlet"> <summary> Removes one or more tags (keys and values) from an application, campaign, message template, or segment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINResourceTagCmdlet.TagKey"> <summary> <para> <para>The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINSegmentCmdlet"> <summary> Deletes a segment from an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINSegmentCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINSegmentCmdlet.SegmentId"> <summary> <para> <para>The unique identifier for the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINSegmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SegmentResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteSegmentResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteSegmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINSegmentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINSmsChannelCmdlet"> <summary> Disables the SMS channel for an application and deletes any existing settings for the channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINSmsChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINSmsChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SMSChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteSmsChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteSmsChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINSmsChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINSmsTemplateCmdlet"> <summary> Deletes a message template for messages that were sent through the SMS channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINSmsTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINSmsTemplateCmdlet.Version"> <summary> <para> <para>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</para><ul><li><para>For a get operation, retrieves information about the active version of the template.</para></li><li><para>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</para></li><li><para>For a delete operation, deletes the template, including all versions of the template.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINSmsTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteSmsTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteSmsTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINSmsTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINUserEndpointCmdlet"> <summary> Deletes all the endpoints that are associated with a specific user ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINUserEndpointCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINUserEndpointCmdlet.UserId"> <summary> <para> <para>The unique identifier for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINUserEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteUserEndpointsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteUserEndpointsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINUserEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINVoiceChannelCmdlet"> <summary> Disables the voice channel for an application and deletes any existing settings for the channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINVoiceChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINVoiceChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VoiceChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteVoiceChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteVoiceChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINVoiceChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.RemovePINVoiceTemplateCmdlet"> <summary> Deletes a message template for messages that were sent through the voice channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINVoiceTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINVoiceTemplateCmdlet.Version"> <summary> <para> <para>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</para><ul><li><para>For a get operation, retrieves information about the active version of the template.</para></li><li><para>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</para></li><li><para>For a delete operation, deletes the template, including all versions of the template.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINVoiceTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.DeleteVoiceTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.DeleteVoiceTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.RemovePINVoiceTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet"> <summary> Creates and sends a direct message. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ADMMessage_Action"> <summary> <para> <para>The action to occur if the recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_Action"> <summary> <para> <para>The action to occur if the recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.BaiduMessage_Action"> <summary> <para> <para>The action to occur if the recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.DefaultPushNotificationMessage_Action"> <summary> <para> <para>The default action to occur if a recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_Action"> <summary> <para> <para>The action to occur if the recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.MessageRequest_Address"> <summary> <para> <para>A map of key-value pairs, where each key is an address and each value is an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration">AddressConfiguration</a> object. An address can be a push notification token, a phone number, or an email address. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration">AddressConfiguration</a> object to tailor the message for an address by specifying settings such as content overrides and message variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_APNSPushType"> <summary> <para> <para>The type of push notification to send. Valid values are:</para><ul><li><para>alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.</para></li><li><para>background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.</para></li><li><para>complication - For a notification that contains update information for an app’s complication timeline.</para></li><li><para>fileprovider - For a notification that signals changes to a File Provider extension.</para></li><li><para>mdm - For a notification that tells managed devices to contact the MDM server.</para></li><li><para>voip - For a notification that provides information about an incoming VoIP call.</para></li></ul><para>Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.</para><para>For more information about the apns-push-type request header, see <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns">Sending Notification Requests to APNs</a> on the Apple Developer website.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_Badge"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ADMMessage_Body"> <summary> <para> <para>The body of the notification message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_Body"> <summary> <para> <para>The body of the notification message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.BaiduMessage_Body"> <summary> <para> <para>The body of the notification message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.DefaultMessage_Body"> <summary> <para> <para>The default body of the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.DefaultPushNotificationMessage_Body"> <summary> <para> <para>The default body of the notification message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.EmailMessage_Body"> <summary> <para> <para>The body of the email message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_Body"> <summary> <para> <para>The body of the notification message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.SMSMessage_Body"> <summary> <para> <para>The body of the SMS message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.VoiceMessage_Body"> <summary> <para> <para>The text of the script to use for the voice message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_Category"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.HtmlPart_Charset"> <summary> <para> <para>The applicable character set for the message content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.Subject_Charset"> <summary> <para> <para>The applicable character set for the message content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.TextPart_Charset"> <summary> <para> <para>The applicable character set for the message content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_CollapseId"> <summary> <para> <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.</para><para>Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_CollapseKey"> <summary> <para> <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.</para><para>Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ADMMessage_ConsolidationKey"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.MessageRequest_Context"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ADMMessage_Data"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_Data"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.BaiduMessage_Data"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.DefaultPushNotificationMessage_Data"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.RawEmail_Data"> <summary> <para> <para>The email message, represented as a raw MIME message. The entire message must be base64 encoded.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.HtmlPart_Data"> <summary> <para> <para>The textual data of the message content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.Subject_Data"> <summary> <para> <para>The textual data of the message content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.TextPart_Data"> <summary> <para> <para>The textual data of the message content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_Data"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.MessageRequest_Endpoint"> <summary> <para> <para>A map of key-value pairs, where each key is an endpoint ID and each value is an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.SMSMessage_EntityId"> <summary> <para> <para>The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ADMMessage_ExpiresAfter"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.EmailMessage_FeedbackForwardingAddress"> <summary> <para> <para>The email address to forward bounces and complaints to, if feedback forwarding is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.EmailMessage_FromAddress"> <summary> <para> <para>The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.SimpleEmail_Header"> <summary> <para> <para>The list of MessageHeaders for the email. You can have up to 15 Headers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ADMMessage_IconReference"> <summary> <para> <para>The icon image name of the asset saved in your app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.BaiduMessage_IconReference"> <summary> <para> <para>The icon image name of the asset saved in your app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_IconReference"> <summary> <para> <para>The icon image name of the asset saved in your app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ADMMessage_ImageIconUrl"> <summary> <para> <para>The URL of the large icon image to display in the content view of the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.BaiduMessage_ImageIconUrl"> <summary> <para> <para>The URL of the large icon image to display in the content view of the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_ImageIconUrl"> <summary> <para> <para>The URL of the large icon image to display in the content view of the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ADMMessage_ImageUrl"> <summary> <para> <para>The URL of an image to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.BaiduMessage_ImageUrl"> <summary> <para> <para>The URL of an image to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_ImageUrl"> <summary> <para> <para>The URL of an image to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.SMSMessage_Keyword"> <summary> <para> <para>The SMS program name that you provided to AWS Support when you requested your dedicated number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.VoiceMessage_LanguageCode"> <summary> <para> <para>The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ADMMessage_MD5"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_MediaUrl"> <summary> <para> <para>The URL of an image or video to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.SMSMessage_MediaUrl"> <summary> <para> <para>This field is reserved for future use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.SMSMessage_MessageType"> <summary> <para> <para>The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.EmailTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.InAppTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.PushTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.SMSTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.VoiceTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.SMSMessage_OriginationNumber"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.VoiceMessage_OriginationNumber"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_PreferredAuthenticationMethod"> <summary> <para> <para>The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_PreferredAuthenticationMethod"> <summary> <para> <para>The preferred authentication method, with valid values "KEY" or "TOKEN". If a value isn't provided then the <b>DefaultAuthenticationMethod</b> is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_Priority"> <summary> <para> <para>para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.</para> /listitem> <li><para>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></li>/para> <para>Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.</para><para>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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_Priority"> <summary> <para> <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.</para> /listitem> <li><para>high – The notification is sent immediately and might wake a sleeping device.</para></li>/para> <para>Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.</para><para>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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ADMMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para><note><para>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></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.BaiduMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.EmailMessage_ReplyToAddress"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_RestrictedPackageName"> <summary> <para> <para>The package name of the application where registration tokens must match in order for the recipient to receive the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.SMSMessage_SenderId"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ADMMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_SilentPush"> <summary> <para> <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.</para><para>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.</para><note><para>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.</para><para>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></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.BaiduMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.DefaultPushNotificationMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ADMMessage_SmallImageIconUrl"> <summary> <para> <para>The URL of the small icon image to display in the status bar and the content view of the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.BaiduMessage_SmallImageIconUrl"> <summary> <para> <para>The URL of the small icon image to display in the status bar and the content view of the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_SmallImageIconUrl"> <summary> <para> <para>The URL of the small icon image to display in the status bar and the content view of the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ADMMessage_Sound"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_Sound"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.BaiduMessage_Sound"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_Sound"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ADMMessage_Substitution"> <summary> <para> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_Substitution"> <summary> <para> <para>The default message variables to use in the notification message. You can override these default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.BaiduMessage_Substitution"> <summary> <para> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.DefaultMessage_Substitution"> <summary> <para> <para>The default message variables to use in the message. You can override these default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.DefaultPushNotificationMessage_Substitution"> <summary> <para> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.EmailMessage_Substitution"> <summary> <para> <para>The default message variables to use in the email message. You can override the default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_Substitution"> <summary> <para> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.SMSMessage_Substitution"> <summary> <para> <para>The message variables to use in the SMS message. You can override the default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.VoiceMessage_Substitution"> <summary> <para> <para>The default message variables to use in the voice message. You can override the default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.SMSMessage_TemplateId"> <summary> <para> <para>The template ID received from the regulatory body for sending SMS in your country.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_ThreadId"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_TimeToLive"> <summary> <para> <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.</para><para>Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.BaiduMessage_TimeToLive"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_TimeToLive"> <summary> <para> <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).</para><para>Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ADMMessage_Title"> <summary> <para> <para>The title to display above the notification message on the recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_Title"> <summary> <para> <para>The title to display above the notification message on the recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.BaiduMessage_Title"> <summary> <para> <para>The title to display above the notification message on the recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.DefaultPushNotificationMessage_Title"> <summary> <para> <para>The default title to display above the notification message on a recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_Title"> <summary> <para> <para>The title to display above the notification message on the recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.MessageRequest_TraceId"> <summary> <para> <para>The unique identifier for tracing the message. This identifier is visible to message recipients.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.ADMMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.APNSMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.BaiduMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.DefaultPushNotificationMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.GCMMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.EmailTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.InAppTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.PushTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.SMSTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.VoiceTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.VoiceMessage_VoiceId"> <summary> <para> <para>The name of the voice to use when delivering the message. For a list of supported voices, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.SendMessagesResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.SendMessagesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINMessageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.SendPINOTPMessageCmdlet"> <summary> Send an OTP message </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINOTPMessageCmdlet.SendOTPMessageRequestParameters_AllowedAttempt"> <summary> <para> <para>The attempts allowed to validate an OTP.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINOTPMessageCmdlet.ApplicationId"> <summary> <para> <para>The unique ID of your Amazon Pinpoint application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINOTPMessageCmdlet.SendOTPMessageRequestParameters_BrandName"> <summary> <para> <para>The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINOTPMessageCmdlet.SendOTPMessageRequestParameters_Channel"> <summary> <para> <para>Channel type for the OTP message. Supported values: [SMS].</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINOTPMessageCmdlet.SendOTPMessageRequestParameters_CodeLength"> <summary> <para> <para>The number of characters in the generated OTP.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINOTPMessageCmdlet.SendOTPMessageRequestParameters_DestinationIdentity"> <summary> <para> <para>The destination identity to send OTP to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINOTPMessageCmdlet.SendOTPMessageRequestParameters_EntityId"> <summary> <para> <para>A unique Entity ID received from DLT after entity registration is approved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINOTPMessageCmdlet.SendOTPMessageRequestParameters_Language"> <summary> <para> <para>The language to be used for the outgoing message body containing the OTP.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINOTPMessageCmdlet.SendOTPMessageRequestParameters_OriginationIdentity"> <summary> <para> <para>The origination identity used to send OTP from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINOTPMessageCmdlet.SendOTPMessageRequestParameters_ReferenceId"> <summary> <para> <para>Developer-specified reference identifier. Required to match during OTP verification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINOTPMessageCmdlet.SendOTPMessageRequestParameters_TemplateId"> <summary> <para> <para>A unique Template ID received from DLT after entity registration is approved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINOTPMessageCmdlet.SendOTPMessageRequestParameters_ValidityPeriod"> <summary> <para> <para>The time in minutes before the OTP is no longer valid.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINOTPMessageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.SendOTPMessageResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.SendOTPMessageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINOTPMessageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet"> <summary> Creates and sends a message to a list of users. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ADMMessage_Action"> <summary> <para> <para>The action to occur if the recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_Action"> <summary> <para> <para>The action to occur if the recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.BaiduMessage_Action"> <summary> <para> <para>The action to occur if the recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.DefaultPushNotificationMessage_Action"> <summary> <para> <para>The default action to occur if a recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_Action"> <summary> <para> <para>The action to occur if the recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_APNSPushType"> <summary> <para> <para>The type of push notification to send. Valid values are:</para><ul><li><para>alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.</para></li><li><para>background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.</para></li><li><para>complication - For a notification that contains update information for an app’s complication timeline.</para></li><li><para>fileprovider - For a notification that signals changes to a File Provider extension.</para></li><li><para>mdm - For a notification that tells managed devices to contact the MDM server.</para></li><li><para>voip - For a notification that provides information about an incoming VoIP call.</para></li></ul><para>Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.</para><para>For more information about the apns-push-type request header, see <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns">Sending Notification Requests to APNs</a> on the Apple Developer website.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_Badge"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ADMMessage_Body"> <summary> <para> <para>The body of the notification message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_Body"> <summary> <para> <para>The body of the notification message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.BaiduMessage_Body"> <summary> <para> <para>The body of the notification message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.DefaultMessage_Body"> <summary> <para> <para>The default body of the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.DefaultPushNotificationMessage_Body"> <summary> <para> <para>The default body of the notification message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.EmailMessage_Body"> <summary> <para> <para>The body of the email message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_Body"> <summary> <para> <para>The body of the notification message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.SMSMessage_Body"> <summary> <para> <para>The body of the SMS message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.VoiceMessage_Body"> <summary> <para> <para>The text of the script to use for the voice message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_Category"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.HtmlPart_Charset"> <summary> <para> <para>The applicable character set for the message content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.Subject_Charset"> <summary> <para> <para>The applicable character set for the message content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.TextPart_Charset"> <summary> <para> <para>The applicable character set for the message content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_CollapseId"> <summary> <para> <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.</para><para>Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_CollapseKey"> <summary> <para> <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.</para><para>Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ADMMessage_ConsolidationKey"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.SendUsersMessageRequest_Context"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ADMMessage_Data"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_Data"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.BaiduMessage_Data"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.DefaultPushNotificationMessage_Data"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.RawEmail_Data"> <summary> <para> <para>The email message, represented as a raw MIME message. The entire message must be base64 encoded.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.HtmlPart_Data"> <summary> <para> <para>The textual data of the message content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.Subject_Data"> <summary> <para> <para>The textual data of the message content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.TextPart_Data"> <summary> <para> <para>The textual data of the message content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_Data"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.SMSMessage_EntityId"> <summary> <para> <para>The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ADMMessage_ExpiresAfter"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.EmailMessage_FeedbackForwardingAddress"> <summary> <para> <para>The email address to forward bounces and complaints to, if feedback forwarding is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.EmailMessage_FromAddress"> <summary> <para> <para>The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.SimpleEmail_Header"> <summary> <para> <para>The list of MessageHeaders for the email. You can have up to 15 Headers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ADMMessage_IconReference"> <summary> <para> <para>The icon image name of the asset saved in your app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.BaiduMessage_IconReference"> <summary> <para> <para>The icon image name of the asset saved in your app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_IconReference"> <summary> <para> <para>The icon image name of the asset saved in your app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ADMMessage_ImageIconUrl"> <summary> <para> <para>The URL of the large icon image to display in the content view of the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.BaiduMessage_ImageIconUrl"> <summary> <para> <para>The URL of the large icon image to display in the content view of the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_ImageIconUrl"> <summary> <para> <para>The URL of the large icon image to display in the content view of the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ADMMessage_ImageUrl"> <summary> <para> <para>The URL of an image to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.BaiduMessage_ImageUrl"> <summary> <para> <para>The URL of an image to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_ImageUrl"> <summary> <para> <para>The URL of an image to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.SMSMessage_Keyword"> <summary> <para> <para>The SMS program name that you provided to AWS Support when you requested your dedicated number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.VoiceMessage_LanguageCode"> <summary> <para> <para>The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ADMMessage_MD5"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_MediaUrl"> <summary> <para> <para>The URL of an image or video to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.SMSMessage_MediaUrl"> <summary> <para> <para>This field is reserved for future use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.SMSMessage_MessageType"> <summary> <para> <para>The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.EmailTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.InAppTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.PushTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.SMSTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.VoiceTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.SMSMessage_OriginationNumber"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.VoiceMessage_OriginationNumber"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_PreferredAuthenticationMethod"> <summary> <para> <para>The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_PreferredAuthenticationMethod"> <summary> <para> <para>The preferred authentication method, with valid values "KEY" or "TOKEN". If a value isn't provided then the <b>DefaultAuthenticationMethod</b> is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_Priority"> <summary> <para> <para>para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.</para> /listitem> <li><para>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></li>/para> <para>Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.</para><para>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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_Priority"> <summary> <para> <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.</para> /listitem> <li><para>high – The notification is sent immediately and might wake a sleeping device.</para></li>/para> <para>Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.</para><para>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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ADMMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para><note><para>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></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.BaiduMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.EmailMessage_ReplyToAddress"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_RestrictedPackageName"> <summary> <para> <para>The package name of the application where registration tokens must match in order for the recipient to receive the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.SMSMessage_SenderId"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ADMMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_SilentPush"> <summary> <para> <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.</para><para>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.</para><note><para>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.</para><para>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></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.BaiduMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.DefaultPushNotificationMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ADMMessage_SmallImageIconUrl"> <summary> <para> <para>The URL of the small icon image to display in the status bar and the content view of the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.BaiduMessage_SmallImageIconUrl"> <summary> <para> <para>The URL of the small icon image to display in the status bar and the content view of the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_SmallImageIconUrl"> <summary> <para> <para>The URL of the small icon image to display in the status bar and the content view of the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ADMMessage_Sound"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_Sound"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.BaiduMessage_Sound"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_Sound"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ADMMessage_Substitution"> <summary> <para> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_Substitution"> <summary> <para> <para>The default message variables to use in the notification message. You can override these default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.BaiduMessage_Substitution"> <summary> <para> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.DefaultMessage_Substitution"> <summary> <para> <para>The default message variables to use in the message. You can override these default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.DefaultPushNotificationMessage_Substitution"> <summary> <para> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.EmailMessage_Substitution"> <summary> <para> <para>The default message variables to use in the email message. You can override the default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_Substitution"> <summary> <para> <para>The default message variables to use in the notification message. You can override the default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.SMSMessage_Substitution"> <summary> <para> <para>The message variables to use in the SMS message. You can override the default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.VoiceMessage_Substitution"> <summary> <para> <para>The default message variables to use in the voice message. You can override the default variables with individual address variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.SMSMessage_TemplateId"> <summary> <para> <para>The template ID received from the regulatory body for sending SMS in your country.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_ThreadId"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_TimeToLive"> <summary> <para> <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.</para><para>Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.BaiduMessage_TimeToLive"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_TimeToLive"> <summary> <para> <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).</para><para>Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ADMMessage_Title"> <summary> <para> <para>The title to display above the notification message on the recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_Title"> <summary> <para> <para>The title to display above the notification message on the recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.BaiduMessage_Title"> <summary> <para> <para>The title to display above the notification message on the recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.DefaultPushNotificationMessage_Title"> <summary> <para> <para>The default title to display above the notification message on a recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_Title"> <summary> <para> <para>The title to display above the notification message on the recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.SendUsersMessageRequest_TraceId"> <summary> <para> <para>The unique identifier for tracing the message. This identifier is visible to message recipients.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.ADMMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.APNSMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.BaiduMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.DefaultPushNotificationMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.GCMMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.SendUsersMessageRequest_User"> <summary> <para> <para>A map that associates user IDs with <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> objects. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object to tailor the message for a user by specifying settings such as content overrides and message variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.EmailTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.InAppTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.PushTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.SMSTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.VoiceTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.VoiceMessage_VoiceId"> <summary> <para> <para>The name of the voice to use when delivering the message. For a list of supported voices, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SendUsersMessageResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.SendUsersMessagesResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.SendUsersMessagesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.SendPINUserMessageBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINAdmChannelCmdlet"> <summary> Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINAdmChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINAdmChannelCmdlet.ADMChannelRequest_ClientId"> <summary> <para> <para>The Client ID that you received from Amazon to send messages by using ADM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINAdmChannelCmdlet.ADMChannelRequest_ClientSecret"> <summary> <para> <para>The Client Secret that you received from Amazon to send messages by using ADM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINAdmChannelCmdlet.ADMChannelRequest_Enabled"> <summary> <para> <para>Specifies whether to enable the ADM channel for the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINAdmChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ADMChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateAdmChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateAdmChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINAdmChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsChannelCmdlet"> <summary> Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsChannelCmdlet.APNSChannelRequest_BundleId"> <summary> <para> <para>The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsChannelCmdlet.APNSChannelRequest_Certificate"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsChannelCmdlet.APNSChannelRequest_DefaultAuthenticationMethod"> <summary> <para> <para>The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsChannelCmdlet.APNSChannelRequest_Enabled"> <summary> <para> <para>Specifies whether to enable the APNs channel for the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsChannelCmdlet.APNSChannelRequest_PrivateKey"> <summary> <para> <para>The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsChannelCmdlet.APNSChannelRequest_TeamId"> <summary> <para> <para>The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsChannelCmdlet.APNSChannelRequest_TokenKey"> <summary> <para> <para>The authentication key to use for APNs tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsChannelCmdlet.APNSChannelRequest_TokenKeyId"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'APNSChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateApnsChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateApnsChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsSandboxChannelCmdlet"> <summary> Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsSandboxChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsSandboxChannelCmdlet.APNSSandboxChannelRequest_BundleId"> <summary> <para> <para>The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsSandboxChannelCmdlet.APNSSandboxChannelRequest_Certificate"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsSandboxChannelCmdlet.APNSSandboxChannelRequest_DefaultAuthenticationMethod"> <summary> <para> <para>The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsSandboxChannelCmdlet.APNSSandboxChannelRequest_Enabled"> <summary> <para> <para>Specifies whether to enable the APNs sandbox channel for the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsSandboxChannelCmdlet.APNSSandboxChannelRequest_PrivateKey"> <summary> <para> <para>The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsSandboxChannelCmdlet.APNSSandboxChannelRequest_TeamId"> <summary> <para> <para>The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsSandboxChannelCmdlet.APNSSandboxChannelRequest_TokenKey"> <summary> <para> <para>The authentication key to use for APNs tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsSandboxChannelCmdlet.APNSSandboxChannelRequest_TokenKeyId"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsSandboxChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'APNSSandboxChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateApnsSandboxChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateApnsSandboxChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsSandboxChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipChannelCmdlet"> <summary> Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipChannelCmdlet.APNSVoipChannelRequest_BundleId"> <summary> <para> <para>The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipChannelCmdlet.APNSVoipChannelRequest_Certificate"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipChannelCmdlet.APNSVoipChannelRequest_DefaultAuthenticationMethod"> <summary> <para> <para>The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipChannelCmdlet.APNSVoipChannelRequest_Enabled"> <summary> <para> <para>Specifies whether to enable the APNs VoIP channel for the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipChannelCmdlet.APNSVoipChannelRequest_PrivateKey"> <summary> <para> <para>The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipChannelCmdlet.APNSVoipChannelRequest_TeamId"> <summary> <para> <para>The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipChannelCmdlet.APNSVoipChannelRequest_TokenKey"> <summary> <para> <para>The authentication key to use for APNs tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipChannelCmdlet.APNSVoipChannelRequest_TokenKeyId"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'APNSVoipChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateApnsVoipChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateApnsVoipChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipSandboxChannelCmdlet"> <summary> Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipSandboxChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipSandboxChannelCmdlet.APNSVoipSandboxChannelRequest_BundleId"> <summary> <para> <para>The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipSandboxChannelCmdlet.APNSVoipSandboxChannelRequest_Certificate"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipSandboxChannelCmdlet.APNSVoipSandboxChannelRequest_DefaultAuthenticationMethod"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipSandboxChannelCmdlet.APNSVoipSandboxChannelRequest_Enabled"> <summary> <para> <para>Specifies whether the APNs VoIP sandbox channel is enabled for the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipSandboxChannelCmdlet.APNSVoipSandboxChannelRequest_PrivateKey"> <summary> <para> <para>The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipSandboxChannelCmdlet.APNSVoipSandboxChannelRequest_TeamId"> <summary> <para> <para>The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipSandboxChannelCmdlet.APNSVoipSandboxChannelRequest_TokenKey"> <summary> <para> <para>The authentication key to use for APNs tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipSandboxChannelCmdlet.APNSVoipSandboxChannelRequest_TokenKeyId"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipSandboxChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'APNSVoipSandboxChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateApnsVoipSandboxChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateApnsVoipSandboxChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApnsVoipSandboxChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet"> <summary> Updates the settings for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.TimeframeCap_Cap"> <summary> <para> <para>The maximum number of messages that all journeys can send to an endpoint during the specified timeframe. The maximum value is 100. If set to 0, this limit will not apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.WriteApplicationSettingsRequest_CloudWatchMetricsEnabled"> <summary> <para> <para>Specifies whether to enable application-related alarms in Amazon CloudWatch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.Limits_Daily"> <summary> <para> <para>The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.JourneyLimits_DailyCap"> <summary> <para> <para>The daily number of messages that an endpoint can receive from all journeys. The maximum value is 100. If set to 0, this limit will not apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.TimeframeCap_Day"> <summary> <para> <para>The length of the timeframe in days. The maximum value is 30. If set to 0, this limit will not apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.QuietTime_End"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.WriteApplicationSettingsRequest_EventTaggingEnabled"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.CampaignHook_LambdaFunctionName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.Limits_MaximumDuration"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.Limits_MessagesPerSecond"> <summary> <para> <para>The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.CampaignHook_Mode"> <summary> <para> <para>The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:</para><ul><li><para>FILTER - Invoke the function to customize the segment that's used by a campaign.</para></li><li><para>DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.Limits_Session"> <summary> <para> <para>The maximum total number of messages that the campaign can send per user session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.QuietTime_Start"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.Limits_Total"> <summary> <para> <para>The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.JourneyLimits_TotalCap"> <summary> <para> <para>The default maximum number of messages that a single journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.CampaignHook_WebUrl"> <summary> <para> <para>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApplicationSettingsResource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateApplicationSettingsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateApplicationSettingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINApplicationSettingListCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINBaiduChannelCmdlet"> <summary> Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINBaiduChannelCmdlet.BaiduChannelRequest_ApiKey"> <summary> <para> <para>The API key that you received from the Baidu Cloud Push service to communicate with the service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINBaiduChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINBaiduChannelCmdlet.BaiduChannelRequest_Enabled"> <summary> <para> <para>Specifies whether to enable the Baidu channel for the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINBaiduChannelCmdlet.BaiduChannelRequest_SecretKey"> <summary> <para> <para>The secret key that you received from the Baidu Cloud Push service to communicate with the service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINBaiduChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BaiduChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateBaiduChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateBaiduChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINBaiduChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet"> <summary> Updates the configuration and other settings for a campaign. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.ADMMessage_Action"> <summary> <para> <para>The action to occur if a recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.APNSMessage_Action"> <summary> <para> <para>The action to occur if a recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.BaiduMessage_Action"> <summary> <para> <para>The action to occur if a recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.DefaultMessage_Action"> <summary> <para> <para>The action to occur if a recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.GCMMessage_Action"> <summary> <para> <para>The action to occur if a recipient taps the push notification. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.WriteCampaignRequest_AdditionalTreatment"> <summary> <para> <para>An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Dimensions_Attribute"> <summary> <para> <para>One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.ADMMessage_Body"> <summary> <para> <para>The body of the notification message. The maximum number of characters is 200.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.APNSMessage_Body"> <summary> <para> <para>The body of the notification message. The maximum number of characters is 200.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.BaiduMessage_Body"> <summary> <para> <para>The body of the notification message. The maximum number of characters is 200.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.DefaultMessage_Body"> <summary> <para> <para>The body of the notification message. The maximum number of characters is 200.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.EmailMessage_Body"> <summary> <para> <para>The body of the email for recipients whose email clients don't render HTML content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.GCMMessage_Body"> <summary> <para> <para>The body of the notification message. The maximum number of characters is 200.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.InAppMessage_Body"> <summary> <para> <para>The message body of the notification, the email body or the text message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.SMSMessage_Body"> <summary> <para> <para>The body of the SMS message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.CampaignId"> <summary> <para> <para>The unique identifier for the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.InAppMessage_Content"> <summary> <para> <para>In-app message content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.InAppMessage_CustomConfig"> <summary> <para> <para>Custom config to be sent to client.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Limits_Daily"> <summary> <para> <para>The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.CustomMessage_Data"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.CustomDeliveryConfiguration_DeliveryUri"> <summary> <para> <para>The destination to send the campaign or treatment to. This value can be one of the following:</para><ul><li><para>The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.</para></li><li><para>The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.WriteCampaignRequest_Description"> <summary> <para> <para>A custom description of the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.EventType_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.QuietTime_End"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.CustomDeliveryConfiguration_EndpointType"> <summary> <para> <para>The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Schedule_EndTime"> <summary> <para> <para>The scheduled time, in ISO 8601 format, when the campaign ended or will end.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.SMSMessage_EntityId"> <summary> <para> <para>The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.EventFilter_FilterType"> <summary> <para> <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 (<link linkend="apps-application-id-events">Events</link> resource) occurs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Schedule_Frequency"> <summary> <para> <para>Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.EmailMessage_FromAddress"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.EmailMessage_Header"> <summary> <para> <para>The list of <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-campaigns-campaign-id.html#apps-application-id-campaigns-campaign-id-model-messageheader">MessageHeaders</a> for the email. You can have up to 15 MessageHeaders for each email.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.WriteCampaignRequest_HoldoutPercent"> <summary> <para> <para>The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.EmailMessage_HtmlBody"> <summary> <para> <para>The body of the email, in HTML format, for recipients whose email clients render HTML content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.ADMMessage_ImageIconUrl"> <summary> <para> <para>The URL of the image to display as the push-notification icon, such as the icon for the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.APNSMessage_ImageIconUrl"> <summary> <para> <para>The URL of the image to display as the push-notification icon, such as the icon for the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.BaiduMessage_ImageIconUrl"> <summary> <para> <para>The URL of the image to display as the push-notification icon, such as the icon for the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.DefaultMessage_ImageIconUrl"> <summary> <para> <para>The URL of the image to display as the push-notification icon, such as the icon for the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.GCMMessage_ImageIconUrl"> <summary> <para> <para>The URL of the image to display as the push-notification icon, such as the icon for the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.ADMMessage_ImageSmallIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.APNSMessage_ImageSmallIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.BaiduMessage_ImageSmallIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.DefaultMessage_ImageSmallIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.GCMMessage_ImageSmallIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.ADMMessage_ImageUrl"> <summary> <para> <para>The URL of an image to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.APNSMessage_ImageUrl"> <summary> <para> <para>The URL of an image to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.BaiduMessage_ImageUrl"> <summary> <para> <para>The URL of an image to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.DefaultMessage_ImageUrl"> <summary> <para> <para>The URL of an image to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.GCMMessage_ImageUrl"> <summary> <para> <para>The URL of an image to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Schedule_IsLocalTime"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.WriteCampaignRequest_IsPaused"> <summary> <para> <para>Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.ADMMessage_JsonBody"> <summary> <para> <para>The JSON payload to use for a silent push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.APNSMessage_JsonBody"> <summary> <para> <para>The JSON payload to use for a silent push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.BaiduMessage_JsonBody"> <summary> <para> <para>The JSON payload to use for a silent push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.DefaultMessage_JsonBody"> <summary> <para> <para>The JSON payload to use for a silent push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.GCMMessage_JsonBody"> <summary> <para> <para>The JSON payload to use for a silent push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Hook_LambdaFunctionName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.InAppMessage_Layout"> <summary> <para> <para>In-app message layout.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Limits_MaximumDuration"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.ADMMessage_MediaUrl"> <summary> <para> <para>The URL of the image or video to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.APNSMessage_MediaUrl"> <summary> <para> <para>The URL of the image or video to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.BaiduMessage_MediaUrl"> <summary> <para> <para>The URL of the image or video to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.DefaultMessage_MediaUrl"> <summary> <para> <para>The URL of the image or video to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.GCMMessage_MediaUrl"> <summary> <para> <para>The URL of the image or video to display in the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Limits_MessagesPerSecond"> <summary> <para> <para>The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.SMSMessage_MessageType"> <summary> <para> <para>The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Dimensions_Metric"> <summary> <para> <para>One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Hook_Mode"> <summary> <para> <para>The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:</para><ul><li><para>FILTER - Invoke the function to customize the segment that's used by a campaign.</para></li><li><para>DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.WriteCampaignRequest_Name"> <summary> <para> <para>A custom name for the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.EmailTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.InAppTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.PushTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.SMSTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.VoiceTemplate_Name"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.SMSMessage_OriginationNumber"> <summary> <para> <para>The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.WriteCampaignRequest_Priority"> <summary> <para> <para>Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.ADMMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.APNSMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.BaiduMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.DefaultMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.GCMMessage_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.WriteCampaignRequest_SegmentId"> <summary> <para> <para>The unique identifier for the segment to associate with the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.WriteCampaignRequest_SegmentVersion"> <summary> <para> <para>The version of the segment to associate with the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.SMSMessage_SenderId"> <summary> <para> <para>The sender ID to display on recipients' devices when they receive the SMS message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Limits_Session"> <summary> <para> <para>The maximum total number of messages that the campaign can send per user session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.ADMMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.APNSMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.BaiduMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.DefaultMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.GCMMessage_SilentPush"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.QuietTime_Start"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Schedule_StartTime"> <summary> <para> <para>The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.WriteCampaignRequest_Tag"> <summary> <para> <note><para>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</para></note><para>(Deprecated) 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.SMSMessage_TemplateId"> <summary> <para> <para>The template ID received from the regulatory body for sending SMS in your country.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.ADMMessage_TimeToLive"> <summary> <para> <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.</para><para>This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.APNSMessage_TimeToLive"> <summary> <para> <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.</para><para>This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.BaiduMessage_TimeToLive"> <summary> <para> <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.</para><para>This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.DefaultMessage_TimeToLive"> <summary> <para> <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.</para><para>This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.GCMMessage_TimeToLive"> <summary> <para> <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.</para><para>This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Schedule_Timezone"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.ADMMessage_Title"> <summary> <para> <para>The title to display above the notification message on a recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.APNSMessage_Title"> <summary> <para> <para>The title to display above the notification message on a recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.BaiduMessage_Title"> <summary> <para> <para>The title to display above the notification message on a recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.DefaultMessage_Title"> <summary> <para> <para>The title to display above the notification message on a recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.EmailMessage_Title"> <summary> <para> <para>The subject line, or title, of the email.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.GCMMessage_Title"> <summary> <para> <para>The title to display above the notification message on a recipient's device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Limits_Total"> <summary> <para> <para>The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.WriteCampaignRequest_TreatmentDescription"> <summary> <para> <para>A custom description of the default treatment for the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.WriteCampaignRequest_TreatmentName"> <summary> <para> <para>A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A <i>treatment</i> is a variation of a campaign that's used for A/B testing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.ADMMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.APNSMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.BaiduMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.DefaultMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.GCMMessage_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.EventType_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.EmailTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.InAppTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.PushTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.SMSTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.VoiceTemplate_Version"> <summary> <para> <para>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Hook_WebUrl"> <summary> <para> <para>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CampaignResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateCampaignResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateCampaignResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINCampaignCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailChannelCmdlet"> <summary> Enables the email channel for an application or updates the status and settings of the email channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailChannelCmdlet.EmailChannelRequest_ConfigurationSet"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html">Amazon SES configuration set</a> that you want to apply to messages that you send through the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailChannelCmdlet.EmailChannelRequest_Enabled"> <summary> <para> <para>Specifies whether to enable the email channel for the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailChannelCmdlet.EmailChannelRequest_FromAddress"> <summary> <para> <para>The verified email address that you want to send email from when you send email through the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailChannelCmdlet.EmailChannelRequest_Identity"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailChannelCmdlet.EmailChannelRequest_OrchestrationSendingRoleArn"> <summary> <para> <para>The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailChannelCmdlet.EmailChannelRequest_RoleArn"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EmailChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateEmailChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateEmailChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailTemplateCmdlet"> <summary> Updates an existing message template for messages that are sent through the email channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailTemplateCmdlet.CreateNewVersion"> <summary> <para> <para>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailTemplateCmdlet.EmailTemplateRequest_DefaultSubstitution"> <summary> <para> <para>A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailTemplateCmdlet.EmailTemplateRequest_Header"> <summary> <para> <para>The list of <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/templates-template-name-email.html#templates-template-name-email-model-messageheader">MessageHeaders</a> for the email. You can have up to 15 Headers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailTemplateCmdlet.EmailTemplateRequest_HtmlPart"> <summary> <para> <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 render HTML content. You can include links, formatted text, and more in an HTML message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailTemplateCmdlet.EmailTemplateRequest_RecommenderId"> <summary> <para> <para>The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailTemplateCmdlet.EmailTemplateRequest_Subject"> <summary> <para> <para>The subject line, or title, to use in email messages that are based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailTemplateCmdlet.EmailTemplateRequest_Tag"> <summary> <para> <note><para>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</para></note><para>(Deprecated) 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailTemplateCmdlet.EmailTemplateRequest_TemplateDescription"> <summary> <para> <para>A custom description of the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailTemplateCmdlet.EmailTemplateRequest_TextPart"> <summary> <para> <para>The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailTemplateCmdlet.Version"> <summary> <para> <para>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</para><ul><li><para>For a get operation, retrieves information about the active version of the template.</para></li><li><para>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</para></li><li><para>For a delete operation, deletes the template, including all versions of the template.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateEmailTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateEmailTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEmailTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet"> <summary> 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 for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.EndpointRequest_Address"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.Demographic_AppVersion"> <summary> <para> <para>The version of the app that's associated with the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.EndpointRequest_Attribute"> <summary> <para> <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. Attribute names are case sensitive.</para><para>An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. 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 restriction doesn't apply to attribute values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.EndpointRequest_ChannelType"> <summary> <para> <para>The channel to use when sending messages or push notifications to the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.Location_City"> <summary> <para> <para>The name of the city where the endpoint is located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.Location_Country"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.EndpointRequest_EffectiveDate"> <summary> <para> <para>The date and time, in ISO 8601 format, when the endpoint is updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.EndpointId"> <summary> <para> <para>The case insensitive unique identifier for the endpoint. The identifier can't contain <c>$</c>, <c>{</c> or <c>}</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.EndpointRequest_EndpointStatus"> <summary> <para> <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.</para><para>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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.Location_Latitude"> <summary> <para> <para>The latitude coordinate of the endpoint location, rounded to one decimal place.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.Demographic_Locale"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.Location_Longitude"> <summary> <para> <para>The longitude coordinate of the endpoint location, rounded to one decimal place.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.Demographic_Make"> <summary> <para> <para>The manufacturer of the endpoint device, such as apple or samsung.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.EndpointRequest_Metric"> <summary> <para> <para>One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.Demographic_Model"> <summary> <para> <para>The model name or number of the endpoint device, such as iPhone or SM-G900F.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.Demographic_ModelVersion"> <summary> <para> <para>The model version of the endpoint device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.EndpointRequest_OptOut"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.Demographic_Platform"> <summary> <para> <para>The platform of the endpoint device, such as ios.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.Demographic_PlatformVersion"> <summary> <para> <para>The platform version of the endpoint device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.Location_PostalCode"> <summary> <para> <para>The postal or ZIP code for the area where the endpoint is located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.Location_Region"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.EndpointRequest_RequestId"> <summary> <para> <para>The unique identifier for the most recent request to update the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.Demographic_Timezone"> <summary> <para> <para>The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.User_UserAttribute"> <summary> <para> <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. Attribute names are case sensitive.</para><para>An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. 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 restriction doesn't apply to attribute values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.User_UserId"> <summary> <para> <para>The unique identifier for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateEndpointResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointsBatchCmdlet"> <summary> 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 for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointsBatchCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointsBatchCmdlet.EndpointBatchRequest_Item"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointsBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateEndpointsBatchResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateEndpointsBatchResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINEndpointsBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINGcmChannelCmdlet"> <summary> Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINGcmChannelCmdlet.GCMChannelRequest_ApiKey"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINGcmChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINGcmChannelCmdlet.GCMChannelRequest_DefaultAuthenticationMethod"> <summary> <para> <para>The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINGcmChannelCmdlet.GCMChannelRequest_Enabled"> <summary> <para> <para>Specifies whether to enable the GCM channel for the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINGcmChannelCmdlet.GCMChannelRequest_ServiceJson"> <summary> <para> <para>The contents of the JSON file provided by Google during registration in order to generate an access token for authentication. For more information see <a href="https://firebase.google.com/docs/cloud-messaging/migrate-v1">Migrate from legacy FCM APIs to HTTP v1</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINGcmChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GCMChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateGcmChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateGcmChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINGcmChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINInAppTemplateCmdlet"> <summary> Updates an existing message template for messages sent through the in-app message channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINInAppTemplateCmdlet.InAppTemplateRequest_Content"> <summary> <para> <para>The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINInAppTemplateCmdlet.CreateNewVersion"> <summary> <para> <para>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINInAppTemplateCmdlet.InAppTemplateRequest_CustomConfig"> <summary> <para> <para>Custom config to be sent to client.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINInAppTemplateCmdlet.InAppTemplateRequest_Layout"> <summary> <para> <para>The layout of the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINInAppTemplateCmdlet.InAppTemplateRequest_Tag"> <summary> <para> <note><para>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</para></note><para>(Deprecated) 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINInAppTemplateCmdlet.InAppTemplateRequest_TemplateDescription"> <summary> <para> <para>The description of the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINInAppTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINInAppTemplateCmdlet.Version"> <summary> <para> <para>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</para><ul><li><para>For a get operation, retrieves information about the active version of the template.</para></li><li><para>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</para></li><li><para>For a delete operation, deletes the template, including all versions of the template.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINInAppTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateInAppTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateInAppTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINInAppTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet"> <summary> Updates the configuration and other settings for a journey. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.WriteJourneyRequest_Activity"> <summary> <para> <para>A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.Dimensions_Attribute"> <summary> <para> <para>One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.TimeframeCap_Cap"> <summary> <para> <para>The maximum number of messages that all journeys can send to an endpoint during the specified timeframe. The maximum value is 100. If set to 0, this limit will not apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.JourneyChannelSettings_ConnectCampaignArn"> <summary> <para> <para>Amazon Resource Name (ARN) of the Connect Campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.JourneyChannelSettings_ConnectCampaignExecutionRoleArn"> <summary> <para> <para>IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.WriteJourneyRequest_CreationDate"> <summary> <para> <para>The date, in ISO 8601 format, when the journey was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.ClosedDays_CUSTOM"> <summary> <para> <para>Rules for the Custom channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.OpenHours_CUSTOM"> <summary> <para> <para>Specifies the schedule settings for the custom channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.Limits_DailyCap"> <summary> <para> <para>The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.TimeframeCap_Day"> <summary> <para> <para>The length of the timeframe in days. The maximum value is 30. If set to 0, this limit will not apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.StartCondition_Description"> <summary> <para> <para>The custom description of the condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.EventType_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.ClosedDays_EMAIL"> <summary> <para> <para>Rules for the Email channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.OpenHours_EMAIL"> <summary> <para> <para>Specifies the schedule settings for the email channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.QuietTime_End"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.Limits_EndpointReentryCap"> <summary> <para> <para>The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.Limits_EndpointReentryInterval"> <summary> <para> <para>Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.Schedule_EndTime"> <summary> <para> <para>The scheduled time, in ISO 8601 format, when the journey ended or will end.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.EventFilter_FilterType"> <summary> <para> <para>The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (<link linkend="apps-application-id-events">Events resource</link>) occurs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.JourneyId"> <summary> <para> <para>The unique identifier for the journey.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.WriteJourneyRequest_LastModifiedDate"> <summary> <para> <para>The date, in ISO 8601 format, when the journey was last modified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.WriteJourneyRequest_LocalTime"> <summary> <para> <para>Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.Limits_MessagesPerSecond"> <summary> <para> <para>The maximum number of messages that the journey can send each second.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.Dimensions_Metric"> <summary> <para> <para>One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.WriteJourneyRequest_Name"> <summary> <para> <para>The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.ClosedDays_PUSH"> <summary> <para> <para>Rules for the Push channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.OpenHours_PUSH"> <summary> <para> <para>Specifies the schedule settings for the push channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.WriteJourneyRequest_RefreshFrequency"> <summary> <para> <para>The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.WriteJourneyRequest_RefreshOnSegmentUpdate"> <summary> <para> <para>Indicates whether the journey participants should be refreshed when a segment is updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.EventStartCondition_SegmentId"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.SegmentStartCondition_SegmentId"> <summary> <para> <para>The unique identifier for the segment to associate with the activity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.WriteJourneyRequest_SendingSchedule"> <summary> <para> <para>Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.ClosedDays_SMS"> <summary> <para> <para>Rules for the SMS channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.OpenHours_SMS"> <summary> <para> <para>Specifies the schedule settings for the SMS channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.QuietTime_Start"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.WriteJourneyRequest_StartActivity"> <summary> <para> <para>The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.Schedule_StartTime"> <summary> <para> <para>The scheduled time, in ISO 8601 format, when the journey began or will begin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.WriteJourneyRequest_State"> <summary> <para> <para>The status of the journey. Valid values are:</para><ul><li><para>DRAFT - Saves the journey and doesn't publish it.</para></li><li><para>ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.</para></li></ul><para>PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the <link linkend="apps-application-id-journeys-journey-id-state">Journey State</link> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.Schedule_Timezone"> <summary> <para> <para>The starting UTC offset for the journey schedule, if the value of the journey's LocalTime 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+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.WriteJourneyRequest_TimezoneEstimationMethod"> <summary> <para> <para>An array of time zone estimation methods, if any, to use for determining an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-endpoints-endpoint-id.html">Endpoints</a> time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.</para><ul><li><para>PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.</para></li><li><para>POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.</para><note><para>POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.</para></note></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.Limits_TotalCap"> <summary> <para> <para>The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.EventType_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.ClosedDays_VOICE"> <summary> <para> <para>Rules for the Voice channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.OpenHours_VOICE"> <summary> <para> <para>Specifies the schedule settings for the voice channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.WriteJourneyRequest_WaitForQuietTime"> <summary> <para> <para>Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JourneyResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateJourneyResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateJourneyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyStateCmdlet"> <summary> Cancels (stops) an active journey. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyStateCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyStateCmdlet.JourneyId"> <summary> <para> <para>The unique identifier for the journey.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyStateCmdlet.JourneyStateRequest_State"> <summary> <para> <para>The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED</para><para>If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.</para><para>After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.</para><para>When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyStateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JourneyResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateJourneyStateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateJourneyStateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINJourneyStateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet"> <summary> Updates an existing message template for messages that are sent through a push notification channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.ADM_Action"> <summary> <para> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.APNS_Action"> <summary> <para> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Baidu_Action"> <summary> <para> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Default_Action"> <summary> <para> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.GCM_Action"> <summary> <para> <para>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:</para><ul><li><para>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</para></li><li><para>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.</para></li><li><para>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.ADM_Body"> <summary> <para> <para>The message body to use in a push notification that's based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.APNS_Body"> <summary> <para> <para>The message body to use in push notifications that are based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Baidu_Body"> <summary> <para> <para>The message body to use in a push notification that's based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Default_Body"> <summary> <para> <para>The message body to use in push notifications that are based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.GCM_Body"> <summary> <para> <para>The message body to use in a push notification that's based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.CreateNewVersion"> <summary> <para> <para>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.PushNotificationTemplateRequest_DefaultSubstitution"> <summary> <para> <para>A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.ADM_ImageIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Baidu_ImageIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.GCM_ImageIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.ADM_ImageUrl"> <summary> <para> <para>The URL of an image to display in a push notification that's based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Baidu_ImageUrl"> <summary> <para> <para>The URL of an image to display in a push notification that's based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.GCM_ImageUrl"> <summary> <para> <para>The URL of an image to display in a push notification that's based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.APNS_MediaUrl"> <summary> <para> <para>The URL of an image or video to display in push notifications that are based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.ADM_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.APNS_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Baidu_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.GCM_RawContent"> <summary> <para> <para>The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.PushNotificationTemplateRequest_RecommenderId"> <summary> <para> <para>The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.ADM_SmallImageIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Baidu_SmallImageIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.GCM_SmallImageIconUrl"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.ADM_Sound"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.APNS_Sound"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Baidu_Sound"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Default_Sound"> <summary> <para> <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><para>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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.GCM_Sound"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.PushNotificationTemplateRequest_Tag"> <summary> <para> <note><para>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</para></note><para>(Deprecated) 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.PushNotificationTemplateRequest_TemplateDescription"> <summary> <para> <para>A custom description of the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.ADM_Title"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.APNS_Title"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Baidu_Title"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Default_Title"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.GCM_Title"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.ADM_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.APNS_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Baidu_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Default_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.GCM_Url"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Version"> <summary> <para> <para>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</para><ul><li><para>For a get operation, retrieves information about the active version of the template.</para></li><li><para>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</para></li><li><para>For a delete operation, deletes the template, including all versions of the template.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdatePushTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdatePushTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINPushTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINRecommenderConfigurationCmdlet"> <summary> Updates an Amazon Pinpoint configuration for a recommender model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINRecommenderConfigurationCmdlet.UpdateRecommenderConfiguration_Attribute"> <summary> <para> <para>A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.</para><para>In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the <b>Attribute finder</b> of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:</para><ul><li><para>An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.</para></li><li><para>An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</para></li></ul><para>This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINRecommenderConfigurationCmdlet.UpdateRecommenderConfiguration_Description"> <summary> <para> <para>A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINRecommenderConfigurationCmdlet.UpdateRecommenderConfiguration_Name"> <summary> <para> <para>A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINRecommenderConfigurationCmdlet.UpdateRecommenderConfiguration_RecommendationProviderIdType"> <summary> <para> <para>The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:</para><ul><li><para>PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.</para></li><li><para>PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINRecommenderConfigurationCmdlet.UpdateRecommenderConfiguration_RecommendationProviderRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINRecommenderConfigurationCmdlet.UpdateRecommenderConfiguration_RecommendationProviderUri"> <summary> <para> <para>The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINRecommenderConfigurationCmdlet.UpdateRecommenderConfiguration_RecommendationsDisplayName"> <summary> <para> <para>A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.</para><para>This name appears in the <b>Attribute finder</b> of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINRecommenderConfigurationCmdlet.UpdateRecommenderConfiguration_RecommendationsPerMessage"> <summary> <para> <para>The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.</para><para>To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINRecommenderConfigurationCmdlet.UpdateRecommenderConfiguration_RecommendationTransformerUri"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINRecommenderConfigurationCmdlet.RecommenderId"> <summary> <para> <para>The unique identifier for the recommender model configuration. This identifier is displayed as the <b>Recommender ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINRecommenderConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RecommenderConfigurationResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateRecommenderConfigurationResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateRecommenderConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINRecommenderConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Dimensions_Attribute"> <summary> <para> <para>One or more custom attributes to use as criteria for the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.AppVersion_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Channel_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.DeviceType_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Make_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Model_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Platform_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Country_DimensionType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Recency_Duration"> <summary> <para> <para>The duration to use when determining whether an endpoint is active or inactive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.SegmentGroups_Group"> <summary> <para> <para>An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.SegmentGroups_Include"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Coordinates_Latitude"> <summary> <para> <para>The latitude coordinate of the location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Coordinates_Longitude"> <summary> <para> <para>The longitude coordinate of the location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Dimensions_Metric"> <summary> <para> <para>One or more custom metrics to use as criteria for the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.WriteSegmentRequest_Name"> <summary> <para> <para>The name of the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.GPSPoint_RangeInKilometer"> <summary> <para> <para>The range, in kilometers, from the GPS coordinates.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Recency_RecencyType"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.SegmentId"> <summary> <para> <para>The unique identifier for the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.WriteSegmentRequest_Tag"> <summary> <para> <note><para>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</para></note><para>(Deprecated) 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Dimensions_UserAttribute"> <summary> <para> <para>One or more custom user attributes to use as criteria for the segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.AppVersion_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Channel_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.DeviceType_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Make_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Model_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Platform_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Country_Value"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SegmentResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateSegmentResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateSegmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSegmentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsChannelCmdlet"> <summary> Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsChannelCmdlet.SMSChannelRequest_Enabled"> <summary> <para> <para>Specifies whether to enable the SMS channel for the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsChannelCmdlet.SMSChannelRequest_SenderId"> <summary> <para> <para>The identity that you want to display on recipients' devices when they receive messages from the SMS channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsChannelCmdlet.SMSChannelRequest_ShortCode"> <summary> <para> <para>The registered short code that you want to use when you send messages through the SMS channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SMSChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateSmsChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateSmsChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsTemplateCmdlet"> <summary> Updates an existing message template for messages that are sent through the SMS channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsTemplateCmdlet.SMSTemplateRequest_Body"> <summary> <para> <para>The message body to use in text messages that are based on the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsTemplateCmdlet.CreateNewVersion"> <summary> <para> <para>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsTemplateCmdlet.SMSTemplateRequest_DefaultSubstitution"> <summary> <para> <para>A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsTemplateCmdlet.SMSTemplateRequest_RecommenderId"> <summary> <para> <para>The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsTemplateCmdlet.SMSTemplateRequest_Tag"> <summary> <para> <note><para>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</para></note><para>(Deprecated) 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsTemplateCmdlet.SMSTemplateRequest_TemplateDescription"> <summary> <para> <para>A custom description of the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsTemplateCmdlet.Version"> <summary> <para> <para>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</para><ul><li><para>For a get operation, retrieves information about the active version of the template.</para></li><li><para>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</para></li><li><para>For a delete operation, deletes the template, including all versions of the template.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateSmsTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateSmsTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINSmsTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINTemplateActiveVersionCmdlet"> <summary> Changes the status of a specific version of a message template to <i>active</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINTemplateActiveVersionCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINTemplateActiveVersionCmdlet.TemplateType"> <summary> <para> <para>The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINTemplateActiveVersionCmdlet.TemplateActiveVersionRequest_Version"> <summary> <para> <para>The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINTemplateActiveVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateTemplateActiveVersionResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateTemplateActiveVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINTemplateActiveVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceChannelCmdlet"> <summary> Enables the voice channel for an application or updates the status and settings of the voice channel for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceChannelCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceChannelCmdlet.VoiceChannelRequest_Enabled"> <summary> <para> <para>Specifies whether to enable the voice channel for the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VoiceChannelResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateVoiceChannelResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateVoiceChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceTemplateCmdlet"> <summary> Updates an existing message template for messages that are sent through the voice channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceTemplateCmdlet.VoiceTemplateRequest_Body"> <summary> <para> <para>The text of the script to use in messages that are based on the message template, in plain text format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceTemplateCmdlet.CreateNewVersion"> <summary> <para> <para>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceTemplateCmdlet.VoiceTemplateRequest_DefaultSubstitution"> <summary> <para> <para>A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceTemplateCmdlet.VoiceTemplateRequest_LanguageCode"> <summary> <para> <para>The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceTemplateCmdlet.VoiceTemplateRequest_Tag"> <summary> <para> <note><para>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</para></note><para>(Deprecated) 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceTemplateCmdlet.VoiceTemplateRequest_TemplateDescription"> <summary> <para> <para>A custom description of the message template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceTemplateCmdlet.TemplateName"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceTemplateCmdlet.Version"> <summary> <para> <para>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</para><para>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</para><para>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</para><ul><li><para>For a get operation, retrieves information about the active version of the template.</para></li><li><para>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</para></li><li><para>For a delete operation, deletes the template, including all versions of the template.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceTemplateCmdlet.VoiceTemplateRequest_VoiceId"> <summary> <para> <para>The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateVoiceTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateVoiceTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.UpdatePINVoiceTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.WritePINEventCmdlet"> <summary> Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.WritePINEventCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.WritePINEventCmdlet.EventsRequest_BatchItem"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.WritePINEventCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventsResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.PutEventsResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.PutEventsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.WritePINEventCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIN.WritePINEventStreamCmdlet"> <summary> Creates a new event stream for an application or updates the settings of an existing event stream for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.WritePINEventStreamCmdlet.ApplicationId"> <summary> <para> <para>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.WritePINEventStreamCmdlet.WriteEventStream_DestinationStreamArn"> <summary> <para> <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.</para><para>For a Kinesis data stream, the ARN format is: arn:aws:kinesis:<replaceable>region</replaceable>:<replaceable>account-id</replaceable>:stream/<replaceable>stream_name</replaceable></para><para>For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:<replaceable>region</replaceable>:<replaceable>account-id</replaceable>:deliverystream/<replaceable>stream_name</replaceable></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.WritePINEventStreamCmdlet.WriteEventStream_RoleArn"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.WritePINEventStreamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventStream'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.PutEventStreamResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.PutEventStreamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIN.WritePINEventStreamCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |