AWS.Tools.PersonalizeEvents.dll-Help.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
<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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" 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="False" position="Named">
          <name>PassThru</name>
          <description>
            <para>Returns the value passed to the SessionId parameter. By default, this cmdlet does not generate any output. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>Force</name>
          <description>
            <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>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="False" position="Named">
        <name>Force</name>
        <description>
          <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>PassThru</name>
        <description>
          <para>Returns the value passed to the SessionId parameter. By default, this cmdlet does not generate any output. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1">
        <name>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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" 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 System.String</name>
          <uri />
          <description />
        </type>
        <description>
          <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the SessionId parameter. Otherwise, this cmdlet does not return 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>