AWS.Tools.PersonalizeEvents

4.0.1.1

AWS.Tools.PersonalizeEvents.dll-Help.xml

                                <helpItems schema="maml">

  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

    <details>

      <name>Write-PERSEEvent</name>

      <description>

        <para>Calls the Amazon Personalize Events PutEvents API operation.</para>

      </description>

      <verb>Write</verb>

      <noun>PERSEEvent</noun>

      <copyright>

        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>

      </copyright>

    </details>

    <description>

      <para>Records user interaction event data. </para>

    </description>

    <syntax>

      <syntaxItem>

        <name>Write-PERSEEvent</name>

        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">

          <name>SessionId</name>

          <description>

            <para>The session ID associated with the user's visit. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>EventList</name>

          <description>

            <para>A list of event data from the session. </para>

          </description>

          <parameterValue required="true" variableLength="false">Amazon.PersonalizeEvents.Model.Event[]</parameterValue>

        </parameter>

        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>TrackingId</name>

          <description>

            <para>The tracking ID for the event. The ID is generated by a call to the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a> API. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>UserId</name>

          <description>

            <para>The user associated with the event. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>Select</name>

          <description>

            <para>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.PersonalizeEvents.Model.PutEventsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>PassThru</name>

          <description>

            <para>Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>Force</name>

          <description>

            <para>This parameter overrides confirmation prompts to force  the cmdlet to continue its operation. This parameter should always be used with caution. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>

        </parameter>

      </syntaxItem>

    </syntax>

    <parameters>

      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>EventList</name>

        <description>

          <para>A list of event data from the session. </para>

        </description>

        <parameterValue required="true" variableLength="false">Amazon.PersonalizeEvents.Model.Event[]</parameterValue>

        <type>

          <name>Amazon.PersonalizeEvents.Model.Event[]</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>Force</name>

        <description>

          <para>This parameter overrides confirmation prompts to force  the cmdlet to continue its operation. This parameter should always be used with caution. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>

        <type>

          <name>System.Management.Automation.SwitchParameter</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>PassThru</name>

        <description>

          <para>Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>

        <type>

          <name>System.Management.Automation.SwitchParameter</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>Select</name>

        <description>

          <para>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.PersonalizeEvents.Model.PutEventsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">

        <name>SessionId</name>

        <description>

          <para>The session ID associated with the user's visit. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>TrackingId</name>

        <description>

          <para>The tracking ID for the event. The ID is generated by a call to the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a> API. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>UserId</name>

        <description>

          <para>The user associated with the event. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

    </parameters>

    <returnValues>

      <returnValue>

        <type>

          <name>None or Amazon.PersonalizeEvents.Model.PutEventsResponse</name>

          <uri />

          <description />

        </type>

        <description>

          <para>This cmdlet does not generate any output.The service response (type Amazon.PersonalizeEvents.Model.PutEventsResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>

        </description>

      </returnValue>

    </returnValues>

    <relatedLinks>

      <navigationLink>

        <linkText>Online version:</linkText>

        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Write-PERSEEvent.html&amp;tocid=Write-PERSEEvent</uri>

      </navigationLink>

      <navigationLink>

        <linkText>Common credential and region parameters: </linkText>

        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>

      </navigationLink>

    </relatedLinks>

  </command>

</helpItems>