AWS.Tools.IoTEventsData.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.IoTEventsData</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDAlarmCmdlet"> <summary> Retrieves information about an alarm. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDAlarmCmdlet.AlarmModelName"> <summary> <para> <para>The name of the alarm model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDAlarmCmdlet.KeyValue"> <summary> <para> <para>The value of the key used as a filter to select only the alarms associated with the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key">key</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDAlarmCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Alarm'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTEventsData.Model.DescribeAlarmResponse). Specifying the name of a property of type Amazon.IoTEventsData.Model.DescribeAlarmResponse 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.IOTED.GetIOTEDAlarmCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AlarmModelName parameter. The -PassThru parameter is deprecated, use -Select '^AlarmModelName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDAlarmListCmdlet"> <summary> Lists one or more alarms. The operation returns only the metadata associated with each alarm.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDAlarmListCmdlet.AlarmModelName"> <summary> <para> <para>The name of the alarm model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDAlarmListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDAlarmListCmdlet.NextToken"> <summary> <para> <para>The token that you can use to return the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDAlarmListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AlarmSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTEventsData.Model.ListAlarmsResponse). Specifying the name of a property of type Amazon.IoTEventsData.Model.ListAlarmsResponse 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.IOTED.GetIOTEDAlarmListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AlarmModelName parameter. The -PassThru parameter is deprecated, use -Select '^AlarmModelName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDAlarmListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDDetectorCmdlet"> <summary> Returns information about the specified detector (instance). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDDetectorCmdlet.DetectorModelName"> <summary> <para> <para>The name of the detector model whose detectors (instances) you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDDetectorCmdlet.KeyValue"> <summary> <para> <para>A filter used to limit results to detectors (instances) created because of the given key ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDDetectorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Detector'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTEventsData.Model.DescribeDetectorResponse). Specifying the name of a property of type Amazon.IoTEventsData.Model.DescribeDetectorResponse 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.IOTED.GetIOTEDDetectorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DetectorModelName parameter. The -PassThru parameter is deprecated, use -Select '^DetectorModelName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDDetectorListCmdlet"> <summary> Lists detectors (the instances of a detector model).<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDDetectorListCmdlet.DetectorModelName"> <summary> <para> <para>The name of the detector model whose detectors (instances) are listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDDetectorListCmdlet.StateName"> <summary> <para> <para>A filter that limits results to those detectors (instances) in the given state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDDetectorListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDDetectorListCmdlet.NextToken"> <summary> <para> <para>The token that you can use to return the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDDetectorListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DetectorSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTEventsData.Model.ListDetectorsResponse). Specifying the name of a property of type Amazon.IoTEventsData.Model.ListDetectorsResponse 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.IOTED.GetIOTEDDetectorListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DetectorModelName parameter. The -PassThru parameter is deprecated, use -Select '^DetectorModelName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.GetIOTEDDetectorListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTED.SendIOTEDAcknowledgeAlarmCmdlet"> <summary> Acknowledges one or more alarms. The alarms change to the <code>ACKNOWLEDGED</code> state after you acknowledge them. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.SendIOTEDAcknowledgeAlarmCmdlet.AcknowledgeActionRequest"> <summary> <para> <para>The list of acknowledge action requests. You can specify up to 10 requests per operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.SendIOTEDAcknowledgeAlarmCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ErrorEntries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTEventsData.Model.BatchAcknowledgeAlarmResponse). Specifying the name of a property of type Amazon.IoTEventsData.Model.BatchAcknowledgeAlarmResponse 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.IOTED.SendIOTEDAcknowledgeAlarmCmdlet.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.IOTED.SendIOTEDDisableAlarmCmdlet"> <summary> Disables one or more alarms. The alarms change to the <code>DISABLED</code> state after you disable them. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.SendIOTEDDisableAlarmCmdlet.DisableActionRequest"> <summary> <para> <para>The list of disable action requests. You can specify up to 10 requests per operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.SendIOTEDDisableAlarmCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ErrorEntries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTEventsData.Model.BatchDisableAlarmResponse). Specifying the name of a property of type Amazon.IoTEventsData.Model.BatchDisableAlarmResponse 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.IOTED.SendIOTEDDisableAlarmCmdlet.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.IOTED.SendIOTEDEnableAlarmCmdlet"> <summary> Enables one or more alarms. The alarms change to the <code>NORMAL</code> state after you enable them. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.SendIOTEDEnableAlarmCmdlet.EnableActionRequest"> <summary> <para> <para>The list of enable action requests. You can specify up to 10 requests per operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.SendIOTEDEnableAlarmCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ErrorEntries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTEventsData.Model.BatchEnableAlarmResponse). Specifying the name of a property of type Amazon.IoTEventsData.Model.BatchEnableAlarmResponse 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.IOTED.SendIOTEDEnableAlarmCmdlet.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.IOTED.SendIOTEDMessageBatchCmdlet"> <summary> Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify (<code>"inputName"</code>) and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.SendIOTEDMessageBatchCmdlet.Message"> <summary> <para> <para>The list of messages to send. Each message has the following format: <code>'{ "messageId": "string", "inputName": "string", "payload": "string"}'</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.SendIOTEDMessageBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BatchPutMessageErrorEntries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTEventsData.Model.BatchPutMessageResponse). Specifying the name of a property of type Amazon.IoTEventsData.Model.BatchPutMessageResponse 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.IOTED.SendIOTEDMessageBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Message parameter. The -PassThru parameter is deprecated, use -Select '^Message' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.SendIOTEDMessageBatchCmdlet.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.IOTED.SendIOTEDResetAlarmCmdlet"> <summary> Resets one or more alarms. The alarms return to the <code>NORMAL</code> state after you reset them. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.SendIOTEDResetAlarmCmdlet.ResetActionRequest"> <summary> <para> <para>The list of reset action requests. You can specify up to 10 requests per operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.SendIOTEDResetAlarmCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ErrorEntries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTEventsData.Model.BatchResetAlarmResponse). Specifying the name of a property of type Amazon.IoTEventsData.Model.BatchResetAlarmResponse 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.IOTED.SendIOTEDResetAlarmCmdlet.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.IOTED.SendIOTEDSnoozeAlarmCmdlet"> <summary> Changes one or more alarms to the snooze mode. The alarms change to the <code>SNOOZE_DISABLED</code> state after you set them to the snooze mode. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.SendIOTEDSnoozeAlarmCmdlet.SnoozeActionRequest"> <summary> <para> <para>The list of snooze action requests. You can specify up to 10 requests per operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.SendIOTEDSnoozeAlarmCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ErrorEntries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTEventsData.Model.BatchSnoozeAlarmResponse). Specifying the name of a property of type Amazon.IoTEventsData.Model.BatchSnoozeAlarmResponse 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.IOTED.SendIOTEDSnoozeAlarmCmdlet.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.IOTED.UpdateIOTEDDetectorBatchCmdlet"> <summary> Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.UpdateIOTEDDetectorBatchCmdlet.Detector"> <summary> <para> <para>The list of detectors (instances) to update, along with the values to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.UpdateIOTEDDetectorBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BatchUpdateDetectorErrorEntries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTEventsData.Model.BatchUpdateDetectorResponse). Specifying the name of a property of type Amazon.IoTEventsData.Model.BatchUpdateDetectorResponse 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.IOTED.UpdateIOTEDDetectorBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Detector parameter. The -PassThru parameter is deprecated, use -Select '^Detector' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTED.UpdateIOTEDDetectorBatchCmdlet.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> |